third_party/tcmalloc/chromium/src/tests/testutil.h

   1 // Copyright (c) 2007, Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 //     * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //     * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //     * Neither the name of Google Inc. nor the names of its
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 // ---
  31 // Author: Craig Silverstein
  32
  33 #ifndef TCMALLOC_TOOLS_TESTUTIL_H_
  34 #define TCMALLOC_TOOLS_TESTUTIL_H_
  35
  36 // Run a function in a thread of its own and wait for it to finish.
  37 // The function you pass in must have the signature
  38 //    void MyFunction();
  39 extern "C" void RunThread(void (*fn)());
  40
  41 // Run a function X times, in X threads, and wait for them all to finish.
  42 // The function you pass in must have the signature
  43 //    void MyFunction();
  44 extern "C" void RunManyThreads(void (*fn)(), int count);
  45
  46 // The 'advanced' version: run a function X times, in X threads, and
  47 // wait for them all to finish.  Give them all the specified stack-size.
  48 // (If you're curious why this takes a stacksize and the others don't,
  49 // it's because the one client of this fn wanted to specify stacksize. :-) )
  50 // The function you pass in must have the signature
  51 //    void MyFunction(int idx);
  52 // where idx is the index of the thread (which of the X threads this is).
  53 extern "C" void RunManyThreadsWithId(void (*fn)(int), int count, int stacksize);
  54
  55 // When compiled 64-bit and run on systems with swap several unittests will end
  56 // up trying to consume all of RAM+swap, and that can take quite some time.  By
  57 // limiting the address-space size we get sufficient coverage without blowing
  58 // out job limits.
  59 void SetTestResourceLimit();
  60
  61 #endif  // TCMALLOC_TOOLS_TESTUTIL_H_