https://gcc.gnu.org/bugzilla/show_bug.cgi?id=108900

--- Comment #21 from GCC Commits <cvs-commit at gcc dot gnu.org> ---
The releases/gcc-14 branch has been updated by Jakub Jelinek
<ja...@gcc.gnu.org>:

https://gcc.gnu.org/g:8cbe033a8a88fe6437cc5d343ae0ddf8dd3455c8

commit r14-11749-g8cbe033a8a88fe6437cc5d343ae0ddf8dd3455c8
Author: Jakub Jelinek <ja...@redhat.com>
Date:   Thu May 8 11:14:24 2025 +0200

    libcpp: Further fixes for incorrect line numbers in large files [PR120061]

    The backport of the PR108900 fix to 14 branch broke building chromium
    because static_assert (__LINE__ == expected_line_number, ""); now triggers
    as the __LINE__ values are off by one.
    This isn't the case on the trunk and 15 branch because we've switched
    to 64-bit location_t and so one actually needs far longer header files
    to trigger it.
    https://gcc.gnu.org/bugzilla/show_bug.cgi?id=120061#c11
    https://gcc.gnu.org/bugzilla/show_bug.cgi?id=120061#c12
    contain (large) testcases in patch form which show on the 14 branch
    that the first one used to fail before the PR108900 backport and now
    works correctly, while the second one attempts to match the chromium
    behavior and it used to pass before the PR108900 backport and now it
    FAILs.
    The two testcases show rare problematic cases, because
    do_include_common -> parse_include -> check_eol -> check_eol_1 ->
    cpp_get_token_1 -> _cpp_lex_token -> _cpp_lex_direct -> linemap_line_start
    triggers there
          /* Allocate the new line_map.  However, if the current map only has a
             single line we can sometimes just increase its column_bits
instead. */
          if (line_delta < 0
              || last_line != ORDINARY_MAP_STARTING_LINE_NUMBER (map)
              || SOURCE_COLUMN (map, highest) >= (1U << (column_bits -
range_bits))
              || ( /* We can't reuse the map if the line offset is sufficiently
                      large to cause overflow when computing location_t values.
 */
                  (to_line - ORDINARY_MAP_STARTING_LINE_NUMBER (map))
                  >= (((uint64_t) 1)
                      << (CHAR_BIT * sizeof (linenum_type) - column_bits)))
              || range_bits < map->m_range_bits)
            map = linemap_check_ordinary
                    (const_cast <line_map *>
                      (linemap_add (set, LC_RENAME,
                                    ORDINARY_MAP_IN_SYSTEM_HEADER_P (map),
                                    ORDINARY_MAP_FILE_NAME (map),
                                    to_line)));
    and so creates a new ordinary map on the line right after the
    (problematic) #include line.
    Now, in the spot that r14-11679-g8a884140c2bcb7 patched,
    pfile->line_table->highest_location in all 3 tests (also
    https://gcc.gnu.org/bugzilla/show_bug.cgi?id=120061#c13
    ) is before the decrement the start of the line after the #include line and
so
    the decrement is really desirable in that case to put highest_location
    [jakub@tucnak gcc-15]$ git log -1 --format=%B
