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