Skip to content

Commit 9ef0aaf

Browse files
committed
Fix errors in the documentation.
1 parent b723010 commit 9ef0aaf

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

doc/img/bytehook_intro.png

754 Bytes
Loading

doc/quickstart.zh-CN.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ arm-linux-androideabi-readelf -rW ./libsample.so
200200
aarch64-linux-android-readelf -rW ./libsample.so
201201
```
202202
203-
### 编写 hook 函数(代理函数)
203+
### 编写 proxy 函数(代理函数)
204204
205205
举例,上面例子中的 `my_strlen()` 函数,对 `strlen()` 的调用将被 hook 到 `my_strlen()`:
206206
@@ -225,12 +225,12 @@ size_t my_strlen(const char* const str)
225225
}
226226
```
227227

228-
*hook 函数中可以不调用原函数,也可以通过 `BYTEHOOK_CALL_PREV` 宏来调用原函数,但请不要通过函数名来直接调用原函数。
229-
* `BYTEHOOK_CALL_PREV` 宏在 C++ 源文件中的用法是:第一个参数传递当前的 hook 函数名(上例中为 `my_strlen()`),后面按照顺序依次传递函数的各个参数。(`BYTEHOOK_CALL_PREV` 宏在 C 源文件中的用法稍有不同,详见:[Native API 手册](native_manual.zh-CN.md)
230-
* 每个 hook 函数中都必须执行 ByteHook 的 stack 清理逻辑。有两种方式:
228+
*proxy 函数中可以不调用原函数,也可以通过 `BYTEHOOK_CALL_PREV` 宏来调用原函数,但请不要通过函数名来直接调用原函数。
229+
* `BYTEHOOK_CALL_PREV` 宏在 C++ 源文件中的用法是:第一个参数传递当前的 proxy 函数名(上例中为 `my_strlen()`),后面按照顺序依次传递函数的各个参数。(`BYTEHOOK_CALL_PREV` 宏在 C 源文件中的用法稍有不同,详见:[Native API 手册](native_manual.zh-CN.md)
230+
* 每个 proxy 函数中都必须执行 ByteHook 的 stack 清理逻辑。有两种方式:
231231

232-
1. 在 C++ 代码中:在“hook 函数”开头调用一次 `BYTEHOOK_STACK_SCOPE` 宏。(其中会通过析构函数的方式,来保证 stack 清理逻辑一定会被执行)
233-
2. 在 C 代码中:请在“hook 函数”的每一个“返回分支”末尾都调用 `BYTEHOOK_POP_STACK` 宏。例如:
232+
1. 在 C++ 代码中:在“proxy 函数”开头调用一次 `BYTEHOOK_STACK_SCOPE` 宏。(其中会通过析构函数的方式,来保证 stack 清理逻辑一定会被执行)
233+
2. 在 C 代码中:请在“proxy 函数”的每一个“返回分支”末尾都调用 `BYTEHOOK_POP_STACK` 宏。例如:
234234

235235
```C
236236
typedef size_t (*strlen_t)(const char* const);

doc/status_code.zh-CN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,15 @@ hook 任务为“ hook 进程中所有 ELF 对 `libcutils.so` 中 `atrace_begin_
9292

9393
## 18
9494

95-
自动模式中。在一个已经分配了 trampoline 的 hook list 中创建新的 hook 函数时失败。
95+
自动模式中。在一个已经分配了 trampoline 的 hook list 中创建新的 proxy 函数时失败。
9696

9797
## 19
9898

9999
替换 GOT 值之前,通过 `dladdr()` 验证函数地址失败。
100100

101101
## 20
102102

103-
同一个 ELF caller 的同一个函数上,已经存在了一个相同的 hook 函数。
103+
同一个 ELF caller 的同一个函数上,已经存在了一个相同的 proxy 函数。
104104

105105
## 21
106106

0 commit comments

Comments
 (0)