r15-9638-gbfcb5da69a41f7a5e41faab39b763d9d7c8bd2ea | cat
    libcpp: Further fixes for incorrect line numbers in large files [PR120061]

    The backport of the PR108900 fix to 14 branch broke building chromium
    because static_assert (__LINE__ == expected_line_number, ""); now triggers
    as the __LINE__ values are off by one.
    This isn't the case on the trunk and 15 branch because we've switched
    to 64-bit location_t and so one actually needs far longer header files
    to trigger it.
    https://gcc.gnu.org/bugzilla/show_bug.cgi?id=120061#c11
    https://gcc.gnu.org/bugzilla/show_bug.cgi?id=120061#c12
    contain (large) testcases in patch form which show on the 14 branch
    that the first one used to fail before the PR108900 backport and now
    works correctly, while the second one attempts to match the chromium
    behavior and it used to pass before the PR108900 backport and now it
    FAILs.
    The two testcases show rare problematic cases, because
    do_include_common -> parse_include -> check_eol -> check_eol_1 ->
    cpp_get_token_1 -> _cpp_lex_token -> _cpp_lex_direct -> linemap_line_start
    triggers there
          /* Allocate the new line_map.  However, if the current map only has a
             single line we can sometimes just increase its column_bits
instead. */
          if (line_delta < 0
              || last_line != ORDINARY_MAP_STARTING_LINE_NUMBER (map)
              || SOURCE_COLUMN (map, highest) >= (1U << (column_bits -
range_bits))
              || ( /* We can't reuse the map if the line offset is sufficiently
                      large to cause overflow when computing location_t values.
 */
                  (to_line - ORDINARY_MAP_STARTING_LINE_NUMBER (map))
                  >= (((uint64_t) 1)
                      << (CHAR_BIT * sizeof (linenum_type) - column_bits)))
              || range_bits < map->m_range_bits)
            map = linemap_check_ordinary
                    (const_cast <line_map *>
                      (linemap_add (set, LC_RENAME,
                                    ORDINARY_MAP_IN_SYSTEM_HEADER_P (map),
                                    ORDINARY_MAP_FILE_NAME (map),
                                    to_line)));
    and so creates a new ordinary map on the line right after the
    (problematic) #include line.
    Now, in the spot that r14-11679-g8a884140c2bcb7 patched,
    pfile->line_table->highest_location in all 3 tests (also
    https://gcc.gnu.org/bugzilla/show_bug.cgi?id=120061#c13
    ) is before the decrement the start of the line after the #include line and
so
    the decrement is really desirable in that case to put highest_location
    somewhere on the line where the #include actually is.
    But at the same time it is also undesirable, because if we do decrement it,
    then linemap_add LC_ENTER called from _cpp_do_file_change will then
      /* Generate a start_location above the current highest_location.
         If possible, make the low range bits be zero.  */
      location_t start_location = set->highest_location + 1;
      unsigned range_bits = 0;
      if (start_location < LINE_MAP_MAX_LOCATION_WITH_COLS)
        range_bits = set->default_range_bits;
      start_location += (1 << range_bits) - 1;
      start_location &=  ~((1 << range_bits) - 1);

      linemap_assert (!LINEMAPS_ORDINARY_USED (set)
                      || (start_location
                          >= MAP_START_LOCATION (LINEMAPS_LAST_ORDINARY_MAP
(set))));
    and we can end up with the new LC_ENTER ordinary map having the same
    start_location as the preceding LC_RENAME one.
    Next thing that happens is computation of included_from:
      if (reason == LC_ENTER)
        {
          if (set->depth == 0)
            map->included_from = 0;
          else
            /* The location of the end of the just-closed map.  */
            map->included_from
              = (((map[0].start_location - 1 - map[-1].start_location)
                  & ~((1 << map[-1].m_column_and_range_bits) - 1))
                 + map[-1].start_location);
    The normal case (e.g. with the testcase included at the start of this
comment) is
    that map[-1] starts somewhere earlier and so map->included_from computation
above
    nicely computes location_t which expands to the start of the #include line.
    With r14-11679 reverted, for #c11 as well as #c12
    map[0].start_location == map[-1].start_location above, and so it is
    ((location_t) -1 & ~((1 << map[-1].m_column_and_range_bits) - 1)))
    + map[-1].start_location,
    which happens to be start of the #include line.
    For #c11 map[0].start_location is 0x500003a0 and map[-1] has
    m_column_and_range_bits 7 and map[-2] has m_column_and_range_bits 12 and
    map[0].included_from is set to 0x50000320.
    For #c12 map[0].start_location is 0x606c0402 and map[-2].start_location is
    0x606c0400 and m_column_and_range_bits is 0 for all 3 maps.
    map[0].included_from is set to 0x606c0401.
    The last important part is again in linemap_add when doing LC_LEAVE:
          /* (MAP - 1) points to the map we are leaving. The
             map from which (MAP - 1) got included should be the map
             that comes right before MAP in the same file.  */
          from = linemap_included_from_linemap (set, map - 1);

          /* A TO_FILE of NULL is special - we use the natural values.  */
          if (to_file == NULL)
            {
              to_file = ORDINARY_MAP_FILE_NAME (from);
              to_line = SOURCE_LINE (from, from[1].start_location);
              sysp = ORDINARY_MAP_IN_SYSTEM_HEADER_P (from);
            }
    Here it wants to compute the right to_line which ought to be the line after
    the #include directive.
    On the #c11 testcase that doesn't work correctly though, because
    map[-1].included_from is 0x50000320, from[0] for that is LC_ENTER with
    start_location 0x4080 and m_column_and_range_bits 12 but note that we've
    earlier computed map[-1].start_location + (-1 & 0xffffff80) and so only
    decreased by 7 bits, so to_line is still on the line with #include and not
    after it.  In the #c12 that doesn't happen, all the ordinary maps involved
    there had 0 m_column_and_range_bits and so this computes correct line.

    Below is a fix for the trunk including testcases using the
    location_overflow_plugin hack to simulate the bugs without needing huge
    files (in the 14 case it is just 330KB and almost 10MB, but in the 15
    case it would need to be far bigger).
    The pre- r15-9018 trunk has
    FAIL: gcc.dg/plugin/location-overflow-test-pr116047.c
