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 <ipc/ipc.h>
  40 #include <adt/list.h>
  41 #include <synch/mutex.h>
  42
  43 #define MAX_CAPS  64
  44
  45 typedef enum {
  46         CAP_TYPE_INVALID,
  47         CAP_TYPE_ALLOCATED,
  48         CAP_TYPE_PHONE,
  49         CAP_TYPE_IRQ,
  50         CAP_TYPE_MAX
  51 } cap_type_t;
  52
  53 typedef struct cap {
  54         cap_type_t type;
  55         int handle;
  56
  57         bool (* can_reclaim)(struct cap *);
  58
  59         /* Link to the task's capabilities of the same type. */
  60         link_t link;
  61
  62         /* The underlying kernel object. */
  63         void *kobject;
  64 } cap_t;
  65
  66 typedef struct cap_info {
  67         mutex_t lock;
  68
  69         list_t type_list[CAP_TYPE_MAX];
  70
  71         cap_t *caps;
  72 } cap_info_t;
  73
  74 struct task;
  75
  76 extern void caps_task_alloc(struct task *);
  77 extern void caps_task_free(struct task *);
  78 extern void caps_task_init(struct task *);
  79 extern bool caps_apply_to_type(struct task *, cap_type_t,
  80     bool (*)(cap_t *, void *), void *);
  81 extern void caps_lock(struct task *);
  82 extern void caps_unlock(struct task *);
  83
  84 extern void cap_initialize(cap_t *, int);
  85 extern cap_t *cap_get(struct task *, int, cap_type_t);
  86 extern int cap_alloc(struct task *);
  87 extern void cap_publish(struct task *, int, cap_type_t, void *);
  88 extern cap_t *cap_unpublish(struct task *, int, cap_type_t);
  89 extern void cap_free(struct task *, int);
  90
  91 #endif
  92
  93 /** @}
  94  */