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