granicus.if.org Git - strace/blob - xmalloc.h

   1 /*
   2  * This file contains wrapper functions working with memory allocations,
   3  * they just terminate the program in case of memory allocation failure.
   4  * These functions can be used by various binaries included in the strace
   5  * package.
   6  *
   7  * Copyright (c) 2001-2017 The strace developers.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. The name of the author may not be used to endorse or promote products
  19  *    derived from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef STRACE_XMALLOC_H
  34 #define STRACE_XMALLOC_H
  35
  36 #include <stddef.h>
  37 #include "gcc_compat.h"
  38
  39 void *xcalloc(size_t nmemb, size_t size)
  40         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
  41 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
  42 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
  43         ATTRIBUTE_ALLOC_SIZE((2, 3));
  44
  45 /**
  46  * Utility function for the simplification of managing various dynamic arrays.
  47  * Knows better how to resize arrays. Dies if there's no enough memory.
  48  *
  49  * @param[in]      ptr       Pointer to the array to be resized. If ptr is NULL,
  50  *                           new array is allocated.
  51  * @param[in, out] nmemb     Pointer to the current member count. If ptr is
  52  *                           NULL, it specifies number of members in the newly
  53  *                           created array. If ptr is NULL and nmemb is 0,
  54  *                           number of members in the new array is decided by
  55  *                           the function. Member count is updated by the
  56  *                           function to the new value.
  57  * @param[in]      memb_size Size of array member in bytes.
  58  * @return                   Pointer to the (re)allocated array.
  59  */
  60 void *xgrowarray(void *ptr, size_t *nmemb, size_t memb_size);
  61
  62 /*
  63  * Note that the following two functions return NULL when NULL is specified
  64  * and not when allocation is failed, since, as the "x" prefix implies,
  65  * the allocation failure leads to program termination, so we may re-purpose
  66  * this return value and simplify the idiom "str ? xstrdup(str) : NULL".
  67  */
  68 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
  69 char *xstrndup(const char *str, size_t n) ATTRIBUTE_MALLOC;
  70
  71 #endif /* !STRACE_XMALLOC_H */