lib/pagealign_alloc.h

   1 /* Memory allocation aligned to system page boundaries.
   2
   3    Copyright (C) 2005, 2008, 2010-2017 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _PAGEALIGN_ALLOC_H
  19 # define _PAGEALIGN_ALLOC_H
  20
  21 # include <stddef.h>
  22
  23 #if __GNUC__ >= 3
  24 # define _GL_ATTRIBUTE_MALLOC __attribute__ ((__malloc__))
  25 #else
  26 # define _GL_ATTRIBUTE_MALLOC
  27 #endif
  28
  29 #if ! defined __clang__ && \
  30     (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))
  31 # define _GL_ATTRIBUTE_ALLOC_SIZE(args) __attribute__ ((__alloc_size__ args))
  32 #else
  33 # define _GL_ATTRIBUTE_ALLOC_SIZE(args)
  34 #endif
  35
  36 /* Allocate a block of memory of SIZE bytes, aligned on a system page
  37    boundary.
  38    If SIZE is not a multiple of the system page size, it will be rounded up
  39    to the next multiple.
  40    Return a pointer to the start of the memory block. Upon allocation failure,
  41    return NULL and set errno.  */
  42 extern void *pagealign_alloc (size_t size)
  43      _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_ALLOC_SIZE ((1));
  44
  45 /* Like pagealign_alloc, except it exits the program if the allocation
  46    fails.  */
  47 extern void *pagealign_xalloc (size_t size)
  48      _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_ALLOC_SIZE ((1));
  49
  50 /* Free a memory block.
  51    PTR must be a non-NULL pointer returned by pagealign_alloc or
  52    pagealign_xalloc.  */
  53 extern void pagealign_free (void *ptr);
  54
  55 #endif /* _PAGEALIGN_ALLOC_H */