libstdc++-v3/testsuite/testsuite_hooks.h

   1 // Utility subroutines for the C++ library testsuite.
   2 //
   3 // Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20 //
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 // This file provides the following:
  31 //
  32 // 1)  VERIFY(), via DEBUG_ASSERT, from Brent Verner <brent@rcfile.org>.
  33 //   This file is included in the various testsuite programs to provide
  34 //   #define(able) assert() behavior for debugging/testing. It may be
  35 //   a suitable location for other furry woodland creatures as well.
  36 //
  37 // 2)  __set_testsuite_memlimit()
  38 //   __set_testsuite_memlimit() uses setrlimit() to restrict dynamic memory
  39 //   allocation.  We provide a default memory limit if none is passed by the
  40 //   calling application.  The argument to __set_testsuite_memlimit() is the
  41 //   limit in megabytes (a floating-point number).  If _GLIBCPP_MEM_LIMITS is
  42 //   not #defined before including this header, then no limiting is attempted.
  43 //
  44 // 3)  gnu_counting_struct
  45 //   This is a POD with a static data member, gnu_counting_struct::count,
  46 //   which starts at zero, increments on instance construction, and decrements
  47 //   on instance destruction.  "assert_count(n)" can be called to VERIFY()
  48 //   that the count equals N.
  49 //
  50 // 4)  gnu_copy_tracker, from Stephen M. Webb <stephen@bregmasoft.com>.
  51 //   A class with nontrivial ctor/dtor that provides the ability to track the
  52 //   number of copy ctors and dtors, and will throw on demand during copy.
  53
  54 #ifndef _GLIBCPP_TESTSUITE_HOOKS_H
  55 #define _GLIBCPP_TESTSUITE_HOOKS_H
  56
  57 #ifdef DEBUG_ASSERT
  58 # include <cassert>
  59 # define VERIFY(fn) assert(fn)
  60 #else
  61 # define VERIFY(fn) test &= (fn)
  62 #endif
  63
  64 #include <bits/c++config.h>
  65
  66 // Defined in GLIBCPP_CONFIGURE_TESTSUITE.
  67 #ifndef _GLIBCPP_MEM_LIMITS
  68 // Don't do memory limits.
  69 extern void
  70 __set_testsuite_memlimit(float x = 0)
  71 { }
  72
  73 #else
  74
  75 // Do memory limits.
  76 #ifndef MEMLIMIT_MB
  77 #define MEMLIMIT_MB 16.0
  78 #endif
  79
  80 extern void
  81 __set_testsuite_memlimit(float __size = MEMLIMIT_MB);
  82 #endif
  83
  84
  85 struct gnu_counting_struct
  86 {
  87     // Specifically and glaringly-obviously marked 'signed' so that when
  88     // COUNT mistakenly goes negative, we can track the patterns of
  89     // deletions more easily.
  90     typedef  signed int     size_type;
  91     static size_type   count;
  92     gnu_counting_struct() { ++count; }
  93     gnu_counting_struct (const gnu_counting_struct&) { ++count; }
  94     ~gnu_counting_struct() { --count; }
  95 };
  96
  97 #define assert_count(n)   VERIFY(gnu_counting_struct::count == n)
  98
  99
 100 class gnu_copy_tracker
 101 {
 102   public:
 103     // Cannot be explicit.  Conversion ctor used by list_modifiers.cc's
 104     // test03(), "range fill at beginning".
 105     gnu_copy_tracker (int anId, bool throwOnDemand = false)
 106     : itsId(anId), willThrow(throwOnDemand)
 107     {}
 108
 109     gnu_copy_tracker (const gnu_copy_tracker& rhs)
 110     : itsId(rhs.id()), willThrow(rhs.willThrow)
 111     {
 112       ++itsCopyCount;
 113       if (willThrow) throw "copy tracker exception";
 114     }
 115
 116     gnu_copy_tracker& operator=(const gnu_copy_tracker& rhs)
 117     {
 118       itsId = rhs.id();
 119       // willThrow must obviously already be false to get this far
 120     }
 121
 122     ~gnu_copy_tracker() { ++itsDtorCount; }
 123
 124     int
 125     id() const
 126     { return itsId; }
 127
 128   private:
 129           int   itsId;
 130     const bool  willThrow;
 131
 132   public:
 133     static void
 134     reset()
 135     { itsCopyCount = 0; itsDtorCount = 0; }
 136
 137     static int
 138     copyCount()
 139     { return itsCopyCount; }
 140
 141     static int
 142     dtorCount()
 143     { return itsDtorCount; }
 144
 145   private:
 146     static int itsCopyCount;
 147     static int itsDtorCount;
 148 };
 149
 150
 151 #endif // _GLIBCPP_TESTSUITE_HOOKS_H
 152