kernel/generic/include/cap/cap.h

   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 generic
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_CAP_H_
  36 #define KERN_CAP_H_
  37
  38 #include <typedefs.h>
  39 #include <adt/list.h>
  40 #include <adt/hash.h>
  41 #include <adt/hash_table.h>
  42 #include <lib/ra.h>
  43 #include <synch/mutex.h>
  44 #include <atomic.h>
  45
  46 typedef int cap_handle_t;
  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_PHONE,
  56         KOBJECT_TYPE_IRQ,
  57         KOBJECT_TYPE_MAX
  58 } kobject_type_t;
  59
  60 struct task;
  61 struct phone;
  62 struct irq;
  63
  64 struct kobject;
  65 typedef struct kobject_ops {
  66         bool (*reclaim)(struct kobject *);
  67         void (*destroy)(void *);
  68 } kobject_ops_t;
  69
  70 /*
  71  * Everything in kobject_t except for the atomic reference count is imutable.
  72  */
  73 typedef 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 phone *phone;
  82                 struct irq *irq;
  83         };
  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 task's capabilities of the same kobject type. */
  96         link_t type_link;
  97
  98         ht_link_t caps_link;
  99
 100         /* The underlying kernel object. */
 101         kobject_t *kobject;
 102 } cap_t;
 103
 104 typedef struct cap_info {
 105         mutex_t lock;
 106
 107         list_t type_list[KOBJECT_TYPE_MAX];
 108
 109         hash_table_t caps;
 110         ra_arena_t *handles;
 111 } cap_info_t;
 112
 113 extern void caps_task_alloc(struct task *);
 114 extern void caps_task_free(struct task *);
 115 extern void caps_task_init(struct task *);
 116 extern bool caps_apply_to_kobject_type(struct task *, kobject_type_t,
 117     bool (*)(cap_t *, void *), void *);
 118
 119 extern cap_handle_t cap_alloc(struct task *);
 120 extern void cap_publish(struct task *, cap_handle_t, kobject_t *);
 121 extern kobject_t *cap_unpublish(struct task *, cap_handle_t, kobject_type_t);
 122 extern void cap_free(struct task *, cap_handle_t);
 123
 124 extern void kobject_initialize(kobject_t *, kobject_type_t, void *,
 125     kobject_ops_t *);
 126 extern kobject_t *kobject_get(struct task *, cap_handle_t, kobject_type_t);
 127 extern void kobject_add_ref(kobject_t *);
 128 extern void kobject_put(kobject_t *);
 129
 130 #endif
 131
 132 /** @}
 133  */