forked from huzecong/ghcc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmatch_functions.py
779 lines (700 loc) · 29.9 KB
/
match_functions.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
# Match decompiled code with their original code
import contextlib
import functools
import json
import os
import pickle
import random
import re
import shutil
import string
import time
import sys
from collections import defaultdict
from pathlib import Path
from typing import Callable, Dict, Iterator, List, NamedTuple, Optional, Set, Tuple
import logging
from ghcc.logging import init_logger
import argtyped
import flutes
import pycparser
import tqdm
from argtyped import Switch
from pycparser.c_ast import Node as ASTNode
from pycparser.c_generator import CGenerator
from pycparser.c_parser import CParser
# from pycparserext.ext_c_generator import GnuCGenerator as CGenerator
# from pycparserext.ext_c_parser import GnuCParser as CParser
import ghcc
class Arguments(argtyped.Arguments):
"""
Arguments for matching functions
Attributes
----------
archive_dir : Optional[str]
directory containing repo archives
decompile_dir : str
directory containing decompiled output
temp_dir : str
log_file : str
output_dir : str
directory to save matching functions
use_fake_libc_headers : Switch
use pycparser fake libc headers to safe time
n_procs : int
number of processes
max_repos : Optional[int]
maximum number of repositories to process (ignoring non-existent)
exit_on_exception : Switch
pdb : Switch
write_db : Switch
skip_to : Optional[str]
skip to specified repository
repo_binary_info_cache_path : Optional[str]
if specified, load/save repo_binaries instead of loading from DB
verbose : Switch
preprocess_timeout : Optional[int]
show_progres : Switch
show a progress bar for each worker process; has a large overhead
force_reprocess : Switch
also process repos that are recorded as processed in the DB
"""
archive_dir: Optional[str] = "archives/"
decompile_dir: str = "decompile_output_fixed/"
temp_dir: str = "repos/"
log_file: str = "match-log.txt"
output_dir: str = "match_output/"
use_fake_libc_headers: Switch = True
n_procs: int = 0
max_repos: Optional[int] = None
exit_on_exception: Switch = False
pdb: Switch = False
write_db: Switch = True
skip_to: Optional[str]
repo_binary_info_cache_path: Optional[str]
verbose: Switch = False
preprocess_timeout: Optional[int] = 600
show_progress: Switch = False
force_reprocess: Switch = False
class RepoInfo(NamedTuple):
"""
Information for a repository
Attributes
----------
idx : int
repo_owner : str
repo_name : str
makefiles : Dict[str, Dict[str, str]]
maps make_dir to a dictionary mapping binary paths to their hash
"""
idx: int
repo_owner: str
repo_name: str
makefiles: Dict[str, Dict[str, str]]
class MatchedFunction(NamedTuple):
"""
Source code & decompiler info
Attributes
----------
file_path : str
binary_hash : str
func_name : str
variable_names : Dict[str, Tuple[str, str]]
dictionary mapping a variable id to a tuple of its decompiled variable
name and original variable name
original_tokens : List[str]
decompiled_tokens : List[str]
original_ast_json : ghcc.parse.JSONNode
decompiled_ast_json : Optional[ghcc.parse.JSONNode]
"""
file_path: str
binary_hash: str
func_name: str
variable_names: Dict[str, Tuple[str, str]]
original_tokens: List[str]
decompiled_tokens: List[str]
original_ast_json: ghcc.parse.JSONNode
decompiled_ast_json: Optional[ghcc.parse.JSONNode]
class Result(NamedTuple):
repo_owner: str
repo_name: str
matched_functions: List[MatchedFunction]
preprocessed_original_code: Dict[str, str] # (sha) -> code
files_found: int
functions_found: int
funcs_without_asts: int
DECOMPILED_CODE_HEADER = r"""
#define __fastcall
#define __noreturn
#define __cdecl
#define __stdcall
#define __usercall
#define __int128 long long // who cares
#define __int64 long long
#define __int32 int
#define __int16 short
#define __int8 char
// Actual types don't matter; we just need to know it's a type.
typedef int _QWORD;
typedef int _DWORD;
typedef int _WORD;
typedef int _BYTE;
typedef int _BOOL8;
typedef int _BOOL4;
typedef int WCHAR;
typedef int gcc_va_list;
typedef int (*__compar_fn_t)(const void *, const void *);
"""
with open(os.path.join(ghcc.parse.FAKE_LIBC_PATH, "_fake_gcc_ext.h")) as f:
DECOMPILED_CODE_HEADER += f.read()
def exception_handler(e: Exception, repo_info: RepoInfo):
logging.error(
f"Exception occurred when processing {repo_info.repo_owner}/{repo_info.repo_name}",
)
def find_matching_rbrace(tokens: List[ghcc.parse.Token], start: int) -> int:
balance = 0
for idx in range(start, len(tokens)):
if tokens[idx].name == "{":
balance += 1
elif tokens[idx].name == "}":
balance -= 1
if balance == 0:
return idx
raise ValueError
def serialize(
func_ast: ASTNode, tokens: List[ghcc.parse.Token]
) -> Tuple[ghcc.parse.JSONNode, List[str]]:
"""Generate serialized AST and lexed tokens for a single function.
:param func_ast:
:param tokens:
:return:
"""
ast_dict = ghcc.parse.ast_to_dict(func_ast, tokens)
# Instead of generating and lexing the code again, we find the
# function boundaries based on heuristics:
# - Left boundary is given by smallest token position in tree.
# - Right boundary is the matching right curly brace given the token
# position of the function body compound statement.
inf = len(tokens)
COORD = ghcc.parse.TOKEN_POS_ATTR
find_min_pos_fn = lambda node, xs: min(min(xs, default=inf), node[COORD] or inf)
left = ghcc.parse.visit_dict(
find_min_pos_fn, ast_dict[ghcc.parse.CHILDREN_ATTR]["decl"]
)
body_start = ghcc.parse.visit_dict(
find_min_pos_fn, ast_dict[ghcc.parse.CHILDREN_ATTR]["body"]
)
try:
right = find_matching_rbrace(tokens, body_start)
# Decrease all token positions by offset.
def visit_fn(node: ghcc.parse.JSONNode, _) -> None:
if node[COORD] is not None:
node[COORD] -= left
ghcc.parse.visit_dict(visit_fn, ast_dict)
token_names = [tok.name for tok in tokens[left : (right + 1)]]
except ValueError:
# Fallback to the fail-safe method.
token_names = ghcc.parse.LexerWrapper().lex(CGenerator().visit(func_ast))
return ast_dict, token_names
# Match function names in raw JSON read from decompilation output.
# - Capture groups: (func_name)
JSON_FUNC_NAME_REGEX = re.compile(r'"function":\s*"([^"]+)"')
# Match variable references in decompiled code.
# - Capture groups: (var_id, decompiled_var_name, original_var_name)
DECOMPILED_VAR_REGEX = re.compile(r"@@VAR_(\d+)@@([^@]+)@@([_a-zA-Z0-9]+)")
# Match register allocation annotations in decompiled code.
DECOMPILED_REG_ALLOC_REGEX = re.compile(r"@<[a-z0-9]+>")
# Match preprocessor comments.
# also chomp the newline symbol
LINE_CONTROL_REGEX = re.compile(r"^#[^\n]*\n", flags=re.MULTILINE)
IDENTIFIER_CHARS = string.ascii_letters + string.digits + "_"
@flutes.exception_wrapper(exception_handler)
def match_functions(
repo_info: RepoInfo,
archive_folder: str,
temp_folder: str,
decompile_folder: str,
use_fake_libc_headers: bool = True,
preprocess_timeout: Optional[int] = None,
*,
progress_bar: Optional[flutes.ProgressBarManager.Proxy] = None,
) -> Result:
# Directions:
# 1. Clone or extract from archive.
# 2. For each Makefile, rerun the compilation process with the flag "-E",
# so only the preprocessor is run. This probably won't take long as the
# compiler exits after running the processor, and linking would fail.
# Also, consider using "-nostdlib -Ipath/to/fake_libc_include" as
# suggested by `pycparser`.
# 3. The .o files are now preprocessed C code. Parse them using `pycparser`
# to obtain a list of functions.
start_time = time.time()
total_files = sum(len(makefile) for makefile in repo_info.makefiles.values())
repo_folder_name = f"{repo_info.repo_owner}_____{repo_info.repo_name}"
repo_full_name = f"{repo_info.repo_owner}/{repo_info.repo_name}"
archive_path = (Path(archive_folder) / f"{repo_full_name}.tar.gz").absolute()
repo_dir = (Path(temp_folder) / repo_folder_name).absolute()
repo_src_path = repo_dir / "src"
repo_binary_dir = repo_dir / "bin"
repo_binary_dir.mkdir(parents=True, exist_ok=True)
has_error = False
if progress_bar is not None:
worker_id = flutes.get_worker_id()
process_name = (
f"Worker {worker_id}" if worker_id is not None else "Main Process"
)
progress_bar.new(total=total_files, desc=process_name + f" [{repo_full_name}]")
logging.info(f"Begin processing {repo_full_name} ({total_files} files)")
if os.path.exists(archive_path):
# Extract archive
flutes.run_command(["tar", f"xzf", str(archive_path)], cwd=str(repo_dir))
(repo_dir / repo_folder_name).rename(repo_src_path)
else:
# Clone repo
if repo_src_path.exists():
shutil.rmtree(repo_src_path)
ret = ghcc.clone(
repo_info.repo_owner,
repo_info.repo_name,
clone_folder=str(repo_dir),
folder_name="src",
)
if ret.error_type not in [None, ghcc.CloneErrorType.SubmodulesFailed]:
logging.error(
f"Failed to clone {repo_full_name}: error type {ret.error_type}"
)
# Return a dummy result so this repo is ignored in the future.
return Result(repo_info.repo_owner, repo_info.repo_name, [], {}, 0, 0, 0)
# Write makefile info to pickle
with (repo_binary_dir / "makefiles.pkl").open("wb") as f_pkl:
pickle.dump(repo_info.makefiles, f_pkl)
gcc_flags = "-E"
directory_mapping = None
if use_fake_libc_headers:
gcc_flags = f"-E -nostdlib -I/usr/src/libc"
directory_mapping = {ghcc.parse.FAKE_LIBC_PATH: "/usr/src/libc"}
if progress_bar is not None:
progress_bar.update(postfix={"status": "preprocessing"})
makefiles = ghcc.docker_batch_compile(
str(repo_binary_dir),
str(repo_src_path),
compile_timeout=preprocess_timeout,
gcc_override_flags=gcc_flags,
use_makefile_info_pkl=True,
directory_mapping=directory_mapping,
user_id=(repo_info.idx % 10000) + 30000, # user IDs 30000 ~ 39999
exception_log_fn=functools.partial(exception_handler, repo_info=repo_info),
)
parser = CParser(lexer=ghcc.parse.CachedCLexer)
lexer = ghcc.parse.LexerWrapper()
decompile_path = Path(decompile_folder)
extractor = ghcc.parse.FunctionExtractor()
matched_functions: List[MatchedFunction] = []
preprocessed_original_code: Dict[str, str] = {}
files_found = 0
functions_found = 0
for makefile in makefiles:
mkfile_dir = Path(makefile["directory"])
for path, sha in zip(makefile["binaries"], makefile["sha256"]):
# Load and parse preprocessed original code.
code_path = str(mkfile_dir / path)
json_path = decompile_path / (sha + ".jsonl")
preprocessed_code_path = repo_binary_dir / sha
if progress_bar is not None:
progress_bar.update(1, postfix={"file": code_path})
if not json_path.exists() or not preprocessed_code_path.exists():
continue
try:
with preprocessed_code_path.open("r") as f:
code = f.read()
code = LINE_CONTROL_REGEX.sub("", code)
except UnicodeDecodeError:
continue # probably a real binary file
preprocessed_original_code[sha] = code
try:
original_ast: ASTNode = parser.parse(
code, filename=os.path.join(repo_full_name, path)
)
except (pycparser.c_parser.ParseError, AssertionError) as e:
# For some reason `pycparser` uses `assert`s in places
# where there should have been a check.
logging.error(
f"{repo_full_name}: Parser error when processing file "
f"{code_path} ({sha}): {str(e)}"
)
has_error = True
continue # ignore parsing errors
original_tokens = ghcc.parse.convert_to_tokens(
code, parser.clex.cached_tokens
)
files_found += 1
function_asts = extractor.find_functions(original_ast)
functions_found += len(function_asts)
# Collect decompiled functions with matching original code.
with json_path.open("r") as f:
decompiled_json = [
line for line in f if line
] # don't decode, as we only need the function name
decompiled_funcs: Dict[str, str] = {} # (func_name) -> decompiled_code
decompiled_var_names: Dict[
str, Dict[str, Tuple[str, str]]
] = {} # (func_name) -> (var_id) -> (decomp_name, orig_name)
for line_num, j in enumerate(decompiled_json):
# Find function name from JSON line without parsing.
match = JSON_FUNC_NAME_REGEX.search(j)
assert match is not None
func_name = match.group(1)
if func_name not in function_asts:
continue
try:
decompiled_data = json.loads(j)
except json.JSONDecodeError as e:
logging.error(
f"{repo_full_name}: Decode error when reading JSON file"
f"at {json_path}: {str(e)}"
)
continue
decompiled_code = decompiled_data["raw_code"]
# Store the variable names used in the function.
# We use a random string as the identifier prefix. Sadly, C89
# (and `pycparser`) doesn't support Unicode.
for length in range(3, 10 + 1):
var_identifier_prefix = "v" + "".join(
random.choices(string.ascii_lowercase, k=length)
)
if var_identifier_prefix not in decompiled_code:
break
else:
# No way this is happening, right?
logging.error(
f"{repo_full_name}: Could not find valid identifier prefix "
f"for {func_name} in {code_path} ({sha})"
)
continue
# (var_id) -> (decompiled_name, original_name)
variables: Dict[str, Tuple[str, str]] = {}
for match in DECOMPILED_VAR_REGEX.finditer(decompiled_code):
var_id, decompiled_name, original_name = match.groups()
var_id = f"{var_identifier_prefix}_{var_id}"
if var_id in variables:
assert variables[var_id] == (decompiled_name, original_name)
else:
variables[var_id] = (decompiled_name, original_name)
decompiled_var_names[func_name] = variables
# Remove irregularities in decompiled code to make the it parsable:
# - Replace `@@VAR` with special identifiers (literally anything
# identifier that doesn't clash).
# - Remove the register allocation indication in `var@<rdi>`.
decompiled_code = DECOMPILED_VAR_REGEX.sub(
rf"{var_identifier_prefix}_\1", decompiled_code
)
decompiled_code = DECOMPILED_REG_ALLOC_REGEX.sub("", decompiled_code)
if func_name.startswith("_"):
# For some reason, Hexrays would chomp off one leading
# underscore from function names in their generated code,
# which might lead to corrupt code (`_01inverse` -> `01inverse`).
# Here we heuristically try to find and replace the changed
# function name.
# replace all identifiers with matching name
decompiled_code = re.sub(
r"(?<![a-zA-Z0-9_])" + func_name[1:] + r"(?![a-zA-Z0-9_])",
func_name,
decompiled_code,
)
# Note that this doesn't fix references of the function in
# other functions. But really, why would someone name their
# function `_01inverse`?
decompiled_funcs[func_name] = decompiled_code
# Generate code replacing original functions with decompiled functions.
replacer = ghcc.parse.FunctionReplacer(decompiled_funcs)
replaced_code = replacer.visit(original_ast)
# Obtain AST for decompiled code by parsing it again.
code_to_preprocess = DECOMPILED_CODE_HEADER + "\n" + replaced_code
try:
code_to_parse = ghcc.parse.preprocess(code_to_preprocess)
except ghcc.parse.PreprocessError as e:
msg = (
f"{repo_full_name}: GCC return value nonzero for "
f"decompiled code of {code_path} ({sha})"
)
if len(e.args) > 0:
msg += ":\n" + str(e)
logging.error(msg)
has_error = True
continue
try:
decompiled_ast, code_to_parse = ghcc.parse.parse_decompiled_code(
code_to_parse, lexer, parser
)
decompiled_tokens = ghcc.parse.convert_to_tokens(
code_to_parse, parser.clex.cached_tokens
)
except (ValueError, pycparser.c_parser.ParseError) as e:
logging.error(
f"{repo_full_name}: Could not parse decompiled code for "
f"{code_path} ({sha}): {str(e)}"
)
has_error = True
# We don't have ASTs for decompiled functions, but we can still dump
# the code.
# Use the dummy typedefs to extract functions.
code_lines = code_to_parse.split("\n")
func_begin_end: Dict[str, List[Optional[int]]] = defaultdict(
lambda: [None, None]
)
for idx, line in enumerate(code_lines):
name, is_begin = replacer.extract_func_name(line)
if name is not None:
func_begin_end[name][0 if is_begin else 1] = idx
for func_name, (begin, end) in func_begin_end.items():
if (
begin is not None
and end is not None
and func_name in function_asts
):
decompiled_func_tokens = lexer.lex(
"\n".join(code_lines[(begin + 1) : end])
)
original_func_ast = function_asts[func_name]
original_ast_json, original_func_tokens = serialize(
original_func_ast, original_tokens
)
matched_func = MatchedFunction(
file_path=code_path,
binary_hash=sha,
func_name=func_name,
variable_names=decompiled_var_names[func_name],
original_tokens=original_func_tokens,
decompiled_tokens=decompiled_func_tokens,
original_ast_json=original_ast_json,
decompiled_ast_json=None,
)
matched_functions.append(matched_func)
else:
# We've successfully parsed decompiled code.
decompiled_func_asts = extractor.find_functions(decompiled_ast)
for func_name in decompiled_funcs.keys():
original_func_ast = function_asts[func_name]
if func_name not in decompiled_func_asts:
# Maybe there's other Hexrays-renamed functions that we
# didn't fix, just ignore them.
continue
decompiled_func_ast = decompiled_func_asts[func_name]
original_ast_json, original_func_tokens = serialize(
original_func_ast, original_tokens
)
decompiled_ast_json, decompiled_func_tokens = serialize(
decompiled_func_ast, decompiled_tokens
)
matched_func = MatchedFunction(
file_path=code_path,
binary_hash=sha,
func_name=func_name,
variable_names=decompiled_var_names[func_name],
original_tokens=original_func_tokens,
decompiled_tokens=decompiled_func_tokens,
original_ast_json=original_ast_json,
decompiled_ast_json=decompiled_ast_json,
)
matched_functions.append(matched_func)
# Cleanup the folders; if errors occurred, keep the preprocessed code.
if not has_error and len(matched_functions) > 0:
status = logging.INFO
elif not has_error or len(matched_functions) > 0:
status = logging.WARNING
else:
status = logging.ERROR
shutil.rmtree(repo_dir)
end_time = time.time()
funcs_without_asts = sum(
matched_func.decompiled_ast_json is None for matched_func in matched_functions
)
logging.log(
level=status,
msg=f"[{end_time - start_time:6.2f}s] "
f"{repo_full_name}: "
f"Files found: {files_found}/{total_files}, "
f"functions matched: {len(matched_functions)}/{functions_found} "
f"({funcs_without_asts} w/o ASTs)",
)
return Result(
repo_owner=repo_info.repo_owner,
repo_name=repo_info.repo_name,
matched_functions=matched_functions,
preprocessed_original_code=preprocessed_original_code,
files_found=files_found,
functions_found=functions_found,
funcs_without_asts=funcs_without_asts,
)
def _iter_repos(
db_entries: Set[Tuple[str, str]],
max_count: Optional[int] = None,
skip_to: Optional[str] = None,
cache_path: Optional[str] = None,
) -> Iterator[RepoInfo]:
with contextlib.closing(ghcc.RepoDB()) as repo_db, contextlib.closing(
ghcc.BinaryDB()
) as binary_db:
@flutes.cache(cache_path, name="repo binary info")
def _get_repo_binaries_info() -> Dict[Tuple[str, str], Set[str]]:
repo_binaries: Dict[Tuple[str, str], Set[str]] = defaultdict(set)
all_bins = binary_db.collection.find()
for entry in tqdm.tqdm(
all_bins, total=all_bins.count(), desc="Listing decompiled binaries"
):
if entry["success"]:
repo_binaries[entry["repo_owner"], entry["repo_name"]].add(
entry["sha"]
)
return repo_binaries
repo_binaries = _get_repo_binaries_info()
repo_entries: Iterator[ghcc.RepoDB.Entry] = repo_db.safe_iter(
batch_size=10000, static=True
)
if skip_to is not None:
skip_to_repo = tuple(skip_to.split("/"))
repo_entries = flutes.drop_until(
lambda entry: (entry["repo_owner"], entry["repo_name"]) == skip_to_repo,
repo_entries,
)
index = 0
for entry in repo_entries:
if (
not entry["clone_successful"]
or not entry["compiled"]
or len(entry["makefiles"]) == 0
or entry["num_binaries"] == 0
):
# Nothing to match.
continue
if (entry["repo_owner"], entry["repo_name"]) in db_entries:
# Already processed.
continue
binaries = repo_binaries[entry["repo_owner"], entry["repo_name"]]
makefiles: Dict[str, Dict[str, str]] = {}
for makefile in entry["makefiles"]:
mapping = {}
for path, sha in zip(makefile["binaries"], makefile["sha256"]):
if sha in binaries:
mapping[path] = sha
# the same binary may be generated in multiple Makefiles
binaries.remove(sha)
if len(mapping) > 0:
makefiles[makefile["directory"]] = mapping
if len(makefiles) == 0:
continue
yield RepoInfo(index, entry["repo_owner"], entry["repo_name"], makefiles)
index += 1
if max_count is not None and index >= max_count:
break
class DBStats(NamedTuple):
repo_count: int
func_count: int
func_without_ast_count: int
def iter_repos(
db: ghcc.MatchFuncDB,
max_count: Optional[int] = None,
skip_to: Optional[str] = None,
cache_path: Optional[str] = None,
force_reprocess: bool = False,
) -> Tuple[Iterator[RepoInfo], DBStats]:
repo_count = func_count = func_without_ast_count = 0
processed_db_entries: Set[Tuple[str, str]] = set()
for entry in db.collection.find():
if not force_reprocess and entry["funcs_matched_without_ast"] == 0:
processed_db_entries.add((entry["repo_owner"], entry["repo_name"]))
repo_count += 1
func_count += entry["funcs_matched"]
func_without_ast_count += entry["funcs_matched_without_ast"]
iterator = _iter_repos(processed_db_entries, max_count, skip_to, cache_path)
stats = DBStats(repo_count, func_count, func_without_ast_count)
return iterator, stats
def main() -> None:
if not ghcc.utils.verify_docker_image(verbose=True):
exit(1)
sys.setrecursionlimit(10000)
args = Arguments()
if args.pdb:
flutes.register_ipython_excepthook()
if args.n_procs == 0:
globals()["match_functions"] = match_functions.__wrapped__
logging_level = logging.DEBUG if not args.verbose else logging.INFO
init_logger(logging_level)
logging.info("Running with arguments:\n" + args.to_string())
if os.path.exists(args.temp_dir):
logging.warning(f"Removing contents of temporary folder '{args.temp_dir}'...")
ghcc.utils.run_docker_command(
["rm", "-rf", "/usr/src/*"],
user=0,
directory_mapping={args.temp_dir: "/usr/src"},
)
db = ghcc.MatchFuncDB()
output_dir = Path(args.output_dir)
output_dir.mkdir(parents=True, exist_ok=True)
manager = flutes.ProgressBarManager(
verbose=args.show_progress,
bar_format="{l_bar}{bar}| {n_fmt}/{total_fmt} [{elapsed}{postfix}]",
)
with flutes.safe_pool(args.n_procs, closing=[db, manager]) as pool:
iterator, stats = iter_repos(
db,
args.max_repos,
skip_to=args.skip_to,
cache_path=args.repo_binary_info_cache_path,
force_reprocess=args.force_reprocess,
)
match_fn: Callable[[RepoInfo], Result] = functools.partial(
match_functions,
archive_folder=args.archive_dir,
temp_folder=args.temp_dir,
decompile_folder=args.decompile_dir,
use_fake_libc_headers=args.use_fake_libc_headers,
preprocess_timeout=args.preprocess_timeout,
progress_bar=manager.proxy,
)
repo_count = stats.repo_count
func_count = stats.func_count
func_without_ast_count = stats.func_without_ast_count
for result in pool.imap_unordered(match_fn, iterator):
if result is None:
# Exception occurred.
if args.exit_on_exception:
logging.warning(
"Exception occurred, exiting because 'exit_on_exception' is True"
)
break
continue
# Write the matched functions to disk.
result: Result # type: ignore
repo_dir = output_dir / result.repo_owner / result.repo_name
repo_dir.mkdir(parents=True, exist_ok=True)
with (repo_dir / "matched_funcs.jsonl").open("w") as f:
for matched_func in result.matched_functions:
f.write(
json.dumps(matched_func._asdict(), separators=(",", ":")) + "\n"
)
for sha, code in result.preprocessed_original_code.items():
with (repo_dir / f"{sha}.c").open("w") as f:
pos = code.rfind(ghcc.parse.FAKE_LIBC_END_LINE)
if pos != -1:
code = code[(pos + len(ghcc.parse.FAKE_LIBC_END_LINE)) :]
f.write(code)
if args.write_db:
db.add_repo(
result.repo_owner,
result.repo_name,
files_found=result.files_found,
funcs_found=result.functions_found,
funcs_matched=len(result.matched_functions),
funcs_matched_without_ast=result.funcs_without_asts,
)
repo_count += 1
func_count += len(result.matched_functions)
func_without_ast_count += result.funcs_without_asts
if repo_count % 100 == 0:
logging.info(
f"Processed {repo_count} repositories, {func_count} functions matched "
f"({func_without_ast_count} w/o AST)"
)
if __name__ == "__main__":
main()