Skip to content

Commit

Permalink
file based filter: Handle header lib
Browse files Browse the repository at this point in the history
  • Loading branch information
@xinzhengzhang
xinzhengzhang committed Mar 3, 2023
1 parent 0f25090 commit 251bbb2
Showing 1 changed file with 95 additions and 73 deletions.
168 changes: 95 additions & 73 deletions refresh.template.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -825,7 +825,71 @@ def _convert_compile_commands(aquery_output):


def _get_commands(target: str, flags: str):
"""Yields compile_commands.json entries for a given target and flags, gracefully tolerating errors."""
"""Return compile_commands.json entries for a given target and flags, gracefully tolerating errors."""
def _get_commands(target_statment):
aquery_args = [
'bazel',
'aquery',
# Aquery docs if you need em: https://docs.bazel.build/versions/master/aquery.html
# Aquery output proto reference: https://github.com/bazelbuild/bazel/blob/master/src/main/protobuf/analysis_v2.proto
# One bummer, not described in the docs, is that aquery filters over *all* actions for a given target, rather than just those that would be run by a build to produce a given output. This mostly isn't a problem, but can sometimes surface extra, unnecessary, misconfigured actions. Chris has emailed the authors to discuss and filed an issue so anyone reading this could track it: https://github.com/bazelbuild/bazel/issues/14156.
f"mnemonic('(Objc|Cpp)Compile', {target_statment})",
# We switched to jsonproto instead of proto because of https://github.com/bazelbuild/bazel/issues/13404. We could change back when fixed--reverting most of the commit that added this line and tweaking the build file to depend on the target in that issue. That said, it's kinda nice to be free of the dependency, unless (OPTIMNOTE) jsonproto becomes a performance bottleneck compated to binary protos.
'--output=jsonproto',
# We'll disable artifact output for efficiency, since it's large and we don't use them. Small win timewise, but dramatically less json output from aquery.
'--include_artifacts=false',
# Shush logging. Just for readability.
'--ui_event_filters=-info',
'--noshow_progress',
# Disable param files, which would obscure compile actions
# Mostly, people enable param files on Windows to avoid the relatively short command length limit.
# For more, see compiler_param_file in https://bazel.build/docs/windows
# They are, however, technically supported on other platforms/compilers.
# That's all well and good, but param files would prevent us from seeing compile actions before the param files had been generated by compilation.
# Since clangd has no such length limit, we'll disable param files for our aquery run.
'--features=-compiler_param_file',
# Disable layering_check during, because it causes large-scale dependence on generated module map files that prevent header extraction before their generation
# For more context, see https://github.com/hedronvision/bazel-compile-commands-extractor/issues/83
# If https://github.com/clangd/clangd/issues/123 is resolved and we're not doing header extraction, we could try removing this, checking that there aren't erroneous red squigglies squigglies before the module maps are generated.
# If Bazel starts supporting modules (https://github.com/bazelbuild/bazel/issues/4005), we'll probably need to make changes that subsume this.
'--features=-layering_check',
] + additional_flags

aquery_process = subprocess.run(
aquery_args,
capture_output=True,
encoding=locale.getpreferredencoding(),
check=False, # We explicitly ignore errors from `bazel aquery` and carry on.
)


# Filter aquery error messages to just those the user should care about.
missing_targets_warning: typing.Pattern[str] = re.compile(r'(\(\d+:\d+:\d+\) )?(\033\[[\d;]+m)?WARNING: (\033\[[\d;]+m)?Targets were missing from graph:') # Regex handles --show_timestamps and --color=yes. Could use "in" if we ever need more flexibility.
for line in aquery_process.stderr.splitlines():
# Shush known warnings about missing graph targets.
# The missing graph targets are not things we want to introspect anyway.
# Tracking issue https://github.com/bazelbuild/bazel/issues/13007.
if missing_targets_warning.match(line):
continue

print(line, file=sys.stderr)


# Parse proto output from aquery
try:
# object_hook -> SimpleNamespace allows object.member syntax, like a proto, while avoiding the protobuf dependency
parsed_aquery_output = json.loads(aquery_process.stdout, object_hook=lambda d: types.SimpleNamespace(**d))
except json.JSONDecodeError:
print("Bazel aquery failed. Command:", aquery_args, file=sys.stderr)
log_warning(f">>> Failed extracting commands for {target}\n Continuing gracefully...")
return []

if not getattr(parsed_aquery_output, 'actions', None): # Unifies cases: No actions (or actions list is empty)
return []

return _convert_compile_commands(parsed_aquery_output)


# Log clear completion messages
log_info(f">>> Analyzing commands used in {target}")

