osfmk/kern/task.h

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