tests/malloc_wrapper.h

   1 /*
   2  * nghttp2 - HTTP/2 C Library
   3  *
   4  * Copyright (c) 2012 Tatsuhiro Tsujikawa
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25 #ifndef MALLOC_WRAPPER_H
  26 #define MALLOC_WRAPPER_H
  27
  28 #include <stdlib.h>
  29
  30 #include "nghttp2_mem.h"
  31
  32 /* Global variables to control the behavior of malloc() */
  33
  34 /* If nonzero, malloc failure mode is on */
  35 extern int nghttp2_failmalloc;
  36 /* If nghttp2_failstart <= nghttp2_nmalloc and nghttp2_failmalloc is
  37    nonzero, malloc() fails. */
  38 extern int nghttp2_failstart;
  39 /* If nonzero, nghttp2_nmalloc is incremented if malloc() succeeds. */
  40 extern int nghttp2_countmalloc;
  41 /* The number of successful invocation of malloc(). This value is only
  42    incremented if nghttp2_nmalloc is nonzero. */
  43 extern int nghttp2_nmalloc;
  44
  45 /* Returns pointer to nghttp2_mem, which, when dereferenced, contains
  46    specifically instrumented memory allocators for failmalloc
  47    tests. */
  48 nghttp2_mem *nghttp2_mem_fm(void);
  49
  50 /* Copies nghttp2_failmalloc and nghttp2_countmalloc to statically
  51    allocated space and sets 0 to them. This will effectively make
  52    malloc() work like normal malloc(). This is useful when you want to
  53    disable malloc() failure mode temporarily. */
  54 void nghttp2_failmalloc_pause(void);
  55
  56 /* Restores the values of nghttp2_failmalloc and nghttp2_countmalloc
  57    with the values saved by the previous
  58    nghttp2_failmalloc_pause(). */
  59 void nghttp2_failmalloc_unpause(void);
  60
  61 #endif /* MALLOC_WRAPPER_H */