Expand Down Expand Up @@ -855,88 +919,46 @@ def _get_commands(target: str, flags: str):
Try adding them as flags in your refresh_compile_commands rather than targets.
In a moment, Bazel will likely fail to parse.""")

compile_commands = []
# First, query Bazel's C-family compile actions for that configured target
target_statment = f'deps({target})'
if {exclude_external_sources}:
# For efficiency, have bazel filter out external targets (and therefore actions) before they even get turned into actions or serialized and sent to us. Note: this is a different mechanism than is used for excluding just external headers.
target_statment = f"filter('^(//|@//)',{target_statment})"

if file_flags:
file_path = file_flags[0]
if file_path.endswith(_get_files.source_extensions):
target_statment = f"inputs('{re.escape(file_path)}', {target_statment})"
found = False
target_statment_canidates = []
if file_flags[0].endswith(_get_files.source_extensions):
target_statment_canidates.append(f"inputs('{re.escape(file_path)}', {target_statment})")
else:
# For header files we try to find from hdrs and srcs to get the targets
# Since attr function can't query with full path, get the file name to query
fname = os.path.basename(file_path)
target_statment = f"let v = {target_statment} in attr(hdrs, '{fname}', $v) + attr(srcs, '{fname}', $v)"
aquery_args = [
'bazel',
'aquery',
# Aquery docs if you need em: https://docs.bazel.build/versions/master/aquery.html
# Aquery output proto reference: https://github.com/bazelbuild/bazel/blob/master/src/main/protobuf/analysis_v2.proto
# One bummer, not described in the docs, is that aquery filters over *all* actions for a given target, rather than just those that would be run by a build to produce a given output. This mostly isn't a problem, but can sometimes surface extra, unnecessary, misconfigured actions. Chris has emailed the authors to discuss and filed an issue so anyone reading this could track it: https://github.com/bazelbuild/bazel/issues/14156.
f"mnemonic('(Objc|Cpp)Compile', {target_statment})",
# We switched to jsonproto instead of proto because of https://github.com/bazelbuild/bazel/issues/13404. We could change back when fixed--reverting most of the commit that added this line and tweaking the build file to depend on the target in that issue. That said, it's kinda nice to be free of the dependency, unless (OPTIMNOTE) jsonproto becomes a performance bottleneck compated to binary protos.
'--output=jsonproto',
# We'll disable artifact output for efficiency, since it's large and we don't use them. Small win timewise, but dramatically less json output from aquery.
'--include_artifacts=false',
# Shush logging. Just for readability.
'--ui_event_filters=-info',
'--noshow_progress',
# Disable param files, which would obscure compile actions
# Mostly, people enable param files on Windows to avoid the relatively short command length limit.
# For more, see compiler_param_file in https://bazel.build/docs/windows
# They are, however, technically supported on other platforms/compilers.
# That's all well and good, but param files would prevent us from seeing compile actions before the param files had been generated by compilation.
# Since clangd has no such length limit, we'll disable param files for our aquery run.
'--features=-compiler_param_file',
# Disable layering_check during, because it causes large-scale dependence on generated module map files that prevent header extraction before their generation
# For more context, see https://github.com/hedronvision/bazel-compile-commands-extractor/issues/83
# If https://github.com/clangd/clangd/issues/123 is resolved and we're not doing header extraction, we could try removing this, checking that there aren't erroneous red squigglies squigglies before the module maps are generated.
# If Bazel starts supporting modules (https://github.com/bazelbuild/bazel/issues/4005), we'll probably need to make changes that subsume this.
'--features=-layering_check',
] + additional_flags

aquery_process = subprocess.run(
aquery_args,
capture_output=True,
encoding=locale.getpreferredencoding(),
check=False, # We explicitly ignore errors from `bazel aquery` and carry on.
)


# Filter aquery error messages to just those the user should care about.
missing_targets_warning: typing.Pattern[str] = re.compile(r'(\(\d+:\d+:\d+\) )?(\033\[[\d;]+m)?WARNING: (\033\[[\d;]+m)?Targets were missing from graph:') # Regex handles --show_timestamps and --color=yes. Could use "in" if we ever need more flexibility.
for line in aquery_process.stderr.splitlines():
# Shush known warnings about missing graph targets.
# The missing graph targets are not things we want to introspect anyway.
# Tracking issue https://github.com/bazelbuild/bazel/issues/13007.
if missing_targets_warning.match(line):
continue

print(line, file=sys.stderr)


# Parse proto output from aquery
try:
# object_hook -> SimpleNamespace allows object.member syntax, like a proto, while avoiding the protobuf dependency
parsed_aquery_output = json.loads(aquery_process.stdout, object_hook=lambda d: types.SimpleNamespace(**d))
except json.JSONDecodeError:
print("Bazel aquery failed. Command:", aquery_args, file=sys.stderr)
log_warning(f">>> Failed extracting commands for {target}\n Continuing gracefully...")
return

if not getattr(parsed_aquery_output, 'actions', None): # Unifies cases: No actions (or actions list is empty)
log_warning(f""">>> Bazel lists no applicable compile commands for {target}
If this is a header-only library, please instead specify a test or binary target that compiles it (search "header-only" in README.md).
Continuing gracefully...""")
return

yield from _convert_compile_commands(parsed_aquery_output)
target_statment_canidates.extend([
f"let v = {target_statment} in attr(hdrs, '{fname}', $v) + attr(srcs, '{fname}', $v)",
f"inputs('{re.escape(file_path)}', {target_statment})",
f'deps({target})',
])

for target_statment in target_statment_canidates:
compile_commands.extend( _get_commands(target_statment))
if any(command['file'].endswith(file_path) for command in reversed(compile_commands)):
found = True
break
if not found:
log_warning(f""">>> Bazel lists no applicable compile commands for {file_path} in {target}.
Continuing gracefully...""")

else:
if {exclude_external_sources}:
# For efficiency, have bazel filter out external targets (and therefore actions) before they even get turned into actions or serialized and sent to us. Note: this is a different mechanism than is used for excluding just external headers.
target_statment = f"filter('^(//|@//)',{target_statment})"
compile_commands.extend(_get_commands(target_statment))
if len(compile_commands) == 0:
log_warning(f""">>> Bazel lists no applicable compile commands for {target}
If this is a header-only library, please instead specify a test or binary target that compiles it (search "header-only" in README.md).
Continuing gracefully...""")

# Log clear completion messages
log_success(f">>> Finished extracting commands for {target}")
return compile_commands


def _ensure_external_workspaces_link_exists():
Expand Down

0 comments on commit 251bbb2

Please sign in to comment.