Skip to content

Commit 7e0261e

Browse files
borsbors
committed
Auto merge of #115735 - bjorn3:better_list_crate_metadata, r=wesleywiser
Extend rustc -Zls This makes it show a lot more things and thus a lot more useful.
2 parents 38a16ef + 026faca commit 7e0261e

File tree

9 files changed

+206
-31
lines changed

9 files changed

+206
-31
lines changed

‎compiler/rustc_driver_impl/src/lib.rs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -700,12 +700,14 @@ pub fn list_metadata(
700700
sess: &Session,
701701
metadata_loader: &dyn MetadataLoader,
702702
) -> Compilation {
703-
if sess.opts.unstable_opts.ls {
703+
let ls_kinds = &sess.opts.unstable_opts.ls;
704+
if !ls_kinds.is_empty() {
704705
match sess.io.input {
705706
Input::File(ref ifile) => {
706707
let path = &(*ifile);
707708
let mut v = Vec::new();
708-
locator::list_file_metadata(&sess.target, path, metadata_loader, &mut v).unwrap();
709+
locator::list_file_metadata(&sess.target, path, metadata_loader, &mut v, ls_kinds)
710+
.unwrap();
709711
safe_println!("{}", String::from_utf8(v).unwrap());
710712
}
711713
Input::Str { .. } => {

‎compiler/rustc_interface/src/tests.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -704,7 +704,7 @@ fn test_unstable_options_tracking_hash() {
704704
untracked!(keep_hygiene_data, true);
705705
untracked!(link_native_libraries, false);
706706
untracked!(llvm_time_trace, true);
707-
untracked!(ls, true);
707+
untracked!(ls, vec!["all".to_owned()]);
708708
untracked!(macro_backtrace, true);
709709
untracked!(meta_stats, true);
710710
untracked!(mir_include_spans, true);

‎compiler/rustc_metadata/src/locator.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -903,10 +903,11 @@ pub fn list_file_metadata(
903903
path: &Path,
904904
metadata_loader: &dyn MetadataLoader,
905905
out: &mut dyn Write,
906+
ls_kinds: &[String],
906907
) -> IoResult<()> {
907908
let flavor = get_flavor_from_path(path);
908909
match get_metadata_section(target, flavor, path, metadata_loader) {
909-
Ok(metadata) => metadata.list_crate_metadata(out),
910+
Ok(metadata) => metadata.list_crate_metadata(out, ls_kinds),
910911
Err(msg) => write!(out, "{msg}\n"),
911912
}
912913
}

‎compiler/rustc_metadata/src/rmeta/decoder.rs‎

Lines changed: 188 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -725,25 +725,196 @@ impl MetadataBlob {
725725
LazyValue::<CrateRoot>::from_position(NonZeroUsize::new(pos).unwrap()).decode(self)
726726
}
727727

728-
pub(crate) fn list_crate_metadata(&self, out: &mut dyn io::Write) -> io::Result<()> {
728+
pub(crate) fn list_crate_metadata(
729+
&self,
730+
out: &mut dyn io::Write,
731+
ls_kinds: &[String],
732+
) -> io::Result<()> {
729733
let root = self.get_root();
730-
writeln!(out, "Crate info:")?;
731-
writeln!(out, "name {}{}", root.name(), root.extra_filename)?;
732-
writeln!(out, "hash {} stable_crate_id {:?}", root.hash(), root.stable_crate_id)?;
733-
writeln!(out, "proc_macro {:?}", root.proc_macro_data.is_some())?;
734-
writeln!(out, "=External Dependencies=")?;
735-
736-
for (i, dep) in root.crate_deps.decode(self).enumerate() {
737-
let CrateDep { name, extra_filename, hash, host_hash, kind, is_private } = dep;
738-
let number = i + 1;
739-
740-
writeln!(
741-
out,
742-
"{number} {name}{extra_filename} hash {hash} host_hash {host_hash:?} kind {kind:?} {privacy}",
743-
privacy = if is_private { "private" } else { "public" }
744-
)?;
734+
735+
let all_ls_kinds = vec![
736+
"root".to_owned(),
737+
"lang_items".to_owned(),
738+
"features".to_owned(),
739+
"items".to_owned(),
740+
];
741+
let ls_kinds = if ls_kinds.contains(&"all".to_owned()) { &all_ls_kinds } else { ls_kinds };
742+
743+
for kind in ls_kinds {
744+
match &**kind {
745+
"root" => {
746+
writeln!(out, "Crate info:")?;
747+
writeln!(out, "name {}{}", root.name(), root.extra_filename)?;
748+
writeln!(
749+
out,
750+
"hash {} stable_crate_id {:?}",
751+
root.hash(),
752+
root.stable_crate_id
753+
)?;
754+
writeln!(out, "proc_macro {:?}", root.proc_macro_data.is_some())?;
755+
writeln!(out, "triple {}", root.header.triple.triple())?;
756+
writeln!(out, "edition {}", root.edition)?;
757+
writeln!(out, "symbol_mangling_version {:?}", root.symbol_mangling_version)?;
758+
writeln!(
759+
out,
760+
"required_panic_strategy {:?} panic_in_drop_strategy {:?}",
761+
root.required_panic_strategy, root.panic_in_drop_strategy
762+
)?;
763+
writeln!(
764+
out,
765+
"has_global_allocator {} has_alloc_error_handler {} has_panic_handler {} has_default_lib_allocator {}",
766+
root.has_global_allocator,
767+
root.has_alloc_error_handler,
768+
root.has_panic_handler,
769+
root.has_default_lib_allocator
770+
)?;
771+
writeln!(
772+
out,
773+
"compiler_builtins {} needs_allocator {} needs_panic_runtime {} no_builtins {} panic_runtime {} profiler_runtime {}",
774+
root.compiler_builtins,
775+
root.needs_allocator,
776+
root.needs_panic_runtime,
777+
root.no_builtins,
778+
root.panic_runtime,
779+
root.profiler_runtime
780+
)?;
781+
782+
writeln!(out, "=External Dependencies=")?;
783+
let dylib_dependency_formats =
784+
root.dylib_dependency_formats.decode(self).collect::<Vec<_>>();
785+
for (i, dep) in root.crate_deps.decode(self).enumerate() {
786+
let CrateDep { name, extra_filename, hash, host_hash, kind, is_private } =
787+
dep;
788+
let number = i + 1;
789+
790+
writeln!(
791+
out,
792+
"{number} {name}{extra_filename} hash {hash} host_hash {host_hash:?} kind {kind:?} {privacy}{linkage}",
793+
privacy = if is_private { "private" } else { "public" },
794+
linkage = if dylib_dependency_formats.is_empty() {
795+
String::new()
796+
} else {
797+
format!(" linkage {:?}", dylib_dependency_formats[i])
798+
}
799+
)?;
800+
}
801+
write!(out, "\n")?;
802+
}
803+
804+
"lang_items" => {
805+
writeln!(out, "=Lang items=")?;
806+
for (id, lang_item) in root.lang_items.decode(self) {
807+
writeln!(
808+
out,
809+
"{} = crate{}",
810+
lang_item.name(),
811+
DefPath::make(LOCAL_CRATE, id, |parent| root
812+
.tables
813+
.def_keys
814+
.get(self, parent)
815+
.unwrap()
816+
.decode(self))
817+
.to_string_no_crate_verbose()
818+
)?;
819+
}
820+
for lang_item in root.lang_items_missing.decode(self) {
821+
writeln!(out, "{} = <missing>", lang_item.name())?;
822+
}
823+
write!(out, "\n")?;
824+
}
825+
826+
"features" => {
827+
writeln!(out, "=Lib features=")?;
828+
for (feature, since) in root.lib_features.decode(self) {
829+
writeln!(
830+
out,
831+
"{}{}",
832+
feature,
833+
if let Some(since) = since {
834+
format!(" since {since}")
835+
} else {
836+
String::new()
837+
}
838+
)?;
839+
}
840+
write!(out, "\n")?;
841+
}
842+
843+
"items" => {
844+
writeln!(out, "=Items=")?;
845+
846+
fn print_item(
847+
blob: &MetadataBlob,
848+
out: &mut dyn io::Write,
849+
item: DefIndex,
850+
indent: usize,
851+
) -> io::Result<()> {
852+
let root = blob.get_root();
853+
854+
let def_kind = root.tables.opt_def_kind.get(blob, item).unwrap();
855+
let def_key = root.tables.def_keys.get(blob, item).unwrap().decode(blob);
856+
let def_name = if item == CRATE_DEF_INDEX {
857+
rustc_span::symbol::kw::Crate
858+
} else {
859+
def_key
860+
.disambiguated_data
861+
.data
862+
.get_opt_name()
863+
.unwrap_or_else(|| Symbol::intern("???"))
864+
};
865+
let visibility =
866+
root.tables.visibility.get(blob, item).unwrap().decode(blob).map_id(
867+
|index| {
868+
format!(
869+
"crate{}",
870+
DefPath::make(LOCAL_CRATE, index, |parent| root
871+
.tables
872+
.def_keys
873+
.get(blob, parent)
874+
.unwrap()
875+
.decode(blob))
876+
.to_string_no_crate_verbose()
877+
)
878+
},
879+
);
880+
write!(
881+
out,
882+
"{nil: <indent$}{:?} {:?} {} {{",
883+
visibility,
884+
def_kind,
885+
def_name,
886+
nil = "",
887+
)?;
888+
889+
if let Some(children) =
890+
root.tables.module_children_non_reexports.get(blob, item)
891+
{
892+
write!(out, "\n")?;
893+
for child in children.decode(blob) {
894+
print_item(blob, out, child, indent + 4)?;
895+
}
896+
writeln!(out, "{nil: <indent$}}}", nil = "")?;
897+
} else {
898+
writeln!(out, "}}")?;
899+
}
900+
901+
Ok(())
902+
}
903+
904+
print_item(self, out, CRATE_DEF_INDEX, 0)?;
905+
906+
write!(out, "\n")?;
907+
}
908+
909+
_ => {
910+
writeln!(
911+
out,
912+
"unknown -Zls kind. allowed values are: all, root, lang_items, features, items"
913+
)?;
914+
}
915+
}
745916
}
746-
write!(out, "\n")?;
917+
747918
Ok(())
748919
}
749920
}

‎compiler/rustc_session/src/config.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1086,7 +1086,7 @@ impl Options {
10861086
/// Returns `true` if there will be an output file generated.
10871087
pub fn will_create_output_file(&self) -> bool {
10881088
!self.unstable_opts.parse_only && // The file is just being parsed
1089-
!self.unstable_opts.ls // The file is just being queried
1089+
self.unstable_opts.ls.is_empty() // The file is just being queried
10901090
}
10911091

10921092
#[inline]

‎compiler/rustc_session/src/options.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1594,8 +1594,9 @@ options! {
15941594
"what location details should be tracked when using caller_location, either \
15951595
`none`, or a comma separated list of location details, for which \
15961596
valid options are `file`, `line`, and `column` (default: `file,line,column`)"),
1597-
ls: bool = (false, parse_bool, [UNTRACKED],
1598-
"list the symbols defined by a library crate (default: no)"),
1597+
ls: Vec<String> = (Vec::new(), parse_list, [UNTRACKED],
1598+
"decode and print various parts of the crate metadata for a library crate \
1599+
(space separated)"),
15991600
macro_backtrace: bool = (false, parse_bool, [UNTRACKED],
16001601
"show macro backtraces (default: no)"),
16011602
maximal_hir_to_mir_coverage: bool = (false, parse_bool, [TRACKED],

‎tests/run-make/emit-path-unhashed/Makefile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ OUT=$(TMPDIR)/emit
55
# --emit KIND=PATH should not affect crate hash vs --emit KIND
66
all: $(OUT)/a/libfoo.rlib $(OUT)/b/libfoo.rlib $(OUT)/c/libfoo.rlib \
77
$(TMPDIR)/libfoo.rlib
8-
$(RUSTC) -Zls $(TMPDIR)/libfoo.rlib > $(TMPDIR)/base.txt
9-
$(RUSTC) -Zls $(OUT)/a/libfoo.rlib > $(TMPDIR)/a.txt
10-
$(RUSTC) -Zls $(OUT)/b/libfoo.rlib > $(TMPDIR)/b.txt
11-
$(RUSTC) -Zls $(OUT)/c/libfoo.rlib > $(TMPDIR)/c.txt
8+
$(RUSTC) -Zls=root $(TMPDIR)/libfoo.rlib > $(TMPDIR)/base.txt
9+
$(RUSTC) -Zls=root $(OUT)/a/libfoo.rlib > $(TMPDIR)/a.txt
10+
$(RUSTC) -Zls=root $(OUT)/b/libfoo.rlib > $(TMPDIR)/b.txt
11+
$(RUSTC) -Zls=root $(OUT)/c/libfoo.rlib > $(TMPDIR)/c.txt
1212

1313
diff $(TMPDIR)/base.txt $(TMPDIR)/a.txt
1414
diff $(TMPDIR)/base.txt $(TMPDIR)/b.txt

‎tests/run-make/ls-metadata/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ include ../tools.mk
33

44
all:
55
$(RUSTC) foo.rs
6-
$(RUSTC) -Z ls $(TMPDIR)/foo
6+
$(RUSTC) -Z ls=root $(TMPDIR)/foo
77
touch $(TMPDIR)/bar
8-
$(RUSTC) -Z ls $(TMPDIR)/bar
8+
$(RUSTC) -Z ls=root $(TMPDIR)/bar

‎tests/run-make/output-filename-overwrites-input/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ all:
88
cp bar.rs $(TMPDIR)/bar.rlib
99
$(RUSTC) $(TMPDIR)/bar.rlib -o $(TMPDIR)/bar.rlib 2>&1 \
1010
| $(CGREP) -e "the input file \".*bar.rlib\" would be overwritten by the generated executable"
11-
$(RUSTC) foo.rs 2>&1 && $(RUSTC) -Z ls $(TMPDIR)/foo 2>&1
11+
$(RUSTC) foo.rs 2>&1 && $(RUSTC) -Z ls=root $(TMPDIR)/foo 2>&1
1212
cp foo.rs $(TMPDIR)/foo.rs
1313
$(RUSTC) $(TMPDIR)/foo.rs -o $(TMPDIR)/foo.rs 2>&1 \
1414
| $(CGREP) -e "the input file \".*foo.rs\" would be overwritten by the generated executable"

0 commit comments

Comments
 (0)