source: mainline/kernel/generic/include/cap/cap.h@ 174156fd

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 174156fd was 174156fd, checked in by Jakub Jermar <jakub@…>, 7 years ago

Disambiguate doxygroup generic*

  • Property mode set to 100644
File size: 3.5 KB
Line 
1/*
2 * Copyright (c) 2017 Jakub Jermar
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup kernel_generic
30 * @{
31 */
32/** @file
33 */
34
35#ifndef KERN_CAP_H_
36#define KERN_CAP_H_
37
38#include <abi/cap.h>
39#include <typedefs.h>
40#include <adt/list.h>
41#include <adt/hash.h>
42#include <adt/hash_table.h>
43#include <lib/ra.h>
44#include <synch/mutex.h>
45#include <atomic.h>
46
47typedef enum {
48 CAP_STATE_FREE,
49 CAP_STATE_ALLOCATED,
50 CAP_STATE_PUBLISHED
51} cap_state_t;
52
53typedef enum {
54 KOBJECT_TYPE_CALL,
55 KOBJECT_TYPE_IRQ,
56 KOBJECT_TYPE_PHONE,
57 KOBJECT_TYPE_MAX
58} kobject_type_t;
59
60struct task;
61
62struct call;
63struct irq;
64struct phone;
65
66typedef struct kobject_ops {
67 void (*destroy)(void *);
68} kobject_ops_t;
69
70/*
71 * Everything in kobject_t except for the atomic reference count is imutable.
72 */
73typedef struct kobject {
74 kobject_type_t type;
75 atomic_t refcnt;
76
77 kobject_ops_t *ops;
78
79 union {
80 void *raw;
81 struct call *call;
82 struct irq *irq;
83 struct phone *phone;
84 };
85} kobject_t;
86
87/*
88 * A cap_t may only be accessed under the protection of the cap_info_t lock.
89 */
90typedef struct cap {
91 cap_state_t state;
92
93 struct task *task;
94 cap_handle_t handle;
95
96 /* Link to the task's capabilities of the same kobject type. */
97 link_t type_link;
98
99 ht_link_t caps_link;
100
101 /* The underlying kernel object. */
102 kobject_t *kobject;
103} cap_t;
104
105typedef struct cap_info {
106 mutex_t lock;
107
108 list_t type_list[KOBJECT_TYPE_MAX];
109
110 hash_table_t caps;
111 ra_arena_t *handles;
112} cap_info_t;
113
114extern void caps_init(void);
115extern errno_t caps_task_alloc(struct task *);
116extern void caps_task_free(struct task *);
117extern void caps_task_init(struct task *);
118extern bool caps_apply_to_kobject_type(struct task *, kobject_type_t,
119 bool (*)(cap_t *, void *), void *);
120
121extern errno_t cap_alloc(struct task *, cap_handle_t *);
122extern void cap_publish(struct task *, cap_handle_t, kobject_t *);
123extern kobject_t *cap_unpublish(struct task *, cap_handle_t, kobject_type_t);
124extern void cap_free(struct task *, cap_handle_t);
125
126extern void kobject_initialize(kobject_t *, kobject_type_t, void *,
127 kobject_ops_t *);
128extern kobject_t *kobject_get(struct task *, cap_handle_t, kobject_type_t);
129extern void kobject_add_ref(kobject_t *);
130extern void kobject_put(kobject_t *);
131
132#endif
133
134/** @}
135 */
Note: See TracBrowser for help on using the repository browser.