| 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 <adt/hash_table.h>
|
|---|
| 40 | #include <adt/hash.h>
|
|---|
| 41 | #include <adt/list.h>
|
|---|
| 42 | #include <atomic.h>
|
|---|
| 43 | #include <lib/ra.h>
|
|---|
| 44 | #include <lib/refcount.h>
|
|---|
| 45 | #include <synch/mutex.h>
|
|---|
| 46 | #include <typedefs.h>
|
|---|
| 47 |
|
|---|
| 48 | typedef enum {
|
|---|
| 49 | CAP_STATE_FREE,
|
|---|
| 50 | CAP_STATE_ALLOCATED,
|
|---|
| 51 | CAP_STATE_PUBLISHED
|
|---|
| 52 | } cap_state_t;
|
|---|
| 53 |
|
|---|
| 54 | typedef enum {
|
|---|
| 55 | KOBJECT_TYPE_CALL,
|
|---|
| 56 | KOBJECT_TYPE_IRQ,
|
|---|
| 57 | KOBJECT_TYPE_PHONE,
|
|---|
| 58 | KOBJECT_TYPE_WAITQ,
|
|---|
| 59 | KOBJECT_TYPE_MAX
|
|---|
| 60 | } kobject_type_t;
|
|---|
| 61 |
|
|---|
| 62 | struct kobject;
|
|---|
| 63 |
|
|---|
| 64 | typedef struct kobject_ops {
|
|---|
| 65 | void (*destroy)(struct kobject *);
|
|---|
| 66 | } kobject_ops_t;
|
|---|
| 67 |
|
|---|
| 68 | extern kobject_ops_t *kobject_ops[];
|
|---|
| 69 |
|
|---|
| 70 | #define KOBJECT_OP(k) kobject_ops[(k)->type]
|
|---|
| 71 |
|
|---|
| 72 | /*
|
|---|
| 73 | * Everything in kobject_t except for the atomic reference count, the capability
|
|---|
| 74 | * list and its lock is immutable.
|
|---|
| 75 | */
|
|---|
| 76 | typedef struct kobject {
|
|---|
| 77 | kobject_type_t type;
|
|---|
| 78 | atomic_refcount_t refcnt;
|
|---|
| 79 |
|
|---|
| 80 | /** Mutex protecting caps_list */
|
|---|
| 81 | mutex_t caps_list_lock;
|
|---|
| 82 | /** List of published capabilities associated with the kobject */
|
|---|
| 83 | list_t caps_list;
|
|---|
| 84 | } kobject_t;
|
|---|
| 85 |
|
|---|
| 86 | /*
|
|---|
| 87 | * A cap_t may only be accessed under the protection of the cap_info_t lock.
|
|---|
| 88 | */
|
|---|
| 89 | typedef struct cap {
|
|---|
| 90 | cap_state_t state;
|
|---|
| 91 |
|
|---|
| 92 | struct task *task;
|
|---|
| 93 | cap_handle_t handle;
|
|---|
| 94 |
|
|---|
| 95 | /** Link to the kobject's list of capabilities. */
|
|---|
| 96 | link_t kobj_link;
|
|---|
| 97 |
|
|---|
| 98 | /* Link to the task's capabilities of the same kobject type. */
|
|---|
| 99 | link_t type_link;
|
|---|
| 100 |
|
|---|
| 101 | ht_link_t caps_link;
|
|---|
| 102 |
|
|---|
| 103 | /* The underlying kernel object. */
|
|---|
| 104 | kobject_t *kobject;
|
|---|
| 105 | } cap_t;
|
|---|
| 106 |
|
|---|
| 107 | typedef struct cap_info {
|
|---|
| 108 | mutex_t lock;
|
|---|
| 109 |
|
|---|
| 110 | list_t type_list[KOBJECT_TYPE_MAX];
|
|---|
| 111 |
|
|---|
| 112 | hash_table_t caps;
|
|---|
| 113 | ra_arena_t *handles;
|
|---|
| 114 | } cap_info_t;
|
|---|
| 115 |
|
|---|
| 116 | extern void caps_init(void);
|
|---|
| 117 | extern errno_t caps_task_alloc(struct task *);
|
|---|
| 118 | extern void caps_task_free(struct task *);
|
|---|
| 119 | extern void caps_task_clear(struct task *task);
|
|---|
| 120 | extern errno_t caps_task_init(struct task *);
|
|---|
| 121 | extern bool caps_apply_to_kobject_type(struct task *, kobject_type_t,
|
|---|
| 122 | bool (*)(cap_t *, void *), void *);
|
|---|
| 123 |
|
|---|
| 124 | extern errno_t cap_alloc(struct task *, cap_handle_t *);
|
|---|
| 125 | extern void cap_publish(struct task *, cap_handle_t, kobject_t *);
|
|---|
| 126 | extern kobject_t *cap_unpublish(struct task *, cap_handle_t, kobject_type_t);
|
|---|
| 127 | extern void cap_revoke(kobject_t *);
|
|---|
| 128 | extern void cap_free(struct task *, cap_handle_t);
|
|---|
| 129 |
|
|---|
| 130 | extern void kobject_initialize(kobject_t *, kobject_type_t);
|
|---|
| 131 | extern kobject_t *kobject_get(struct task *, cap_handle_t, kobject_type_t);
|
|---|
| 132 | extern void kobject_add_ref(kobject_t *);
|
|---|
| 133 | extern void kobject_put(kobject_t *);
|
|---|
| 134 |
|
|---|
| 135 | #endif
|
|---|
| 136 |
|
|---|
| 137 | /** @}
|
|---|
| 138 | */
|
|---|
