root/maint/gnulib/lib/pagealign_alloc.h

/* */

INCLUDED FROM

   1 /* Memory allocation aligned to system page boundaries.
   2 
   3    Copyright (C) 2005, 2008, 2010-2021 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 <https://www.gnu.org/licenses/>.  */
  17 
  18 #ifndef _PAGEALIGN_ALLOC_H
  19 # define _PAGEALIGN_ALLOC_H
  20 
  21 # include <stddef.h>
  22 
  23 /* Free a memory block.
  24    PTR must be a non-NULL pointer returned by pagealign_alloc or
  25    pagealign_xalloc.  */
  26 extern void pagealign_free (void *ptr)
  27   _GL_ATTRIBUTE_NONNULL ((1));
  28 
  29 /* Allocate a block of memory of SIZE bytes, aligned on a system page
  30    boundary.
  31    If SIZE is not a multiple of the system page size, it will be rounded up
  32    to the next multiple.
  33    Return a pointer to the start of the memory block. Upon allocation failure,
  34    return NULL and set errno.  */
  35 extern void *pagealign_alloc (size_t size)
  36   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC (pagealign_free, 1)
  37   _GL_ATTRIBUTE_ALLOC_SIZE ((1));
  38 
  39 /* Like pagealign_alloc, except it exits the program if the allocation
  40    fails.  */
  41 extern void *pagealign_xalloc (size_t size)
  42   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC (pagealign_free, 1)
  43   _GL_ATTRIBUTE_ALLOC_SIZE ((1)) _GL_ATTRIBUTE_RETURNS_NONNULL;
  44 
  45 #endif /* _PAGEALIGN_ALLOC_H */

/* */