From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-qt1-x82d.google.com (mail-qt1-x82d.google.com [IPv6:2607:f8b0:4864:20::82d]) by sourceware.org (Postfix) with ESMTPS id 437003858291 for ; Wed, 9 Aug 2023 22:14:50 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 437003858291 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-qt1-x82d.google.com with SMTP id d75a77b69052e-40e268fe7ddso1375241cf.3 for ; Wed, 09 Aug 2023 15:14:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1691619289; x=1692224089; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=OuklhMdsl6Yx0ZdIcIAJtRoH4AC2hG9ic11rTVxcmdM=; b=aZAWfFH5k/Hmb3iRNJybQDNMQGfzjcAiOBAR3u+BXDr/Zuj7A5KLyH8BL/DLakTKDe CmrQheYh4SaTrDtHNwUz0TZi2tgWsiMifQLcTTUleWD5IGI9yJ+0OXMEqQ8PFdeCkakR eEosgkumxBVRwiPIElrpDInJIkGkRGyv80bU1Q6FiZbtr4g/9DPZf2/CoST57hUco+z9 bJYqQN2/I8JWZXnFOY6MVCKK9BHUsuY+99+CqfGkB4QAyMIEgk0Lj3R1lhcZTSL4T/DQ FxZQJC90wfC5ezukG3I2pP256+o7L1t0vVLYhujeIJba73K2d+EjLqEe3vchZTvq6uTJ scWw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1691619289; x=1692224089; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=OuklhMdsl6Yx0ZdIcIAJtRoH4AC2hG9ic11rTVxcmdM=; b=JgO+GPBtODcqp7+9sPa99QX0lGBoGci8h4xolXVC/7klcnEd8R9n/GJpR5yCH2rN9o 4ClosLNQwgbO7Iv+ZBZP0Db5gCEb1puOhpeDb/Le+zInSshPPIBNTT+AqJIxez2Unk0u L13Nz/VBrZf+isXWc9THKh3HhIw1a+EztZ1e0mFzjIO2HeQNKC4o/llU7vIO8s3NPnM4 Vyav+mL6fSrcWf7xFQlPK+iy2bd/XyHs7jaIWyvwdpCI4dKIHK12i+hw6mU7FNYv0zob wm09bGcZVgtl8uTvLtWetCs5UL3E2AbNB5azBxhZafKV7nFf8ECe2SzukaIBF55pnQP7 5Tpg== X-Gm-Message-State: AOJu0YyD3EYnV7YYLthnhNimEFE8YISrXhQLT5xGc6WhxKYaFRehqT09 qR8DsKNwGdnUfDR6QLYuEaFKM5Fnv3Q= X-Google-Smtp-Source: AGHT+IHyRTjNPbpfE5mxtvbM6+FPkMPjHblcwuQ2iWwB/7ln//b1XEITgdolJyd9+4VYOm+Abfk/kg== X-Received: by 2002:a05:622a:1116:b0:403:ef0f:2284 with SMTP id e22-20020a05622a111600b00403ef0f2284mr1029935qty.10.1691619289387; Wed, 09 Aug 2023 15:14:49 -0700 (PDT) Received: from localhost.localdomain (96-67-140-173-static.hfc.comcastbusiness.net. [96.67.140.173]) by smtp.gmail.com with ESMTPSA id ce11-20020a05622a41cb00b0040fef71dc1esm46334qtb.10.2023.08.09.15.14.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 09 Aug 2023 15:14:48 -0700 (PDT) From: Lewis Hyatt To: gcc-patches@gcc.gnu.org Cc: David Malcolm , Lewis Hyatt Subject: [PATCH v4 4/8] diagnostics: Support obtaining source code lines from generated data buffers Date: Wed, 9 Aug 2023 18:14:10 -0400 Message-Id: <20230809221414.2849878-5-lhyatt@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230809221414.2849878-1-lhyatt@gmail.com> References: <20230809221414.2849878-1-lhyatt@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-3038.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,GIT_PATCH_0,RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS,TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: This patch enhances location_get_source_line(), which is the primary interface provided by the diagnostics infrastructure to obtain the line of source code corresponding to a given location, so that it understands generated data locations in addition to normal file-based locations. This involves changing the argument to location_get_source_line() from a plain file name, to a source_id object that can represent either type of location. gcc/ChangeLog: * input.cc (class data_cache_slot): New class. (file_cache::lookup_data): New function. (diagnostics_file_cache_forcibly_evict_data): New function. (file_cache::forcibly_evict_data): New function. (file_cache::evicted_cache_tab_entry): Generalize (via a template) to work for both file_cache_slot and data_cache_slot. (file_cache::add_file): Adapt for new interface to evicted_cache_tab_entry. (file_cache::add_data): New function. (data_cache_slot::create): New function. (file_cache::file_cache): Support the new m_data_slots member. (file_cache::~file_cache): Likewise. (file_cache::lookup_or_add_data): New function. (file_cache::lookup_or_add): New function that calls either lookup_or_add_data or lookup_or_add_file as appropriate. (location_get_source_line): Change the FILE_PATH argument to a source_id SRC, and use it to support obtaining source lines from generated data as well as from files. (location_compute_display_column): Support generated data using the new features of location_get_source_line. (dump_location_info): Likewise. * input.h (location_get_source_line): Adjust prototype. Add a new convenience overload taking an expanded_location. (class cache_data_source): Declare. (class data_cache_slot): Declare. (class file_cache): Declare new members. (diagnostics_file_cache_forcibly_evict_data): Declare. --- gcc/input.cc | 171 ++++++++++++++++++++++++++++++++++++++++----------- gcc/input.h | 23 +++++-- 2 files changed, 153 insertions(+), 41 deletions(-) diff --git a/gcc/input.cc b/gcc/input.cc index 9377020b460..790279d4273 100644 --- a/gcc/input.cc +++ b/gcc/input.cc @@ -207,6 +207,28 @@ private: void maybe_grow (); }; +/* This is the implementation of cache_data_source for generated + data that is already in memory. */ +class data_cache_slot final : public cache_data_source +{ +public: + void create (const char *data, unsigned int data_len, + unsigned int highest_use_count); + bool represents_data (const char *data, unsigned int) const + { + /* We can just use pointer equality here since the generated data lives in + memory in one persistent place. It isn't anticipated there would be + several generated data buffers with the same content, so we don't mind + that in such a case we will store it twice. */ + return m_data_begin == data; + } + +protected: + /* In contrast to file_cache_slot, we do not own a buffer. The buffer + passed to create() needs to outlive this object. */ + bool get_more_data () override { return false; } +}; + /* Current position in real source file. */ location_t input_location = UNKNOWN_LOCATION; @@ -382,6 +404,21 @@ file_cache::lookup_file (const char *file_path) return r; } +data_cache_slot * +file_cache::lookup_data (const char *data, unsigned int data_len) +{ + for (unsigned int i = 0; i != num_file_slots; ++i) + { + const auto slot = m_data_slots + i; + if (slot->represents_data (data, data_len)) + { + slot->inc_use_count (); + return slot; + } + } + return nullptr; +} + /* Purge any mention of FILENAME from the cache of files used for printing source code. For use in selftests when working with tempfiles. */ @@ -397,6 +434,15 @@ diagnostics_file_cache_forcibly_evict_file (const char *file_path) global_dc->m_file_cache->forcibly_evict_file (file_path); } +void +diagnostics_file_cache_forcibly_evict_data (const char *data, + unsigned int data_len) +{ + if (!global_dc->m_file_cache) + return; + global_dc->m_file_cache->forcibly_evict_data (data, data_len); +} + void file_cache::forcibly_evict_file (const char *file_path) { @@ -410,36 +456,36 @@ file_cache::forcibly_evict_file (const char *file_path) r->reset (); } +void +file_cache::forcibly_evict_data (const char *data, unsigned int data_len) +{ + if (auto r = lookup_data (data, data_len)) + r->reset (); +} + /* Return the cache that has been less used, recently, or the first empty one. If HIGHEST_USE_COUNT is non-null, *HIGHEST_USE_COUNT is set to the highest use count of the entries in the cache table. */ -file_cache_slot* -file_cache::evicted_cache_tab_entry (unsigned *highest_use_count) +template +Slot * +file_cache::evicted_cache_tab_entry (Slot *slots, + unsigned int *highest_use_count) { - diagnostic_file_cache_init (); - - file_cache_slot *to_evict = &m_file_slots[0]; + auto to_evict = &slots[0]; unsigned huc = to_evict->get_use_count (); for (unsigned i = 1; i < num_file_slots; ++i) { - file_cache_slot *c = &m_file_slots[i]; - bool c_is_empty = (c->get_file_path () == NULL); - + auto c = &slots[i]; if (c->get_use_count () < to_evict->get_use_count () - || (to_evict->get_file_path () && c_is_empty)) + || (!to_evict->unused () && c->unused ())) /* We evict C because it's either an entry with a lower use count or one that is empty. */ to_evict = c; if (huc < c->get_use_count ()) huc = c->get_use_count (); - - if (c_is_empty) - /* We've reached the end of the cache; subsequent elements are - all empty. */ - break; } if (highest_use_count) @@ -463,12 +509,23 @@ file_cache::add_file (const char *file_path) return NULL; unsigned highest_use_count = 0; - file_cache_slot *r = evicted_cache_tab_entry (&highest_use_count); + file_cache_slot *r = evicted_cache_tab_entry (m_file_slots, + &highest_use_count); if (!r->create (in_context, file_path, fp, highest_use_count)) return NULL; return r; } +data_cache_slot * +file_cache::add_data (const char *data, unsigned int data_len) +{ + unsigned int highest_use_count = 0; + data_cache_slot *r = evicted_cache_tab_entry (m_data_slots, + &highest_use_count); + r->create (data, data_len, highest_use_count); + return r; +} + /* Get a borrowed char_span to the full content of this file as decoded according to the input charset, encoded as UTF-8. */ @@ -525,10 +582,22 @@ file_cache_slot::create (const file_cache::input_context &in_context, return true; } +void +data_cache_slot::create (const char *data, unsigned int data_len, + unsigned int highest_use_count) +{ + reset (); + on_create (highest_use_count + 1, + total_lines_num (source_id {data, data_len})); + m_data_begin = data; + m_data_end = data + data_len; +} + /* file_cache's ctor. */ file_cache::file_cache () -: m_file_slots (new file_cache_slot[num_file_slots]) + : m_file_slots (new file_cache_slot[num_file_slots]), + m_data_slots (new data_cache_slot[num_file_slots]) { initialize_input_context (nullptr, false); } @@ -537,6 +606,7 @@ file_cache::file_cache () file_cache::~file_cache () { + delete[] m_data_slots; delete[] m_file_slots; } @@ -554,6 +624,24 @@ file_cache::lookup_or_add_file (const char *file_path) return r; } +data_cache_slot * +file_cache::lookup_or_add_data (const char *data, unsigned int data_len) +{ + data_cache_slot *r = lookup_data (data, data_len); + if (!r) + r = add_data (data, data_len); + return r; +} + +cache_data_source * +file_cache::lookup_or_add (source_id src) +{ + if (src.is_buffer ()) + return lookup_or_add_data (src.get_filename_or_buffer (), + src.get_buffer_len ()); + return src ? lookup_or_add_file (src.get_filename_or_buffer ()) : nullptr; +} + cache_data_source::cache_data_source () : m_data_begin (nullptr), m_data_end (nullptr), m_use_count (0), @@ -912,26 +1000,22 @@ cache_data_source::read_line_num (size_t line_num, If the function fails, a NULL char_span is returned. */ char_span -location_get_source_line (const char *file_path, int line) +location_get_source_line (source_id src, int line) { - const char *buffer = NULL; - ssize_t len; - - if (line == 0) - return char_span (NULL, 0); - - if (file_path == NULL) - return char_span (NULL, 0); + const char_span fail (nullptr, 0); + if (!src || line <= 0) + return fail; diagnostic_file_cache_init (); + const auto c = global_dc->m_file_cache->lookup_or_add (src); + if (!c) + return fail; - file_cache_slot *c = global_dc->m_file_cache->lookup_or_add_file (file_path); - if (c == NULL) - return char_span (NULL, 0); - + const char *buffer = NULL; + ssize_t len; bool read = c->read_line_num (line, &buffer, &len); if (!read) - return char_span (NULL, 0); + return fail; return char_span (buffer, len); } @@ -1193,9 +1277,9 @@ int location_compute_display_column (expanded_location exploc, const cpp_char_column_policy &policy) { - if (!(exploc.file && *exploc.file && exploc.line && exploc.column)) + if (!(exploc.src && exploc.line && exploc.column)) return exploc.column; - char_span line = location_get_source_line (exploc.file, exploc.line); + char_span line = location_get_source_line (exploc); /* If line is NULL, this function returns exploc.column which is the desired fallback. */ return cpp_byte_column_to_display_column (line.get_buffer (), line.length (), @@ -1425,13 +1509,26 @@ dump_location_info (FILE *stream) { /* Beginning of a new source line: draw the line. */ - char_span line_text = location_get_source_line (exploc.file, - exploc.line); + char_span line_text = location_get_source_line (exploc); if (!line_text) break; + + const char *fn1, *fn2; + if (exploc.src.is_buffer ()) + { + fn1 = ORDINARY_MAP_CONTAINING_FILE_NAME (line_table, map); + fn2 = special_fname_generated (); + } + else + { + fn1 = exploc.file; + fn2 = ""; + } + fprintf (stream, - "%s:%3i|loc:%5i|%.*s\n", - exploc.file, exploc.line, + "%s%s:%3i|loc:%5i|%.*s\n", + fn1, fn2, + exploc.line, loc, (int)line_text.length (), line_text.get_buffer ()); @@ -1450,7 +1547,7 @@ dump_location_info (FILE *stream) if (len_loc < 5) len_loc = 5; - int indent = 6 + strlen (exploc.file) + len_lnum + len_loc; + int indent = 6 + strlen (fn1) + strlen (fn2) + len_lnum + len_loc; /* Thousands. */ if (end_location > 999) diff --git a/gcc/input.h b/gcc/input.h index 5c578f1a9de..d30673f1089 100644 --- a/gcc/input.h +++ b/gcc/input.h @@ -114,15 +114,21 @@ class char_span size_t m_n_elts; }; -extern char_span location_get_source_line (const char *file_path, int line); +extern char_span location_get_source_line (source_id src, int line); +inline char_span location_get_source_line (expanded_location exploc) +{ + return location_get_source_line (exploc.src, exploc.line); +} extern char *get_source_text_between (location_t, location_t); extern char_span get_source_file_content (const char *file_path); extern bool location_missing_trailing_newline (const char *file_path); -/* Forward decl of slot within file_cache, so that the definition doesn't +/* Forward decl of slots within file_cache, so that the definition doesn't need to be in this header. */ +class cache_data_source; class file_cache_slot; +class data_cache_slot; /* A cache of source files for use when emitting diagnostics (and in a few places in the C/C++ frontends). @@ -140,7 +146,10 @@ class file_cache ~file_cache (); file_cache_slot *lookup_or_add_file (const char *file_path); + data_cache_slot *lookup_or_add_data (const char *data, unsigned int data_len); + cache_data_source *lookup_or_add (source_id src); void forcibly_evict_file (const char *file_path); + void forcibly_evict_data (const char *data, unsigned int data_len); /* See comments in diagnostic.h about the input conversion context. */ struct input_context @@ -152,13 +161,17 @@ class file_cache bool should_skip_bom); private: - file_cache_slot *evicted_cache_tab_entry (unsigned *highest_use_count); + template + Slot *evicted_cache_tab_entry (Slot *slots, unsigned int *highest_use_count); + file_cache_slot *add_file (const char *file_path); + data_cache_slot *add_data (const char *data, unsigned int data_len); file_cache_slot *lookup_file (const char *file_path); + data_cache_slot *lookup_data (const char *data, unsigned int data_len); - private: static const size_t num_file_slots = 16; file_cache_slot *m_file_slots; + data_cache_slot *m_data_slots; input_context in_context; }; @@ -256,6 +269,8 @@ void dump_location_info (FILE *stream); void diagnostics_file_cache_fini (void); void diagnostics_file_cache_forcibly_evict_file (const char *file_path); +void diagnostics_file_cache_forcibly_evict_data (const char *data, + unsigned int data_len); class GTY(()) string_concat {