Unclear that you need to reanalyze between setting a property and getting it back

未关闭 适合新手
#8,689 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
python
领域
documentation

调研方向

从 docs/dev/concepts.md 和 docs/guide/index.md 开始,然后查看 issue #2295 中引用的示例,了解还有哪些地方令人困惑。阐明写入后、分析运行前读取属性时的行为,尤其是在 Python 脚本中,并说明何时调用 bv.update_analysis_and_wait() 或 current_function.reanalyze()。当读者能够理解读取为何可能返回旧值,以及如何获取更新后的值时,即为完成。

由索引模型根据 Issue 内容生成。

描述

Is this a general concept that needs to be documented or a specific API?
Large set of API properties/functions

What concept or API needs more documentation?
In many cases, if you set a property and then read it back, you get the old value; the new value only shows up after running analysis.

For example, if I run this as a single console command:

>>> print(current_function.type); current_function.type = 'int(void *)'; print(current_function.type)

I get the same type twice:

void(int32_t arg1, char** arg2) __noreturn
void(int32_t arg1, char** arg2) __noreturn

After running the command, the UI automatically reanalyzes, so if I then run:

>>> print(current_function.type)

I get the new one:

int32_t(void* arg1)

This is apparently by design, and it is documented, but the documentation is very vague.

docs/dev/concepts.md says:

This is a convenience the UI does for you just like if you were to change a type or create a function, you almost always want the analysis to be updated. However, in scripts you run yourself as plugins or via the "Run Script" command, you may not get the same results mid-execution until after the entire script is finished running.

This says you "want the analysis to be updated" and "may not get the same results", but it doesn't say how the results differ. I would have expected that updating the analysis would be necessary for the change to propagate to other parts of the binary, perhaps necessary for it to appear in the decompilation; I wouldn't have expected it to be necessary merely to read the thing I just wrote.

Likewise, docs/guide/index.md says:

When you run commands in the scripting console, the UI will automatically update analysis. This is because quite often when you make a change in the console you expect it to be immediately reflected in the UI. The same is not true when running a script where you must trigger bv.update_analysis_and_wait() or current_function.reanalyze() to experience the same behavior.

This makes it sound like skipping reanalysis only prevents changes from appearing "in the UI".

I don't know if there is other documentation I'm missing, but if not, this should be clarified.

Is this documentation related to a specific API?
Affects all, but especially Python where these properties are getters and setters (affecting user expectations).

Are there any known examples of people using this API/concept?
#2295 is an example of someone getting confused by this.

主要语言
C++
星标
1.3k
派生
304
平均合并
2 天 20 小时
30 天内合并 PR
10

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Vector35/binaryninja-api 的其他 Issue

查看 Vector35/binaryninja-api 的全部 Issue

相似的 Issue

更多 C++ Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。