osfmk/ddb/db_task_thread.h

   1 /*
   2  * Copyright (c) 2000 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_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991,1990 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 #ifndef _DDB_DB_TASK_THREAD_H_
  62 #define _DDB_DB_TASK_THREAD_H_
  63
  64 #include <kern/task.h>
  65 #include <kern/thread.h>
  66 #include <kern/processor.h>
  67 #include <ddb/db_variables.h>           /* For db_var_aux_param_t */
  68
  69 /*
  70  * On behalf of kernel-loaded tasks, distinguish between current task
  71  * (=> symbol table) and current address space (=> where [e.g.]
  72  * breakpoints are set).  From ddb's perspective, kernel-loaded tasks
  73  * can retain their own symbol tables, but share the kernel's address
  74  * space.
  75  */
  76 #define db_current_task()                                               \
  77                 ((current_thread())? current_thread()->task: TASK_NULL)
  78 #define db_current_space()                                              \
  79                 ((current_thread())?\
  80                         current_thread()->task: TASK_NULL)
  81 #define db_target_space(thr_act, user_space)                            \
  82                 ((!(user_space) || ((thr_act)))?\
  83                         TASK_NULL:                                      \
  84                         (thr_act)?                                      \
  85                                 (thr_act)->task: db_current_space())
  86 #define db_is_current_space(task)                                       \
  87                 ((task) == TASK_NULL || (task) == db_current_space())
  88
  89 extern task_t           db_default_task;        /* default target task */
  90 extern thread_t db_default_act;         /* default target thr_act */
  91
  92
  93 /* Prototypes for functions exported by this module.
  94  */
  95
  96 int db_lookup_act(thread_t target_act);
  97
  98 int db_lookup_task(task_t target_task);
  99
 100 int db_lookup_task_act(
 101         task_t          task,
 102         thread_t                target_act);
 103
 104 boolean_t db_check_act_address_valid(thread_t thr_act);
 105
 106 boolean_t db_get_next_act(
 107         thread_t                *actp,
 108         int             position);
 109
 110 void db_init_default_act(void);
 111
 112 int db_set_default_act(
 113         struct db_variable      *vp,
 114         db_expr_t               *valuep,
 115         int                     flag,
 116         db_var_aux_param_t      ap);
 117
 118 int db_get_task_act(
 119         struct db_variable      *vp,
 120         db_expr_t               *valuep,
 121         int                     flag,
 122         db_var_aux_param_t      ap);
 123
 124 #endif  /* !_DDB_DB_TASK_THREAD_H_ */