1 /**
2  * \file
3  * \brief   Capability allocator C interface
4  */
5 /*
6  * (c) 2008-2009 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_cap Capability allocator
27  * \ingroup api_l4re_c
28  * \brief Capability allocator 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 Get free capability index at capability allocator
38  * \ingroup api_l4re_c_util_cap
39  */
40 L4_CV l4_cap_idx_t
41 l4re_util_cap_alloc(void) L4_NOTHROW;
42 
43 /**
44  * \brief Return capability index to capability allocator
45  * \ingroup api_l4re_c_util_cap
46  */
47 L4_CV void
48 l4re_util_cap_free(l4_cap_idx_t cap) L4_NOTHROW;
49 
50 /**
51  * \brief Return capability index to capability allocator, and unmaps the
52  *        object.
53  * \ingroup api_l4re_c_util_cap
54  */
55 L4_CV void
56 l4re_util_cap_free_um(l4_cap_idx_t cap) L4_NOTHROW;
57 
58 /**
59  * \brief Return last capability index the allocator can return
60  * \return last/biggest capability index the allocator can return
61  * \ingroup api_l4re_c_util_cap
62  */
63 L4_CV long
64 l4re_util_cap_last(void) L4_NOTHROW;
65 
66 EXTERN_C_END
67