2 use measureme::{StringComponent, StringId};
3 use rustc_data_structures::fx::FxHashMap;
4 use rustc_data_structures::profiling::SelfProfiler;
5 use rustc_hir::def_id::{CrateNum, DefId, DefIndex, LocalDefId, LOCAL_CRATE};
6 use rustc_hir::definitions::DefPathData;
7 use rustc_middle::ty::{TyCtxt, WithOptConstParam};
8 use rustc_query_system::query::QueryCache;
12 pub(crate) struct QueryKeyStringCache {
13 def_id_cache: FxHashMap<DefId, StringId>,
16 impl QueryKeyStringCache {
17 fn new() -> QueryKeyStringCache {
18 QueryKeyStringCache { def_id_cache: Default::default() }
22 struct QueryKeyStringBuilder<'p, 'tcx> {
23 profiler: &'p SelfProfiler,
25 string_cache: &'p mut QueryKeyStringCache,
28 impl<'p, 'tcx> QueryKeyStringBuilder<'p, 'tcx> {
30 profiler: &'p SelfProfiler,
32 string_cache: &'p mut QueryKeyStringCache,
33 ) -> QueryKeyStringBuilder<'p, 'tcx> {
34 QueryKeyStringBuilder { profiler, tcx, string_cache }
37 // The current implementation is rather crude. In the future it might be a
38 // good idea to base this on `ty::print` in order to get nicer and more
39 // efficient query keys.
40 fn def_id_to_string_id(&mut self, def_id: DefId) -> StringId {
41 if let Some(&string_id) = self.string_cache.def_id_cache.get(&def_id) {
45 let def_key = self.tcx.def_key(def_id);
47 let (parent_string_id, start_index) = match def_key.parent {
48 Some(parent_index) => {
49 let parent_def_id = DefId { index: parent_index, krate: def_id.krate };
51 (self.def_id_to_string_id(parent_def_id), 0)
53 None => (StringId::INVALID, 2),
56 let dis_buffer = &mut [0u8; 16];
63 match def_key.disambiguated_data.data {
64 DefPathData::CrateRoot => {
65 crate_name = self.tcx.crate_name(def_id.krate);
66 name = crate_name.as_str();
71 other_name = other.to_string();
72 name = other_name.as_str();
73 if def_key.disambiguated_data.disambiguator == 0 {
77 write!(&mut dis_buffer[..], "[{}]", def_key.disambiguated_data.disambiguator)
79 let end_of_dis = dis_buffer.iter().position(|&c| c == b']').unwrap();
80 dis = std::str::from_utf8(&dis_buffer[..end_of_dis + 1]).unwrap();
87 StringComponent::Ref(parent_string_id),
88 StringComponent::Value("::"),
89 StringComponent::Value(name),
90 StringComponent::Value(dis),
93 let string_id = self.profiler.alloc_string(&components[start_index..end_index]);
95 self.string_cache.def_id_cache.insert(def_id, string_id);
101 trait IntoSelfProfilingString {
102 fn to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId;
105 // The default implementation of `IntoSelfProfilingString` just uses `Debug`
106 // which is slow and causes lots of duplication of string data.
107 // The specialized impls below take care of making the `DefId` case more
109 impl<T: Debug> IntoSelfProfilingString for T {
110 default fn to_self_profile_string(
112 builder: &mut QueryKeyStringBuilder<'_, '_>,
114 let s = format!("{:?}", self);
115 builder.profiler.alloc_string(&s[..])
119 impl<T: SpecIntoSelfProfilingString> IntoSelfProfilingString for T {
120 fn to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId {
121 self.spec_to_self_profile_string(builder)
125 #[rustc_specialization_trait]
126 trait SpecIntoSelfProfilingString: Debug {
127 fn spec_to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId;
130 impl SpecIntoSelfProfilingString for DefId {
131 fn spec_to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId {
132 builder.def_id_to_string_id(*self)
136 impl SpecIntoSelfProfilingString for CrateNum {
137 fn spec_to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId {
138 builder.def_id_to_string_id(self.as_def_id())
142 impl SpecIntoSelfProfilingString for DefIndex {
143 fn spec_to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId {
144 builder.def_id_to_string_id(DefId { krate: LOCAL_CRATE, index: *self })
148 impl SpecIntoSelfProfilingString for LocalDefId {
149 fn spec_to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId {
150 builder.def_id_to_string_id(DefId { krate: LOCAL_CRATE, index: self.local_def_index })
154 impl<T: SpecIntoSelfProfilingString> SpecIntoSelfProfilingString for WithOptConstParam<T> {
155 fn spec_to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId {
156 // We print `WithOptConstParam` values as tuples to make them shorter
157 // and more readable, without losing information:
159 // "WithOptConstParam { did: foo::bar, const_param_did: Some(foo::baz) }"
160 // becomes "(foo::bar, foo::baz)" and
161 // "WithOptConstParam { did: foo::bar, const_param_did: None }"
162 // becomes "(foo::bar, _)".
164 let did = StringComponent::Ref(self.did.to_self_profile_string(builder));
166 let const_param_did = if let Some(const_param_did) = self.const_param_did {
167 let const_param_did = builder.def_id_to_string_id(const_param_did);
168 StringComponent::Ref(const_param_did)
170 StringComponent::Value("_")
174 StringComponent::Value("("),
176 StringComponent::Value(", "),
178 StringComponent::Value(")"),
181 builder.profiler.alloc_string(&components[..])
185 impl<T0, T1> SpecIntoSelfProfilingString for (T0, T1)
187 T0: SpecIntoSelfProfilingString,
188 T1: SpecIntoSelfProfilingString,
190 fn spec_to_self_profile_string(&self, builder: &mut QueryKeyStringBuilder<'_, '_>) -> StringId {
191 let val0 = self.0.to_self_profile_string(builder);
192 let val1 = self.1.to_self_profile_string(builder);
195 StringComponent::Value("("),
196 StringComponent::Ref(val0),
197 StringComponent::Value(","),
198 StringComponent::Ref(val1),
199 StringComponent::Value(")"),
202 builder.profiler.alloc_string(components)
206 /// Allocate the self-profiling query strings for a single query cache. This
207 /// method is called from `alloc_self_profile_query_strings` which knows all
208 /// the queries via macro magic.
209 pub(crate) fn alloc_self_profile_query_strings_for_query_cache<'tcx, C>(
211 query_name: &'static str,
213 string_cache: &mut QueryKeyStringCache,
216 C::Key: Debug + Clone,
218 tcx.prof.with_profiler(|profiler| {
219 let event_id_builder = profiler.event_id_builder();
221 // Walk the entire query cache and allocate the appropriate
222 // string representations. Each cache entry is uniquely
223 // identified by its dep_node_index.
224 if profiler.query_key_recording_enabled() {
225 let mut query_string_builder = QueryKeyStringBuilder::new(profiler, tcx, string_cache);
227 let query_name = profiler.get_or_alloc_cached_string(query_name);
229 // Since building the string representation of query keys might
230 // need to invoke queries itself, we cannot keep the query caches
231 // locked while doing so. Instead we copy out the
232 // `(query_key, dep_node_index)` pairs and release the lock again.
233 let mut query_keys_and_indices = Vec::new();
234 query_cache.iter(&mut |k, _, i| query_keys_and_indices.push((k.clone(), i)));
236 // Now actually allocate the strings. If allocating the strings
237 // generates new entries in the query cache, we'll miss them but
238 // we don't actually care.
239 for (query_key, dep_node_index) in query_keys_and_indices {
240 // Translate the DepNodeIndex into a QueryInvocationId
241 let query_invocation_id = dep_node_index.into();
243 // Create the string version of the query-key
244 let query_key = query_key.to_self_profile_string(&mut query_string_builder);
245 let event_id = event_id_builder.from_label_and_arg(query_name, query_key);
247 // Doing this in bulk might be a good idea:
248 profiler.map_query_invocation_id_to_string(
250 event_id.to_string_id(),
254 // In this branch we don't allocate query keys
255 let query_name = profiler.get_or_alloc_cached_string(query_name);
256 let event_id = event_id_builder.from_label(query_name).to_string_id();
258 // FIXME(eddyb) make this O(1) by using a pre-cached query name `EventId`,
259 // instead of passing the `DepNodeIndex` to `finish_with_query_invocation_id`,
260 // when recording the event in the first place.
261 let mut query_invocation_ids = Vec::new();
262 query_cache.iter(&mut |_, _, i| {
263 query_invocation_ids.push(i.into());
266 profiler.bulk_map_query_invocation_id_to_single_string(
267 query_invocation_ids.into_iter(),
274 /// All self-profiling events generated by the query engine use
275 /// virtual `StringId`s for their `event_id`. This method makes all
276 /// those virtual `StringId`s point to actual strings.
278 /// If we are recording only summary data, the ids will point to
279 /// just the query names. If we are recording query keys too, we
280 /// allocate the corresponding strings here.
281 pub fn alloc_self_profile_query_strings(tcx: TyCtxt<'_>) {
282 if !tcx.prof.enabled() {
286 let mut string_cache = QueryKeyStringCache::new();
287 let queries = QueryCtxt::from_tcx(tcx);
289 for query in &queries.queries.query_structs {
290 (query.alloc_self_profile_query_strings)(tcx, &mut string_cache);