osfmk/ddb/db_task_thread.h

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