gcc/vec.c

   1 /* Vector API for GNU compiler.
   2    Copyright (C) 2004-2018 Free Software Foundation, Inc.
   3    Contributed by Nathan Sidwell <nathan@codesourcery.com>
   4    Re-implemented in C++ by Diego Novillo <dnovillo@google.com>
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 /* This file is compiled twice: once for the generator programs
  23    once for the compiler.  */
  24 #ifdef GENERATOR_FILE
  25 #include "bconfig.h"
  26 #else
  27 #include "config.h"
  28 #endif
  29
  30 #include "system.h"
  31 #include "coretypes.h"
  32 #include "hash-table.h"
  33 #include "selftest.h"
  34 #ifdef GENERATOR_FILE
  35 #include "errors.h"
  36 #else
  37 #include "input.h"
  38 #include "diagnostic-core.h"
  39 #endif
  40
  41 /* vNULL is an empty type with a template cast operation that returns
  42    a zero-initialized vec<T, A, L> instance.  Use this when you want
  43    to assign nil values to new vec instances or pass a nil vector as
  44    a function call argument.
  45
  46    We use this technique because vec<T, A, L> must be PODs (they are
  47    stored in unions and passed in vararg functions), this means that
  48    they cannot have ctors/dtors.  */
  49 vnull vNULL;
  50
  51 /* Vector memory usage.  */
  52 struct vec_usage: public mem_usage
  53 {
  54   /* Default constructor.  */
  55   vec_usage (): m_items (0), m_items_peak (0), m_element_size (0) {}
  56
  57   /* Constructor.  */
  58   vec_usage (size_t allocated, size_t times, size_t peak,
  59              size_t items, size_t items_peak, size_t element_size)
  60     : mem_usage (allocated, times, peak),
  61     m_items (items), m_items_peak (items_peak),
  62     m_element_size (element_size) {}
  63
  64   /* Sum the usage with SECOND usage.  */
  65   vec_usage
  66   operator+ (const vec_usage &second)
  67   {
  68     return vec_usage (m_allocated + second.m_allocated,
  69                       m_times + second.m_times,
  70                       m_peak + second.m_peak,
  71                       m_items + second.m_items,
  72                       m_items_peak + second.m_items_peak, 0);
  73   }
  74
  75   /* Dump usage coupled to LOC location, where TOTAL is sum of all rows.  */
  76   inline void
  77   dump (mem_location *loc, mem_usage &total) const
  78   {
  79     char s[4096];
  80     sprintf (s, "%s:%i (%s)", loc->get_trimmed_filename (),
  81              loc->m_line, loc->m_function);
  82
  83     s[48] = '\0';
  84
  85     fprintf (stderr,
  86              "%-48s %10" PRIu64 PRsa (10) ":%4.1f%%" PRsa (9) "%10" PRIu64
  87              ":%4.1f%%" PRsa (10) PRsa (10) "\n",
  88              s,
  89              (uint64_t)m_element_size,
  90              SIZE_AMOUNT (m_allocated),
  91              m_allocated * 100.0 / total.m_allocated,
  92              SIZE_AMOUNT (m_peak), (uint64_t)m_times,
  93              m_times * 100.0 / total.m_times,
  94              SIZE_AMOUNT (m_items), SIZE_AMOUNT (m_items_peak));
  95   }
  96
  97   /* Dump footer.  */
  98   inline void
  99   dump_footer ()
 100   {
 101     print_dash_line ();
 102     fprintf (stderr, "%s" PRsa (64) PRsa (25) PRsa (16) "\n",
 103              "Total", SIZE_AMOUNT (m_allocated),
 104              SIZE_AMOUNT (m_times), SIZE_AMOUNT (m_items));
 105     print_dash_line ();
 106   }
 107
 108   /* Dump header with NAME.  */
 109   static inline void
 110   dump_header (const char *name)
 111   {
 112     fprintf (stderr, "%-48s %10s%11s%16s%10s%17s%11s\n", name, "sizeof(T)",
 113              "Leak", "Peak", "Times", "Leak items", "Peak items");
 114     print_dash_line ();
 115   }
 116
 117   /* Current number of items allocated.  */
 118   size_t m_items;
 119   /* Peak value of number of allocated items.  */
 120   size_t m_items_peak;
 121   /* Size of element of the vector.  */
 122   size_t m_element_size;
 123 };
 124
 125 /* Vector memory description.  */
 126 static mem_alloc_description <vec_usage> vec_mem_desc;
 127
 128 /* Account the overhead.  */
 129
 130 void
 131 vec_prefix::register_overhead (void *ptr, size_t elements,
 132                                size_t element_size MEM_STAT_DECL)
 133 {
 134   vec_mem_desc.register_descriptor (ptr, VEC_ORIGIN, false
 135                                     FINAL_PASS_MEM_STAT);
 136   vec_usage *usage
 137     = vec_mem_desc.register_instance_overhead (elements * element_size, ptr);
 138   usage->m_element_size = element_size;
 139   usage->m_items += elements;
 140   if (usage->m_items_peak < usage->m_items)
 141     usage->m_items_peak = usage->m_items;
 142 }
 143
 144 /* Notice that the memory allocated for the vector has been freed.  */
 145
 146 void
 147 vec_prefix::release_overhead (void *ptr, size_t size, size_t elements,
 148                               bool in_dtor MEM_STAT_DECL)
 149 {
 150   if (!vec_mem_desc.contains_descriptor_for_instance (ptr))
 151     vec_mem_desc.register_descriptor (ptr, VEC_ORIGIN,
 152                                       false FINAL_PASS_MEM_STAT);
 153   vec_usage *usage = vec_mem_desc.release_instance_overhead (ptr, size,
 154                                                              in_dtor);
 155   usage->m_items -= elements;
 156 }
 157
 158 /* Calculate the number of slots to reserve a vector, making sure that
 159    it is of at least DESIRED size by growing ALLOC exponentially.  */
 160
 161 unsigned
 162 vec_prefix::calculate_allocation_1 (unsigned alloc, unsigned desired)
 163 {
 164   /* We must have run out of room.  */
 165   gcc_assert (alloc < desired);
 166
 167   /* Exponential growth. */
 168   if (!alloc)
 169     alloc = 4;
 170   else if (alloc < 16)
 171     /* Double when small.  */
 172     alloc = alloc * 2;
 173   else
 174     /* Grow slower when large.  */
 175     alloc = (alloc * 3 / 2);
 176
 177   /* If this is still too small, set it to the right size. */
 178   if (alloc < desired)
 179     alloc = desired;
 180   return alloc;
 181 }
 182
 183 /* Dump per-site memory statistics.  */
 184
 185 void
 186 dump_vec_loc_statistics (void)
 187 {
 188   vec_mem_desc.dump (VEC_ORIGIN);
 189 }
 190
 191 #if CHECKING_P
 192 /* Report qsort comparator CMP consistency check failure with P1, P2, P3 as
 193    witness elements.  */
 194 ATTRIBUTE_NORETURN ATTRIBUTE_COLD
 195 static void
 196 qsort_chk_error (const void *p1, const void *p2, const void *p3,
 197                  int (*cmp) (const void *, const void *))
 198 {
 199   if (!p3)
 200     {
 201       int r1 = cmp (p1, p2), r2 = cmp (p2, p1);
 202       error ("qsort comparator not anti-commutative: %d, %d", r1, r2);
 203     }
 204   else if (p1 == p2)
 205     {
 206       int r = cmp (p1, p3);
 207       error ("qsort comparator non-negative on sorted output: %d", r);
 208     }
 209   else
 210     {
 211       int r1 = cmp (p1, p2), r2 = cmp (p2, p3), r3 = cmp (p1, p3);
 212       error ("qsort comparator not transitive: %d, %d, %d", r1, r2, r3);
 213     }
 214   internal_error ("qsort checking failed");
 215 }
 216
 217 /* Verify anti-symmetry and transitivity for comparator CMP on sorted array
 218    of N SIZE-sized elements pointed to by BASE.  */
 219 void
 220 qsort_chk (void *base, size_t n, size_t size,
 221            int (*cmp)(const void *, const void *))
 222 {
 223 #if 0
 224 #define LIM(n) (n)
 225 #else
 226   /* Limit overall time complexity to O(n log n).  */
 227 #define LIM(n) ((n) <= 16 ? (n) : 12 + floor_log2 (n))
 228 #endif
 229 #define ELT(i) ((const char *) base + (i) * size)
 230 #define CMP(i, j) cmp (ELT (i), ELT (j))
 231 #define ERR2(i, j) qsort_chk_error (ELT (i), ELT (j), NULL, cmp)
 232 #define ERR3(i, j, k) qsort_chk_error (ELT (i), ELT (j), ELT (k), cmp)
 233   size_t i1, i2, i, j;
 234   /* This outer loop iterates over maximum spans [i1, i2) such that
 235      elements within each span compare equal to each other.  */
 236   for (i1 = 0; i1 < n; i1 = i2)
 237     {
 238       /* Position i2 one past last element that compares equal to i1'th.  */
 239       for (i2 = i1 + 1; i2 < n; i2++)
 240         if (CMP (i1, i2))
 241           break;
 242         else if (CMP (i2, i1))
 243           return ERR2 (i1, i2);
 244       size_t lim1 = LIM (i2 - i1), lim2 = LIM (n - i2);
 245       /* Verify that other pairs within current span compare equal.  */
 246       for (i = i1 + 1; i + 1 < i2; i++)
 247         for (j = i + 1; j < i1 + lim1; j++)
 248           if (CMP (i, j))
 249             return ERR3 (i, i1, j);
 250           else if (CMP (j, i))
 251             return ERR2 (i, j);
 252       /* Verify that elements within this span compare less than
 253          elements beyond the span.  */
 254       for (i = i1; i < i2; i++)
 255         for (j = i2; j < i2 + lim2; j++)
 256           if (CMP (i, j) >= 0)
 257             return ERR3 (i, i1, j);
 258           else if (CMP (j, i) <= 0)
 259             return ERR2 (i, j);
 260     }
 261 #undef ERR3
 262 #undef ERR2
 263 #undef CMP
 264 #undef ELT
 265 #undef LIM
 266 }
 267 #endif /* #if CHECKING_P */
 268
 269 #ifndef GENERATOR_FILE
 270 #if CHECKING_P
 271
 272 namespace selftest {
 273
 274 /* Selftests.  */
 275
 276 /* Call V.safe_push for all ints from START up to, but not including LIMIT.
 277    Helper function for selftests.  */
 278
 279 static void
 280 safe_push_range (vec <int>&v, int start, int limit)
 281 {
 282   for (int i = start; i < limit; i++)
 283     v.safe_push (i);
 284 }
 285
 286 /* Verify that vec::quick_push works correctly.  */
 287
 288 static void
 289 test_quick_push ()
 290 {
 291   auto_vec <int> v;
 292   ASSERT_EQ (0, v.length ());
 293   v.reserve (3);
 294   ASSERT_EQ (0, v.length ());
 295   ASSERT_TRUE (v.space (3));
 296   v.quick_push (5);
 297   v.quick_push (6);
 298   v.quick_push (7);
 299   ASSERT_EQ (3, v.length ());
 300   ASSERT_EQ (5, v[0]);
 301   ASSERT_EQ (6, v[1]);
 302   ASSERT_EQ (7, v[2]);
 303 }
 304
 305 /* Verify that vec::safe_push works correctly.  */
 306
 307 static void
 308 test_safe_push ()
 309 {
 310   auto_vec <int> v;
 311   ASSERT_EQ (0, v.length ());
 312   v.safe_push (5);
 313   v.safe_push (6);
 314   v.safe_push (7);
 315   ASSERT_EQ (3, v.length ());
 316   ASSERT_EQ (5, v[0]);
 317   ASSERT_EQ (6, v[1]);
 318   ASSERT_EQ (7, v[2]);
 319 }
 320
 321 /* Verify that vec::truncate works correctly.  */
 322
 323 static void
 324 test_truncate ()
 325 {
 326   auto_vec <int> v;
 327   ASSERT_EQ (0, v.length ());
 328   safe_push_range (v, 0, 10);
 329   ASSERT_EQ (10, v.length ());
 330
 331   v.truncate (5);
 332   ASSERT_EQ (5, v.length ());
 333 }
 334
 335 /* Verify that vec::safe_grow_cleared works correctly.  */
 336
 337 static void
 338 test_safe_grow_cleared ()
 339 {
 340   auto_vec <int> v;
 341   ASSERT_EQ (0, v.length ());
 342   v.safe_grow_cleared (50);
 343   ASSERT_EQ (50, v.length ());
 344   ASSERT_EQ (0, v[0]);
 345   ASSERT_EQ (0, v[49]);
 346 }
 347
 348 /* Verify that vec::pop works correctly.  */
 349
 350 static void
 351 test_pop ()
 352 {
 353   auto_vec <int> v;
 354   safe_push_range (v, 5, 20);
 355   ASSERT_EQ (15, v.length ());
 356
 357   int last = v.pop ();
 358   ASSERT_EQ (19, last);
 359   ASSERT_EQ (14, v.length ());
 360 }
 361
 362 /* Verify that vec::safe_insert works correctly.  */
 363
 364 static void
 365 test_safe_insert ()
 366 {
 367   auto_vec <int> v;
 368   safe_push_range (v, 0, 10);
 369   v.safe_insert (5, 42);
 370   ASSERT_EQ (4, v[4]);
 371   ASSERT_EQ (42, v[5]);
 372   ASSERT_EQ (5, v[6]);
 373   ASSERT_EQ (11, v.length ());
 374 }
 375
 376 /* Verify that vec::ordered_remove works correctly.  */
 377
 378 static void
 379 test_ordered_remove ()
 380 {
 381   auto_vec <int> v;
 382   safe_push_range (v, 0, 10);
 383   v.ordered_remove (5);
 384   ASSERT_EQ (4, v[4]);
 385   ASSERT_EQ (6, v[5]);
 386   ASSERT_EQ (9, v.length ());
 387 }
 388
 389 /* Verify that vec::ordered_remove_if works correctly.  */
 390
 391 static void
 392 test_ordered_remove_if (void)
 393 {
 394   auto_vec <int> v;
 395   safe_push_range (v, 0, 10);
 396   unsigned ix, ix2;
 397   int *elem_ptr;
 398   VEC_ORDERED_REMOVE_IF (v, ix, ix2, elem_ptr,
 399                          *elem_ptr == 5 || *elem_ptr == 7);
 400   ASSERT_EQ (4, v[4]);
 401   ASSERT_EQ (6, v[5]);
 402   ASSERT_EQ (8, v[6]);
 403   ASSERT_EQ (8, v.length ());
 404
 405   v.truncate (0);
 406   safe_push_range (v, 0, 10);
 407   VEC_ORDERED_REMOVE_IF_FROM_TO (v, ix, ix2, elem_ptr, 0, 6,
 408                                  *elem_ptr == 5 || *elem_ptr == 7);
 409   ASSERT_EQ (4, v[4]);
 410   ASSERT_EQ (6, v[5]);
 411   ASSERT_EQ (7, v[6]);
 412   ASSERT_EQ (9, v.length ());
 413
 414   v.truncate (0);
 415   safe_push_range (v, 0, 10);
 416   VEC_ORDERED_REMOVE_IF_FROM_TO (v, ix, ix2, elem_ptr, 0, 5,
 417                                  *elem_ptr == 5 || *elem_ptr == 7);
 418   VEC_ORDERED_REMOVE_IF_FROM_TO (v, ix, ix2, elem_ptr, 8, 10,
 419                                  *elem_ptr == 5 || *elem_ptr == 7);
 420   ASSERT_EQ (4, v[4]);
 421   ASSERT_EQ (5, v[5]);
 422   ASSERT_EQ (6, v[6]);
 423   ASSERT_EQ (10, v.length ());
 424
 425   v.truncate (0);
 426   safe_push_range (v, 0, 10);
 427   VEC_ORDERED_REMOVE_IF (v, ix, ix2, elem_ptr, *elem_ptr == 5);
 428   ASSERT_EQ (4, v[4]);
 429   ASSERT_EQ (6, v[5]);
 430   ASSERT_EQ (7, v[6]);
 431   ASSERT_EQ (9, v.length ());
 432 }
 433
 434 /* Verify that vec::unordered_remove works correctly.  */
 435
 436 static void
 437 test_unordered_remove ()
 438 {
 439   auto_vec <int> v;
 440   safe_push_range (v, 0, 10);
 441   v.unordered_remove (5);
 442   ASSERT_EQ (9, v.length ());
 443 }
 444
 445 /* Verify that vec::block_remove works correctly.  */
 446
 447 static void
 448 test_block_remove ()
 449 {
 450   auto_vec <int> v;
 451   safe_push_range (v, 0, 10);
 452   v.block_remove (5, 3);
 453   ASSERT_EQ (3, v[3]);
 454   ASSERT_EQ (4, v[4]);
 455   ASSERT_EQ (8, v[5]);
 456   ASSERT_EQ (9, v[6]);
 457   ASSERT_EQ (7, v.length ());
 458 }
 459
 460 /* Comparator for use by test_qsort.  */
 461
 462 static int
 463 reverse_cmp (const void *p_i, const void *p_j)
 464 {
 465   return *(const int *)p_j - *(const int *)p_i;
 466 }
 467
 468 /* Verify that vec::qsort works correctly.  */
 469
 470 static void
 471 test_qsort ()
 472 {
 473   auto_vec <int> v;
 474   safe_push_range (v, 0, 10);
 475   v.qsort (reverse_cmp);
 476   ASSERT_EQ (9, v[0]);
 477   ASSERT_EQ (8, v[1]);
 478   ASSERT_EQ (1, v[8]);
 479   ASSERT_EQ (0, v[9]);
 480   ASSERT_EQ (10, v.length ());
 481 }
 482
 483 /* Verify that vec::reverse works correctly.  */
 484
 485 static void
 486 test_reverse ()
 487 {
 488   /* Reversing an empty vec ought to be a no-op.  */
 489   {
 490     auto_vec <int> v;
 491     ASSERT_EQ (0, v.length ());
 492     v.reverse ();
 493     ASSERT_EQ (0, v.length ());
 494   }
 495
 496   /* Verify reversing a vec with even length.  */
 497   {
 498     auto_vec <int> v;
 499     safe_push_range (v, 0, 4);
 500     v.reverse ();
 501     ASSERT_EQ (3, v[0]);
 502     ASSERT_EQ (2, v[1]);
 503     ASSERT_EQ (1, v[2]);
 504     ASSERT_EQ (0, v[3]);
 505     ASSERT_EQ (4, v.length ());
 506   }
 507
 508   /* Verify reversing a vec with odd length.  */
 509   {
 510     auto_vec <int> v;
 511     safe_push_range (v, 0, 3);
 512     v.reverse ();
 513     ASSERT_EQ (2, v[0]);
 514     ASSERT_EQ (1, v[1]);
 515     ASSERT_EQ (0, v[2]);
 516     ASSERT_EQ (3, v.length ());
 517   }
 518 }
 519
 520 /* Run all of the selftests within this file.  */
 521
 522 void
 523 vec_c_tests ()
 524 {
 525   test_quick_push ();
 526   test_safe_push ();
 527   test_truncate ();
 528   test_safe_grow_cleared ();
 529   test_pop ();
 530   test_safe_insert ();
 531   test_ordered_remove ();
 532   test_ordered_remove_if ();
 533   test_unordered_remove ();
 534   test_block_remove ();
 535   test_qsort ();
 536   test_reverse ();
 537 }
 538
 539 } // namespace selftest
 540
 541 #endif /* #if CHECKING_P */
 542 #endif /* #ifndef GENERATOR_FILE */