osfmk/kern/task.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * @OSF_FREE_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
  36  * All Rights Reserved.
  37  *
  38  * Permission to use, copy, modify and distribute this software and its
  39  * documentation is hereby granted, provided that both the copyright
  40  * notice and this permission notice appear in all copies of the
  41  * software, derivative works or modified versions, and any portions
  42  * thereof, and that both notices appear in supporting documentation.
  43  *
  44  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  45  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  46  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  47  *
  48  * Carnegie Mellon requests users of this software to return to
  49  *
  50  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  51  *  School of Computer Science
  52  *  Carnegie Mellon University
  53  *  Pittsburgh PA 15213-3890
  54  *
  55  * any improvements or extensions that they make and grant Carnegie Mellon
  56  * the rights to redistribute these changes.
  57  */
  58 /*
  59  */
  60 /*
  61  *      File:   task.h
  62  *      Author: Avadis Tevanian, Jr.
  63  *
  64  *      This file contains the structure definitions for tasks.
  65  *
  66  */
  67 /*
  68  * Copyright (c) 1993 The University of Utah and
  69  * the Computer Systems Laboratory (CSL).  All rights reserved.
  70  *
  71  * Permission to use, copy, modify and distribute this software and its
  72  * documentation is hereby granted, provided that both the copyright
  73  * notice and this permission notice appear in all copies of the
  74  * software, derivative works or modified versions, and any portions
  75  * thereof, and that both notices appear in supporting documentation.
  76  *
  77  * THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS
  78  * IS" CONDITION.  THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF
  79  * ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  80  *
  81  * CSL requests users of this software to return to csl-dist@cs.utah.edu any
  82  * improvements that they make and grant CSL redistribution rights.
  83  *
  84  */
  85
  86 #ifndef _KERN_TASK_H_
  87 #define _KERN_TASK_H_
  88
  89 #include <kern/kern_types.h>
  90 #include <mach/mach_types.h>
  91 #include <sys/cdefs.h>
  92
  93 #ifdef  MACH_KERNEL_PRIVATE
  94
  95 #include <mach/boolean.h>
  96 #include <mach/port.h>
  97 #include <mach/time_value.h>
  98 #include <mach/message.h>
  99 #include <mach/mach_param.h>
 100 #include <mach/task_info.h>
 101 #include <mach/exception_types.h>
 102
 103 #include <kern/cpu_data.h>
 104 #include <kern/queue.h>
 105 #include <kern/exception.h>
 106 #include <kern/lock.h>
 107 #include <kern/thread.h>
 108
 109 #include <mach_host.h>
 110 #include <mach_prof.h>
 111
 112 struct task {
 113         /* Synchronization/destruction information */
 114         decl_mutex_data(,lock)          /* Task's lock */
 115         int             ref_count;      /* Number of references to me */
 116         boolean_t       active;         /* Task has not been terminated */
 117
 118         /* Miscellaneous */
 119         vm_map_t        map;            /* Address space description */
 120         queue_chain_t   pset_tasks;     /* list of tasks assigned to pset */
 121         void            *user_data;     /* Arbitrary data settable via IPC */
 122         int             suspend_count;  /* Internal scheduling only */
 123
 124         /* Threads in this task */
 125         queue_head_t    threads;
 126         int                             thread_count;
 127         int                             active_thread_count;
 128
 129         processor_set_t processor_set;  /* processor set for new threads */
 130 #if     MACH_HOST
 131         boolean_t       may_assign;     /* can assigned pset be changed? */
 132         boolean_t       assign_active;  /* waiting for may_assign */
 133 #endif  /* MACH_HOST */
 134
 135         /* User-visible scheduling information */
 136         integer_t               user_stop_count;        /* outstanding stops */
 137
 138         task_role_t             role;
 139
 140         integer_t               priority;                       /* base priority for threads */
 141         integer_t               max_priority;           /* maximum priority for threads */
 142
 143         /* Task security and audit tokens */
 144         security_token_t sec_token;
 145         audit_token_t   audit_token;
 146
 147         /* Statistics */
 148         uint64_t                total_user_time;        /* terminated threads only */
 149         uint64_t                total_system_time;
 150
 151 #if     MACH_PROF
 152         boolean_t       task_profiled;  /* is task being profiled ? */
 153         struct prof_data *profil_buffer;/* profile struct if so */
 154 #endif  /* MACH_PROF */
 155
 156         /* IPC structures */
 157         decl_mutex_data(,itk_lock_data)
 158         struct ipc_port *itk_self;      /* not a right, doesn't hold ref */
 159         struct ipc_port *itk_sself;     /* a send right */
 160         struct exception_action exc_actions[EXC_TYPES_COUNT];
 161                                         /* a send right each valid element  */
 162         struct ipc_port *itk_host;      /* a send right */
 163         struct ipc_port *itk_bootstrap; /* a send right */
 164         struct ipc_port *itk_registered[TASK_PORT_REGISTER_MAX];
 165                                         /* all send rights */
 166
 167         struct ipc_space *itk_space;
 168
 169         /* Synchronizer ownership information */
 170         queue_head_t    semaphore_list;         /* list of owned semaphores   */
 171         queue_head_t    lock_set_list;          /* list of owned lock sets    */
 172         int             semaphores_owned;       /* number of semaphores owned */
 173         int             lock_sets_owned;        /* number of lock sets owned  */
 174
 175         /* Ledgers */
 176         struct ipc_port *wired_ledger_port;
 177         struct ipc_port *paged_ledger_port;
 178         unsigned int    priv_flags;                     /* privilege resource flags */
 179 #define VM_BACKING_STORE_PRIV   0x1
 180
 181         integer_t faults;              /* faults counter */
 182         integer_t pageins;             /* pageins counter */
 183         integer_t cow_faults;          /* copy on write fault counter */
 184         integer_t messages_sent;       /* messages sent counter */
 185         integer_t messages_received;   /* messages received counter */
 186         integer_t syscalls_mach;       /* mach system call counter */
 187         integer_t syscalls_unix;       /* unix system call counter */
 188         integer_t csw;                 /* context switch counter */
 189 #ifdef  MACH_BSD
 190         void *bsd_info;
 191 #endif
 192         struct shared_region_mapping    *system_shared_region;
 193         struct tws_hash                 *dynamic_working_set;
 194         uint32_t taskFeatures[2];               /* Special feature for this task */
 195 #define tf64BitAddr     0x80000000              /* Task has 64-bit addressing */
 196 #define tf64BitData     0x40000000              /* Task has 64-bit data registers */
 197 #define task_has_64BitAddr(task)        \
 198          (((task)->taskFeatures[0] & tf64BitAddr) != 0)
 199 #define task_set_64BitAddr(task)        \
 200          ((task)->taskFeatures[0] |= tf64BitAddr)
 201 #define task_clear_64BitAddr(task)      \
 202          ((task)->taskFeatures[0] &= ~tf64BitAddr)
 203
 204 };
 205
 206 #define task_lock(task)         mutex_lock(&(task)->lock)
 207 #define task_lock_try(task)     mutex_try(&(task)->lock)
 208 #define task_unlock(task)       mutex_unlock(&(task)->lock)
 209
 210 #define itk_lock_init(task)     mutex_init(&(task)->itk_lock_data, 0)
 211 #define itk_lock(task)          mutex_lock(&(task)->itk_lock_data)
 212 #define itk_unlock(task)        mutex_unlock(&(task)->itk_lock_data)
 213
 214 #define task_reference_internal(task)           \
 215                         hw_atomic_add(&(task)->ref_count, 1)
 216
 217 #define task_deallocate_internal(task)          \
 218                         hw_atomic_sub(&(task)->ref_count, 1)
 219
 220 #define task_reference(task)                                    \
 221 MACRO_BEGIN                                                                             \
 222         if ((task) != TASK_NULL)                                        \
 223                 task_reference_internal(task);                  \
 224 MACRO_END
 225
 226 extern kern_return_t    kernel_task_create(
 227                                                         task_t                  task,
 228                                                         vm_offset_t             map_base,
 229                                                         vm_size_t               map_size,
 230                                                         task_t                  *child);
 231
 232 /* Initialize task module */
 233 extern void             task_init(void);
 234
 235 #define current_task_fast()     (current_thread()->task)
 236 #define current_task()          current_task_fast()
 237
 238 #else   /* MACH_KERNEL_PRIVATE */
 239
 240 __BEGIN_DECLS
 241
 242 extern task_t   current_task(void);
 243
 244 extern void             task_reference(task_t   task);
 245
 246 __END_DECLS
 247
 248 #endif  /* MACH_KERNEL_PRIVATE */
 249
 250 __BEGIN_DECLS
 251
 252 #ifdef  XNU_KERNEL_PRIVATE
 253
 254 /* Hold all threads in a task */
 255 extern kern_return_t    task_hold(
 256                                                         task_t          task);
 257
 258 /* Release hold on all threads in a task */
 259 extern kern_return_t    task_release(
 260                                                         task_t          task);
 261
 262 /* Halt all other threads in the current task */
 263 extern kern_return_t    task_halt(
 264                                                         task_t          task);
 265
 266 extern kern_return_t    task_terminate_internal(
 267                                                         task_t                  task);
 268
 269 extern kern_return_t    task_create_internal(
 270                                                         task_t          parent_task,
 271                                                         boolean_t       inherit_memory,
 272                                                         task_t          *child_task);   /* OUT */
 273
 274 extern kern_return_t    task_importance(
 275                                                         task_t                  task,
 276                                                         integer_t               importance);
 277
 278 extern void             task_set_64bit(
 279                                         task_t          task,
 280                                         boolean_t       is64bit);
 281
 282 extern void             task_backing_store_privileged(
 283                                         task_t          task);
 284
 285 extern void             task_working_set_disable(
 286                                         task_t          task);
 287
 288 /* Get number of activations in a task */
 289 extern int              get_task_numacts(
 290                                         task_t          task);
 291
 292
 293 /* JMM - should just be temporary (implementation in bsd_kern still) */
 294 extern void     set_bsdtask_info(task_t,void *);
 295 extern vm_map_t get_task_map_reference(task_t);
 296 extern vm_map_t swap_task_map(task_t, vm_map_t);
 297 extern pmap_t   get_task_pmap(task_t);
 298
 299 extern boolean_t        is_kerneltask(task_t task);
 300
 301 #endif  /* XNU_KERNEL_PRIVATE */
 302
 303 #ifdef  KERNEL_PRIVATE
 304
 305 extern void     *get_bsdtask_info(task_t);
 306 extern vm_map_t get_task_map(task_t);
 307
 308 #endif  /* KERNEL_PRIVATE */
 309
 310 extern task_t   kernel_task;
 311
 312 extern void             task_deallocate(
 313                                         task_t          task);
 314
 315 __END_DECLS
 316
 317 #endif  /* _KERN_TASK_H_ */