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 #ifndef _GLIBCPP_TESTSUITE_HOOKS_H
  51 #define _GLIBCPP_TESTSUITE_HOOKS_H
  52
  53 #ifdef DEBUG_ASSERT
  54 # include <cassert>
  55 # define VERIFY(fn) assert(fn)
  56 #else
  57 # define VERIFY(fn) test &= (fn)
  58 #endif
  59
  60 #include <bits/c++config.h>
  61
  62 // Defined in GLIBCPP_CONFIGURE_TESTSUITE.
  63 #ifndef _GLIBCPP_MEM_LIMITS
  64
  65 // Don't do memory limits.
  66 void
  67 __set_testsuite_memlimit(float x = 0)
  68 { }
  69
  70 #else
  71
  72 // Do memory limits.
  73 #include <sys/resource.h>
  74 #include <unistd.h>
  75
  76 #ifndef MEMLIMIT_MB
  77 #define MEMLIMIT_MB 16.0
  78 #endif
  79
  80 void
  81 __set_testsuite_memlimit(float __size = MEMLIMIT_MB)
  82 {
  83     struct rlimit r;
  84     r.rlim_cur = (rlim_t)(__size * 1048576);
  85
  86     // Heap size, seems to be common.
  87 #if _GLIBCPP_HAVE_MEMLIMIT_DATA
  88     setrlimit(RLIMIT_DATA, &r);
  89 #endif
  90
  91     // Resident set size.
  92 #if _GLIBCPP_HAVE_MEMLIMIT_RSS
  93     setrlimit(RLIMIT_RSS, &r);
  94 #endif
  95
  96     // Mapped memory (brk + mmap).
  97 #if _GLIBCPP_HAVE_MEMLIMIT_VMEM
  98     setrlimit(RLIMIT_VMEM, &r);
  99 #endif
 100
 101     // Virtual memory.
 102 #if _GLIBCPP_HAVE_MEMLIMIT_AS
 103     setrlimit(RLIMIT_AS, &r);
 104 #endif
 105 }
 106 #endif
 107
 108
 109 struct gnu_counting_struct
 110 {
 111     // Specifically and glaringly-obviously marked 'signed' so that when
 112     // count mistakenly goes negative, we can track the patterns of
 113     // deletions easier.
 114     typedef  signed int     size_type;
 115     static size_type   count;
 116     gnu_counting_struct() { ++count; }
 117     gnu_counting_struct (const gnu_counting_struct&) { ++count; }
 118     ~gnu_counting_struct() { --count; }
 119 };
 120
 121 #define assert_count(n)   VERIFY(gnu_counting_struct::count == n)
 122
 123 gnu_counting_struct::size_type  gnu_counting_struct::count = 0;
 124
 125
 126 #endif // _GLIBCPP_TESTSUITE_HOOKS_H
 127