l4/pkg/l4re_c/util/include/kumem_alloc.h

   1 /**
   2  * \file
   3  * \brief   Kumem allocator utility C interface
   4  */
   5 /*
   6  * (c) 2010 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
   7  *          Alexander Warg <warg@os.inf.tu-dresden.de>
   8  *     economic rights: Technische Universität Dresden (Germany)
   9  *
  10  * This file is part of TUD:OS and distributed under the terms of the
  11  * GNU General Public License 2.
  12  * Please see the COPYING-GPL-2 file for details.
  13  *
  14  * As a special exception, you may use this file as part of a free software
  15  * library without restriction.  Specifically, if other files instantiate
  16  * templates or use macros or inline functions from this file, or you compile
  17  * this file and link it with other files to produce an executable, this
  18  * file does not by itself cause the resulting executable to be covered by
  19  * the GNU General Public License.  This exception does not however
  20  * invalidate any other reasons why the executable file might be covered by
  21  * the GNU General Public License.
  22  */
  23 #pragma once
  24
  25 /**
  26  * \defgroup api_l4re_c_util_kumem_alloc Kumem allocator utility
  27  * \ingroup api_l4re_c
  28  * \brief Kumem allocator utility C interface.
  29  */
  30
  31 #include <l4/sys/types.h>
  32 #include <l4/sys/linkage.h>
  33
  34 EXTERN_C_BEGIN
  35
  36 /**
  37  * \brief Allocate state area.
  38  * \ingroup api_l4re_c_util_kumem_alloc
  39  *
  40  * \retval mem         Pointer to memory that has been allocated.
  41  * \retval pages_order Size to allocate, in log2 pages.
  42  * \param  task        Task to use for allocation.
  43  * \param  regmgr      Region manager to use for allocation.
  44  *
  45  * \return 0 for success, error code otherwise
  46  */
  47 L4_CV int
  48 l4re_util_kumem_alloc(l4_addr_t *mem, unsigned pages_order,
  49                       l4_cap_idx_t task, l4_cap_idx_t regmgr) L4_NOTHROW;
  50
  51 EXTERN_C_END