-fplugin=./location_overflow_plugin.so  scan-file
static_assert[^\n\r]*6[^\n\r]*== 6
    and current trunk
    FAIL: gcc.dg/plugin/location-overflow-test-pr116047.c
-fplugin=./location_overflow_plugin.so  scan-file
static_assert[^\n\r]*6[^\n\r]*== 6
    FAIL: gcc.dg/plugin/location-overflow-test-pr120061.c
-fplugin=./location_overflow_plugin.so  scan-file
static_assert[^\n\r]*5[^\n\r]*== 5
    and with the patch everything PASSes.

    The patch reverts the r14-11679 change, because it is incorrect,
    we really need to decrement it even when crossing ordinary map
    boundaries, so that the location is not on the line after the #include
    line but somewhere on the #include line.  It also patches two spots
    in linemap_add mentioned above to make sure we get correct locations
    both in the included_from location_t when doing LC_ENTER (second
    line-map.cc hunk) and when doing LC_LEAVE to compute the right to_line
    (first line-map.cc hunk), both in presence of an added LC_RENAME
    with the same start_location as the following LC_ENTER (i.e. the
    problematic cases).
    The LC_ENTER hunk is mostly to ensure included_form location_t is
    at the start of the #include line (column 0), without it we can
    decrease include_from not enough and end up at some random column
    in the middle of the line, because it is masking away
    map[-1].m_column_and_range_bits bits even when in the end the resulting
    include_from location_t will be found in map[-2] map with perhaps
    different m_column_and_range_bits.  That alone doesn't fix the bug
    though.
    The more important is the LC_LEAVE hunk and the problem there is
    caused by linemap_line_start not actually doing
        r = set->highest_line + (line_delta << map->m_column_and_range_bits);
    when adding a new map (the LC_RENAME one because we need to switch to
    different number of directly encoded ranges, or columns, etc.).
    So, in the original PR108900 case that
      to_line = SOURCE_LINE (from, from[1].start_location);
    doesn't do the right thing, from there is the last < 0x50000000 map
    with m_column_and_range_bits 12, from[1] is the first one above it
    and map[-1].included_from is the correct location of column 0 on
    the #include line, but as the new LC_RENAME map has been created without
    actually increasing highest_location to be on the new line (we've just
    set to_line of the new LC_RENAME map to the correct line),
      to_line = SOURCE_LINE (from, from[1].start_location);
    stays on the same source line.  I've tried to just replace that with
      to_line = SOURCE_LINE (from, linemap_included_from (map - 1)) + 1;
    i.e. just find out the #include line from map[-1].included_from and
    add 1 to it, unfortunately that breaks the
    c-c++-common/cpp/line-4.c
    test where we expect to stay on the same 0 line for LC_LEAVE from
    <command line> and gcc.dg/cpp/trad/Wunused.c, gcc.dg/cpp/trad/builtins.c
    and c-c++-common/analyzer/named-constants-via-macros-traditional.c tests
    all with -traditional-cpp preprocessing where to_line is also off-by-one
    from the expected one.
    So, this patch instead conditionalizes it, uses the
      to_line = SOURCE_LINE (from, linemap_included_from (map - 1)) + 1;
    way only if from[1] is a LC_RENAME map (rather than the usual
    LC_ENTER one), that should limit it to the problematic cases of when
    parse_include peeked after EOL and had to create LC_RENAME map with
    the same start_location as the LC_ENTER after it.

    Some further justification for the LC_ENTER hunk, using the
    https://gcc.gnu.org/pipermail/gcc-patches/2025-May/682774.html testcase
    (old is 14 before r14-11679, vanilla current 14 and new with the 14 patch)
    I get
    $ /usr/src/gcc-14/obj/gcc/cc1.old -quiet -std=c23 pr116047.c -nostdinc
    In file included from pr116047-1.h:327677:21,
                     from pr116047.c:4:
    pr116047-2.h:1:1: error: unknown type name âaâ
        1 | a b c;
          | ^
    pr116047-2.h:1:5: error: expected â=â, â,â, â;â, âasmâ or
