|
|
|
@ -56,19 +56,19 @@
|
|
|
|
|
#include <sys/wait.h>
|
|
|
|
|
#include <sys/time.h>
|
|
|
|
|
|
|
|
|
|
static u8** as_params; /* Parameters passed to the real 'as' */
|
|
|
|
|
static u8** as_params; /* Parameters passed to the real 'as' */ //传递给as的参数数组
|
|
|
|
|
|
|
|
|
|
static u8* input_file; /* Originally specified input file */
|
|
|
|
|
static u8* modified_file; /* Instrumented file for the real 'as' */
|
|
|
|
|
static u8* input_file; /* Originally specified input file */
|
|
|
|
|
static u8* modified_file; /* Instrumented file for the real 'as' */ //用于as的插有instrumentation的文件
|
|
|
|
|
|
|
|
|
|
static u8 be_quiet, /* Quiet mode (no stderr output) */
|
|
|
|
|
clang_mode, /* Running in clang mode? */
|
|
|
|
|
pass_thru, /* Just pass data through? */
|
|
|
|
|
just_version, /* Just show version? */
|
|
|
|
|
sanitizer; /* Using ASAN / MSAN */
|
|
|
|
|
static u8 be_quiet, /* Quiet mode (no stderr output) */ //是否开启安静模式(不输出到stderr)
|
|
|
|
|
clang_mode, /* Running in clang mode? */ // 是否在clang模式下运行
|
|
|
|
|
pass_thru, /* Just pass data through? */ //是否只是简单地传递数据
|
|
|
|
|
just_version, /* Just show version? */ //是否只显示版本号
|
|
|
|
|
sanitizer; /* Using ASAN / MSAN */ //是否使用ASAN或MSAN
|
|
|
|
|
|
|
|
|
|
static u32 inst_ratio = 100, /* Instrumentation probability (%) */
|
|
|
|
|
as_par_cnt = 1; /* Number of params to 'as' */
|
|
|
|
|
static u32 inst_ratio = 100, /* Instrumentation probability (%) */ //Instrumentation概率(%)
|
|
|
|
|
as_par_cnt = 1; /* Number of params to 'as' */ //传递给as的参数数量
|
|
|
|
|
|
|
|
|
|
/* If we don't find --32 or --64 in the command line, default to
|
|
|
|
|
instrumentation for whichever mode we were compiled with. This is not
|
|
|
|
@ -92,7 +92,7 @@ static u8 use_64bit = 0;
|
|
|
|
|
/* Examine and modify parameters to pass to 'as'. Note that the file name
|
|
|
|
|
is always the last parameter passed by GCC, so we exploit this property
|
|
|
|
|
to keep the code simple. */
|
|
|
|
|
|
|
|
|
|
//处理和修改传递给as(GNU assembler)的参数。这个函数会检查命令行参数,并根据这些参数来设置全局变量,如use_64bit和as_params
|
|
|
|
|
static void edit_params(int argc, char** argv) {
|
|
|
|
|
|
|
|
|
|
u8 *tmp_dir = getenv("TMPDIR"), *afl_as = getenv("AFL_AS");
|
|
|
|
@ -129,7 +129,7 @@ static void edit_params(int argc, char** argv) {
|
|
|
|
|
/* Although this is not documented, GCC also uses TEMP and TMP when TMPDIR
|
|
|
|
|
is not set. We need to check these non-standard variables to properly
|
|
|
|
|
handle the pass_thru logic later on. */
|
|
|
|
|
|
|
|
|
|
//检查TMPDIR、AFL_AS等环境变量,确定临时目录和汇编器路径
|
|
|
|
|
if (!tmp_dir) tmp_dir = getenv("TEMP");
|
|
|
|
|
if (!tmp_dir) tmp_dir = getenv("TMP");
|
|
|
|
|
if (!tmp_dir) tmp_dir = "/tmp";
|
|
|
|
@ -148,7 +148,9 @@ static void edit_params(int argc, char** argv) {
|
|
|
|
|
#ifdef __APPLE__
|
|
|
|
|
|
|
|
|
|
/* The Apple case is a bit different... */
|
|
|
|
|
|
|
|
|
|
//这段代码检查命令行参数中是否有 -arch,并检查其后的参数。
|
|
|
|
|
//如果 -arch 后面是 x86_64,则设置 use_64bit 为 1,表示使用 64 位模式。
|
|
|
|
|
//如果 -arch 后面是 i386,则输出错误信息并终止程序,因为 32 位的 Apple 平台不被支持
|
|
|
|
|
if (!strcmp(argv[i], "-arch") && i + 1 < argc) {
|
|
|
|
|
|
|
|
|
|
if (!strcmp(argv[i + 1], "x86_64")) use_64bit = 1;
|
|
|
|
@ -159,12 +161,12 @@ static void edit_params(int argc, char** argv) {
|
|
|
|
|
|
|
|
|
|
/* Strip options that set the preference for a particular upstream
|
|
|
|
|
assembler in Xcode. */
|
|
|
|
|
|
|
|
|
|
//如果当前处于 clang 模式,并且命令行参数中有 -q 或 -Q,则跳过这些参数,不将它们传递给汇编器
|
|
|
|
|
if (clang_mode && (!strcmp(argv[i], "-q") || !strcmp(argv[i], "-Q")))
|
|
|
|
|
continue;
|
|
|
|
|
|
|
|
|
|
#endif /* __APPLE__ */
|
|
|
|
|
|
|
|
|
|
//将当前处理的命令行参数 argv[i] 添加到 as_params 数组中,as_par_cnt 用于记录已添加的参数数量
|
|
|
|
|
as_params[as_par_cnt++] = argv[i];
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
@ -173,7 +175,9 @@ static void edit_params(int argc, char** argv) {
|
|
|
|
|
|
|
|
|
|
/* When calling clang as the upstream assembler, append -c -x assembler
|
|
|
|
|
and hope for the best. */
|
|
|
|
|
|
|
|
|
|
//如果 use_clang_as 为真(即在 macOS 下使用 clang 作为汇编器)
|
|
|
|
|
//则向 as_params 数组中添加 -c、-x 和 assembler 参数
|
|
|
|
|
//以确保 clang 正确处理汇编文件
|
|
|
|
|
if (use_clang_as) {
|
|
|
|
|
|
|
|
|
|
as_params[as_par_cnt++] = "-c";
|
|
|
|
@ -183,7 +187,9 @@ static void edit_params(int argc, char** argv) {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#endif /* __APPLE__ */
|
|
|
|
|
|
|
|
|
|
//如果是 --version,则设置 just_version 为 1,并跳转到 wrap_things_up,直接返回版本信息。
|
|
|
|
|
//如果输入文件以 - 开头但不是 --version,则输出错误信息并终止程序。
|
|
|
|
|
//如果输入文件是单独的 -,则将 input_file 设置为 NULL,表示从标准输入读取
|
|
|
|
|
input_file = argv[argc - 1];
|
|
|
|
|
|
|
|
|
|
if (input_file[0] == '-') {
|
|
|
|
@ -203,16 +209,17 @@ static void edit_params(int argc, char** argv) {
|
|
|
|
|
to compile a program, rather than using gcc on an ad-hoc .s file in
|
|
|
|
|
a format we may not understand. This works around an issue compiling
|
|
|
|
|
NSS. */
|
|
|
|
|
|
|
|
|
|
//检查输入文件是否位于临时目录(如 /tmp 或 /var/tmp)。
|
|
|
|
|
//如果输入文件不在临时目录中,则设置 pass_thru 为 1,表示直接传递文件内容而不进行插桩
|
|
|
|
|
if (strncmp(input_file, tmp_dir, strlen(tmp_dir)) &&
|
|
|
|
|
strncmp(input_file, "/var/tmp/", 9) &&
|
|
|
|
|
strncmp(input_file, "/tmp/", 5)) pass_thru = 1;
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//生成一个临时文件名,用于存储插桩后的汇编文件。文件名格式为 tmp_dir/.afl-PID-TIMESTAMP.s
|
|
|
|
|
modified_file = alloc_printf("%s/.afl-%u-%u.s", tmp_dir, getpid(),
|
|
|
|
|
(u32)time(NULL));
|
|
|
|
|
|
|
|
|
|
//将生成的临时文件名添加到 as_params 数组中,作为汇编器的输入文件,并将数组末尾设置为 NULL,表示参数列表结束
|
|
|
|
|
wrap_things_up:
|
|
|
|
|
|
|
|
|
|
as_params[as_par_cnt++] = modified_file;
|
|
|
|
@ -223,9 +230,13 @@ wrap_things_up:
|
|
|
|
|
|
|
|
|
|
/* Process input file, generate modified_file. Insert instrumentation in all
|
|
|
|
|
the appropriate places. */
|
|
|
|
|
|
|
|
|
|
//处理输入文件,并生成一个修改过的文件modified_file,在其中插入 instrumentation(仪器化代码)。这个函数会读取原始的汇编文件,根据配置插入instrumentation代码,并将结果写入新的文件
|
|
|
|
|
static void add_instrumentation(void) {
|
|
|
|
|
|
|
|
|
|
//line[MAX_LINE]:用于存储从输入文件中读取的每一行。
|
|
|
|
|
//inf 和 outf:分别表示输入文件和输出文件的指针。
|
|
|
|
|
//outfd:输出文件的文件描述符。
|
|
|
|
|
//ins_lines:记录插桩的行数。
|
|
|
|
|
其他布尔变量用于控制插桩的逻辑(如是否跳过某些部分)
|
|
|
|
|
static u8 line[MAX_LINE];
|
|
|
|
|
|
|
|
|
|
FILE* inf;
|
|
|
|
@ -241,14 +252,16 @@ static void add_instrumentation(void) {
|
|
|
|
|
u8* colon_pos;
|
|
|
|
|
|
|
|
|
|
#endif /* __APPLE__ */
|
|
|
|
|
|
|
|
|
|
//打开输入文件以供读取。
|
|
|
|
|
//如果 input_file 不为空,则打开该文件;否则从标准输入读取
|
|
|
|
|
if (input_file) {
|
|
|
|
|
|
|
|
|
|
inf = fopen(input_file, "r");
|
|
|
|
|
if (!inf) PFATAL("Unable to read '%s'", input_file);
|
|
|
|
|
|
|
|
|
|
} else inf = stdin;
|
|
|
|
|
|
|
|
|
|
//创建并打开输出文件以供写入。
|
|
|
|
|
//使用 open 创建文件,并使用 fdopen 将其转换为 FILE* 类型
|
|
|
|
|
outfd = open(modified_file, O_WRONLY | O_EXCL | O_CREAT, 0600);
|
|
|
|
|
|
|
|
|
|
if (outfd < 0) PFATAL("Unable to write to '%s'", modified_file);
|
|
|
|
@ -256,14 +269,15 @@ static void add_instrumentation(void) {
|
|
|
|
|
outf = fdopen(outfd, "w");
|
|
|
|
|
|
|
|
|
|
if (!outf) PFATAL("fdopen() failed");
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
while (fgets(line, MAX_LINE, inf)) {
|
|
|
|
|
|
|
|
|
|
/* In some cases, we want to defer writing the instrumentation trampoline
|
|
|
|
|
until after all the labels, macros, comments, etc. If we're in this
|
|
|
|
|
mode, and if the line starts with a tab followed by a character, dump
|
|
|
|
|
the trampoline now. */
|
|
|
|
|
|
|
|
|
|
//在适当的位置插入插桩代码。
|
|
|
|
|
//如果满足条件(如不在跳过模式、处于 .text 段、需要插桩等),则插入插桩代码,并增加插桩行数
|
|
|
|
|
if (!pass_thru && !skip_intel && !skip_app && !skip_csect && instr_ok &&
|
|
|
|
|
instrument_next && line[0] == '\t' && isalpha(line[1])) {
|
|
|
|
|
|
|
|
|
@ -276,15 +290,17 @@ static void add_instrumentation(void) {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* Output the actual line, call it a day in pass-thru mode. */
|
|
|
|
|
|
|
|
|
|
//将当前行写入输出文件。
|
|
|
|
|
fputs(line, outf);
|
|
|
|
|
|
|
|
|
|
//如果处于 pass_thru 模式,则跳过后续处理
|
|
|
|
|
if (pass_thru) continue;
|
|
|
|
|
|
|
|
|
|
/* All right, this is where the actual fun begins. For one, we only want to
|
|
|
|
|
instrument the .text section. So, let's keep track of that in processed
|
|
|
|
|
files - and let's set instr_ok accordingly. */
|
|
|
|
|
|
|
|
|
|
//检测并处理 .text 段。
|
|
|
|
|
//如果当前行表示 .text 段,则设置 instr_ok 为 1,表示可以插桩。
|
|
|
|
|
//如果当前行表示其他段(如 .bss 或 .data),则设置 instr_ok 为 0,表示跳过插桩
|
|
|
|
|
if (line[0] == '\t' && line[1] == '.') {
|
|
|
|
|
|
|
|
|
|
/* OpenBSD puts jump tables directly inline with the code, which is
|
|
|
|
@ -315,7 +331,8 @@ static void add_instrumentation(void) {
|
|
|
|
|
/* Detect off-flavor assembly (rare, happens in gdb). When this is
|
|
|
|
|
encountered, we set skip_csect until the opposite directive is
|
|
|
|
|
seen, and we do not instrument. */
|
|
|
|
|
|
|
|
|
|
//处理 .code 指令。
|
|
|
|
|
//如果检测到 .code32 或 .code64,则根据当前模式设置 skip_csect,跳过插桩
|
|
|
|
|
if (strstr(line, ".code")) {
|
|
|
|
|
|
|
|
|
|
if (strstr(line, ".code32")) skip_csect = use_64bit;
|
|
|
|
@ -325,12 +342,14 @@ static void add_instrumentation(void) {
|
|
|
|
|
|
|
|
|
|
/* Detect syntax changes, as could happen with hand-written assembly.
|
|
|
|
|
Skip Intel blocks, resume instrumentation when back to AT&T. */
|
|
|
|
|
|
|
|
|
|
//处理汇编语法变化。
|
|
|
|
|
//如果检测到 .intel_syntax,则跳过插桩;如果检测到 .att_syntax,则恢复插桩
|
|
|
|
|
if (strstr(line, ".intel_syntax")) skip_intel = 1;
|
|
|
|
|
if (strstr(line, ".att_syntax")) skip_intel = 0;
|
|
|
|
|
|
|
|
|
|
/* Detect and skip ad-hoc __asm__ blocks, likewise skipping them. */
|
|
|
|
|
|
|
|
|
|
//处理 #APP 和 #NO_APP 块。
|
|
|
|
|
//如果检测到 #APP,则跳过插桩;如果检测到 #NO_APP,则恢复插桩
|
|
|
|
|
if (line[0] == '#' || line[1] == '#') {
|
|
|
|
|
|
|
|
|
|
if (strstr(line, "#APP")) skip_app = 1;
|
|
|
|
@ -361,7 +380,8 @@ static void add_instrumentation(void) {
|
|
|
|
|
later on.
|
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
//处理函数标签和条件分支。
|
|
|
|
|
//如果当前行是条件分支指令(如 jnz),则插入插桩代码
|
|
|
|
|
if (skip_intel || skip_app || skip_csect || !instr_ok ||
|
|
|
|
|
line[0] == '#' || line[0] == ' ') continue;
|
|
|
|
|
|
|
|
|
@ -391,7 +411,8 @@ static void add_instrumentation(void) {
|
|
|
|
|
#ifdef __APPLE__
|
|
|
|
|
|
|
|
|
|
/* Apple: L<whatever><digit>: */
|
|
|
|
|
|
|
|
|
|
//处理标签。
|
|
|
|
|
//如果当前行是标签(如 .L0: 或 LBB0_0:),则根据需要设置 instrument_next,表示后续需要插桩
|
|
|
|
|
if ((colon_pos = strstr(line, ":"))) {
|
|
|
|
|
|
|
|
|
|
if (line[0] == 'L' && isdigit(*(colon_pos - 1))) {
|
|
|
|
@ -450,10 +471,11 @@ static void add_instrumentation(void) {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//在所有插桩完成后,插入主插桩代码
|
|
|
|
|
if (ins_lines)
|
|
|
|
|
fputs(use_64bit ? main_payload_64 : main_payload_32, outf);
|
|
|
|
|
|
|
|
|
|
//关闭文件并输出插桩结果。
|
|
|
|
|
//如果没有插桩目标,则输出警告;否则输出插桩的详细信息
|
|
|
|
|
if (input_file) fclose(inf);
|
|
|
|
|
fclose(outf);
|
|
|
|
|
|
|
|
|
@ -473,25 +495,30 @@ static void add_instrumentation(void) {
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* Main entry point */
|
|
|
|
|
|
|
|
|
|
//程序的主入口点。处理命令行参数,设置随机种子,调用edit_params来编辑参数
|
|
|
|
|
//根据环境变量AFL_INST_RATIO设置instrumentation概率
|
|
|
|
|
//然后调用add_instrumentation来添加instrumentation代码,并最终执行as
|
|
|
|
|
int main(int argc, char** argv) {
|
|
|
|
|
|
|
|
|
|
s32 pid;
|
|
|
|
|
u32 rand_seed;
|
|
|
|
|
int status;
|
|
|
|
|
u8* inst_ratio_str = getenv("AFL_INST_RATIO");
|
|
|
|
|
s32 pid; //用于存储 fork 后的子进程 ID
|
|
|
|
|
u32 rand_seed; //用于存储随机种子
|
|
|
|
|
int status; //用于存储子进程的退出状态
|
|
|
|
|
u8* inst_ratio_str = getenv("AFL_INST_RATIO"); //从环境变量 AFL_INST_RATIO 中获取插桩比例
|
|
|
|
|
|
|
|
|
|
struct timeval tv;
|
|
|
|
|
struct timezone tz;
|
|
|
|
|
|
|
|
|
|
//检查是否处于 clang 模式。
|
|
|
|
|
//如果环境变量 CLANG_ENV_VAR 存在,则设置 clang_mode 为 1,否则为 0
|
|
|
|
|
clang_mode = !!getenv(CLANG_ENV_VAR);
|
|
|
|
|
|
|
|
|
|
//检查是否在终端运行,并输出提示信息。
|
|
|
|
|
//如果标准错误输出是终端且未设置 AFL_QUIET,则输出程序名称和版本信息;否则设置 be_quiet 为 1,表示静默模式
|
|
|
|
|
if (isatty(2) && !getenv("AFL_QUIET")) {
|
|
|
|
|
|
|
|
|
|
SAYF(cCYA "afl-as " cBRI VERSION cRST " by <lcamtuf@google.com>\n");
|
|
|
|
|
|
|
|
|
|
} else be_quiet = 1;
|
|
|
|
|
|
|
|
|
|
//检查命令行参数是否足够。
|
|
|
|
|
//如果参数少于 2 个,则输出帮助信息并退出程序
|
|
|
|
|
if (argc < 2) {
|
|
|
|
|
|
|
|
|
|
SAYF("\n"
|
|
|
|
@ -506,22 +533,27 @@ int main(int argc, char** argv) {
|
|
|
|
|
exit(1);
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//生成并设置随机种子。
|
|
|
|
|
//使用当前时间、微秒数和进程 ID 生成随机种子,并调用 srandom 设置随机数生成器
|
|
|
|
|
gettimeofday(&tv, &tz);
|
|
|
|
|
|
|
|
|
|
rand_seed = tv.tv_sec ^ tv.tv_usec ^ getpid();
|
|
|
|
|
|
|
|
|
|
srandom(rand_seed);
|
|
|
|
|
|
|
|
|
|
//调用 edit_params 函数处理命令行参数。
|
|
|
|
|
//该函数会解析命令行参数并设置相关变量(如 input_file、modified_file 等)
|
|
|
|
|
edit_params(argc, argv);
|
|
|
|
|
|
|
|
|
|
//从环境变量 AFL_INST_RATIO 中读取插桩比例。
|
|
|
|
|
//如果插桩比例无效(不在 0 到 100 之间),则输出错误信息并终止程序
|
|
|
|
|
if (inst_ratio_str) {
|
|
|
|
|
|
|
|
|
|
if (sscanf(inst_ratio_str, "%u", &inst_ratio) != 1 || inst_ratio > 100)
|
|
|
|
|
FATAL("Bad value of AFL_INST_RATIO (must be between 0 and 100)");
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//检查并设置环境变量 AS_LOOP_ENV_VAR。
|
|
|
|
|
//如果该环境变量已存在,则输出错误信息并终止程序(防止无限循环)。
|
|
|
|
|
//否则设置该环境变量为 "1"
|
|
|
|
|
if (getenv(AS_LOOP_ENV_VAR))
|
|
|
|
|
FATAL("Endless loop when calling 'as' (remove '.' from your PATH)");
|
|
|
|
|
|
|
|
|
@ -530,27 +562,34 @@ int main(int argc, char** argv) {
|
|
|
|
|
/* When compiling with ASAN, we don't have a particularly elegant way to skip
|
|
|
|
|
ASAN-specific branches. But we can probabilistically compensate for
|
|
|
|
|
that... */
|
|
|
|
|
|
|
|
|
|
//处理 ASAN 或 MSAN 模式。
|
|
|
|
|
//如果启用了 ASAN 或 MSAN,则设置 sanitizer 为 1,并将插桩比例除以 3
|
|
|
|
|
if (getenv("AFL_USE_ASAN") || getenv("AFL_USE_MSAN")) {
|
|
|
|
|
sanitizer = 1;
|
|
|
|
|
inst_ratio /= 3;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//调用 add_instrumentation 函数进行插桩。
|
|
|
|
|
//如果未设置 just_version,则执行插桩操作
|
|
|
|
|
if (!just_version) add_instrumentation();
|
|
|
|
|
|
|
|
|
|
//创建子进程并执行 as 命令。
|
|
|
|
|
//使用 fork 创建子进程,并在子进程中调用 execvp 执行 as 命令。
|
|
|
|
|
//如果执行失败,则输出错误信息并终止程序
|
|
|
|
|
if (!(pid = fork())) {
|
|
|
|
|
|
|
|
|
|
execvp(as_params[0], (char**)as_params);
|
|
|
|
|
execvp(as_params[0], (char**)as_params);//传递给as的参数数组
|
|
|
|
|
FATAL("Oops, failed to execute '%s' - check your PATH", as_params[0]);
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//等待子进程结束。
|
|
|
|
|
//如果 fork 失败,则输出错误信息并终止程序。
|
|
|
|
|
//使用 waitpid 等待子进程结束,并获取其退出状态
|
|
|
|
|
if (pid < 0) PFATAL("fork() failed");
|
|
|
|
|
|
|
|
|
|
if (waitpid(pid, &status, 0) <= 0) PFATAL("waitpid() failed");
|
|
|
|
|
|
|
|
|
|
//删除临时文件。
|
|
|
|
|
//如果未设置 AFL_KEEP_ASSEMBLY,则删除生成的临时文件
|
|
|
|
|
if (!getenv("AFL_KEEP_ASSEMBLY")) unlink(modified_file);
|
|
|
|
|
|
|
|
|
|
//使用 WEXITSTATUS 获取子进程的退出状态,并将其作为程序的返回值
|
|
|
|
|
exit(WEXITSTATUS(status));
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|