kernel/generic/include/proc/task.h

   1 /*
   2  * Copyright (c) 2010 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 genericproc
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_TASK_H_
  36 #define KERN_TASK_H_
  37
  38 #include <cpu.h>
  39 #include <ipc/ipc.h>
  40 #include <ipc/event.h>
  41 #include <ipc/kbox.h>
  42 #include <synch/spinlock.h>
  43 #include <synch/mutex.h>
  44 #include <synch/futex.h>
  45 #include <synch/workqueue.h>
  46 #include <adt/avl.h>
  47 #include <adt/btree.h>
  48 #include <adt/cht.h>
  49 #include <adt/list.h>
  50 #include <security/perm.h>
  51 #include <arch/proc/task.h>
  52 #include <arch/proc/thread.h>
  53 #include <arch/context.h>
  54 #include <arch/fpu_context.h>
  55 #include <arch/cpu.h>
  56 #include <mm/tlb.h>
  57 #include <proc/scheduler.h>
  58 #include <udebug/udebug.h>
  59 #include <mm/as.h>
  60 #include <abi/sysinfo.h>
  61 #include <arch.h>
  62
  63 #define TASK                 THE->task
  64
  65
  66 struct thread;
  67
  68 /** Task structure. */
  69 typedef struct task {
  70         /** Task's linkage for the tasks_tree AVL tree. */
  71         avltree_node_t tasks_tree_node;
  72
  73         /** Task lock.
  74          *
  75          * Must be acquired before threads_lock and thread lock of any of its
  76          * threads.
  77          */
  78         IRQ_SPINLOCK_DECLARE(lock);
  79
  80         char name[TASK_NAME_BUFLEN];
  81         /** List of threads contained in this task. */
  82         list_t threads;
  83         /** Address space. */
  84         as_t *as;
  85         /** Unique identity of task. */
  86         task_id_t taskid;
  87         /** Task security container. */
  88         container_id_t container;
  89
  90         /** Number of references (i.e. threads). */
  91         atomic_t refcount;
  92         /** Number of threads that haven't exited yet. */
  93         atomic_t lifecount;
  94
  95         /** Task permissions. */
  96         perm_t perms;
  97
  98         /* IPC stuff */
  99
 100         /** Receiving communication endpoint */
 101         answerbox_t answerbox;
 102
 103         /** Sending communication endpoints */
 104         phone_t phones[IPC_MAX_PHONES];
 105
 106         /** Spinlock protecting the active_calls list. */
 107         SPINLOCK_DECLARE(active_calls_lock);
 108
 109         /**
 110          * List of all calls sent by this task that have not yet been
 111          * answered.
 112          */
 113         list_t active_calls;
 114
 115         event_t events[EVENT_TASK_END - EVENT_END];
 116
 117         /** IPC statistics */
 118         stats_ipc_t ipc_info;
 119
 120 #ifdef CONFIG_UDEBUG
 121         /** Debugging stuff. */
 122         udebug_task_t udebug;
 123
 124         /** Kernel answerbox. */
 125         kbox_t kb;
 126 #endif /* CONFIG_UDEBUG */
 127
 128         /** Architecture specific task data. */
 129         task_arch_t arch;
 130
 131         struct futex_cache {
 132                 /** CHT mapping virtual addresses of futex variables to futex objects.*/
 133                 cht_t ht;
 134                 /** Serializes access to futex_list.*/
 135                 SPINLOCK_DECLARE(list_lock);
 136                 /** List of all futexes accesses by this task. */
 137                 list_t list;
 138                 work_t destroy_work;
 139         } *futexes;
 140
 141         /** Accumulated accounting. */
 142         uint64_t ucycles;
 143         uint64_t kcycles;
 144 } task_t;
 145
 146 IRQ_SPINLOCK_EXTERN(tasks_lock);
 147 extern avltree_t tasks_tree;
 148
 149 extern void task_init(void);
 150 extern void task_done(void);
 151 extern task_t *task_create(as_t *, const char *);
 152 extern void task_destroy(task_t *);
 153 extern void task_hold(task_t *);
 154 extern void task_release(task_t *);
 155 extern task_t *task_find_by_id(task_id_t);
 156 extern int task_kill(task_id_t);
 157 extern void task_kill_self(bool) __attribute__((noreturn));
 158 extern void task_get_accounting(task_t *, uint64_t *, uint64_t *);
 159 extern void task_print_list(bool);
 160
 161 extern void perm_set(task_t *, perm_t);
 162 extern perm_t perm_get(task_t *);
 163
 164 #ifndef task_create_arch
 165 extern void task_create_arch(task_t *);
 166 #endif
 167
 168 #ifndef task_destroy_arch
 169 extern void task_destroy_arch(task_t *);
 170 #endif
 171
 172 #ifdef __32_BITS__
 173 extern sysarg_t sys_task_get_id(sysarg64_t *);
 174 #endif
 175
 176 #ifdef __64_BITS__
 177 extern sysarg_t sys_task_get_id(void);
 178 #endif
 179
 180 extern sysarg_t sys_task_set_name(const char *, size_t);
 181 extern sysarg_t sys_task_kill(task_id_t *);
 182 extern sysarg_t sys_task_exit(sysarg_t);
 183
 184 #endif
 185
 186 /** @}
 187  */