â__attribute__â before âcâ
        1 | a b c;
          |     ^
    pr116047-1.h:327677:1: error: static assertion failed: ""
    327677 | #include "pr116047-2.h"
           | ^~~~~~~~~~~~~
    $ /usr/src/gcc-14/obj/gcc/cc1.vanilla -quiet -std=c23 pr116047.c -nostdinc
    In file included from pr116047-1.h:327678,
                     from pr116047.c:4:
    pr116047-2.h:1:1: error: unknown type name âaâ
        1 | a b c;
          | ^
    pr116047-2.h:1:5: error: expected â=â, â,â, â;â, âasmâ or
â__attribute__â before âcâ
        1 | a b c;
          |     ^
    $ /usr/src/gcc-14/obj/gcc/cc1.new -quiet -std=c23 pr116047.c -nostdinc
    In file included from pr116047-1.h:327677,
                     from pr116047.c:4:
    pr116047-2.h:1:1: error: unknown type name âaâ
        1 | a b c;
          | ^
    pr116047-2.h:1:5: error: expected â=â, â,â, â;â, âasmâ or
â__attribute__â before âcâ
        1 | a b c;
          |     ^

    pr116047-1.h has on lines 327677+327678:
     #include "pr116047-2.h"
     static_assert (__LINE__ == 327678, "");
    so the static_assert failure is something that was dealt mainly in the
    LC_LEAVE hunk and files.cc reversion, but please have a look at the
    In file included from lines.
    14.2 emits correct line (#include "pr116047-2.h" is indeed on line
    327677) but some random column in there (which is not normally printed
    for smaller headers; 21 is the . before extension in the filename).
    Current trunk emits incorrect line (327678 instead of 327677, clearly
    it didn't decrement).
    And the patched compiler emits the right line with no column, as would
    be printed if I remove e.g. 300000 newlines from the file.

    2025-05-08  Jakub Jelinek  <ja...@redhat.com>

            PR preprocessor/108900
            PR preprocessor/116047
            PR preprocessor/120061
            * files.cc (_cpp_stack_file): Revert 2025-03-28 change.
            * line-map.cc (linemap_add): Use
            SOURCE_LINE (from, linemap_included_from (map - 1)) + 1; instead of
            SOURCE_LINE (from, from[1].start_location); to compute to_line
            for LC_LEAVE if from[1].reason is LC_RENAME.  For LC_ENTER
            included_from computation, look at map[-2] or even lower if map[-1]
            has the same start_location as map[0].

            * gcc.dg/plugin/plugin.exp: Add location-overflow-test-pr116047.c
            and location-overflow-test-pr120061.c.
            * gcc.dg/plugin/location_overflow_plugin.c (plugin_init): Don't
error
            on unknown values, instead just break.
            * gcc.dg/plugin/location-overflow-test-pr116047.c: New test.
            * gcc.dg/plugin/location-overflow-test-pr116047-1.h: New test.
            * gcc.dg/plugin/location-overflow-test-pr116047-2.h: New test.
            * gcc.dg/plugin/location-overflow-test-pr120061.c: New test.
            * gcc.dg/plugin/location-overflow-test-pr120061-1.h: New test.
            * gcc.dg/plugin/location-overflow-test-pr120061-2.h: New test.

Reply via email to