osfmk/ddb/db_task_thread.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * @OSF_COPYRIGHT@
  27  */
  28 /*
  29  * Mach Operating System
  30  * Copyright (c) 1991,1990 Carnegie Mellon University
  31  * All Rights Reserved.
  32  *
  33  * Permission to use, copy, modify and distribute this software and its
  34  * documentation is hereby granted, provided that both the copyright
  35  * notice and this permission notice appear in all copies of the
  36  * software, derivative works or modified versions, and any portions
  37  * thereof, and that both notices appear in supporting documentation.
  38  *
  39  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  40  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  41  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  42  *
  43  * Carnegie Mellon requests users of this software to return to
  44  *
  45  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  46  *  School of Computer Science
  47  *  Carnegie Mellon University
  48  *  Pittsburgh PA 15213-3890
  49  *
  50  * any improvements or extensions that they make and grant Carnegie Mellon
  51  * the rights to redistribute these changes.
  52  */
  53 /*
  54  */
  55
  56 #ifndef _DDB_DB_TASK_THREAD_H_
  57 #define _DDB_DB_TASK_THREAD_H_
  58
  59 #include <kern/task.h>
  60 #include <kern/thread.h>
  61 #include <kern/processor.h>
  62 #include <ddb/db_variables.h>           /* For db_var_aux_param_t */
  63
  64 /*
  65  * On behalf of kernel-loaded tasks, distinguish between current task
  66  * (=> symbol table) and current address space (=> where [e.g.]
  67  * breakpoints are set).  From ddb's perspective, kernel-loaded tasks
  68  * can retain their own symbol tables, but share the kernel's address
  69  * space.
  70  */
  71 #define db_current_task()                                               \
  72                 ((current_act())? current_act()->task: TASK_NULL)
  73 #define db_current_space()                                              \
  74                 ((current_act())?\
  75                         current_act()->task: TASK_NULL)
  76 #define db_target_space(thr_act, user_space)                            \
  77                 ((!(user_space) || ((thr_act)))?\
  78                         TASK_NULL:                                      \
  79                         (thr_act)?                                      \
  80                                 (thr_act)->task: db_current_space())
  81 #define db_is_current_space(task)                                       \
  82                 ((task) == TASK_NULL || (task) == db_current_space())
  83
  84 extern task_t           db_default_task;        /* default target task */
  85 extern thread_act_t     db_default_act;         /* default target thr_act */
  86
  87
  88 /* Prototypes for functions exported by this module.
  89  */
  90
  91 int db_lookup_act(thread_act_t target_act);
  92
  93 int db_lookup_task(task_t target_task);
  94
  95 int db_lookup_task_act(
  96         task_t          task,
  97         thread_act_t            target_act);
  98
  99 boolean_t db_check_act_address_valid(thread_act_t thr_act);
 100
 101 boolean_t db_get_next_act(
 102         thread_act_t            *actp,
 103         int             position);
 104
 105 void db_init_default_act(void);
 106
 107 int db_set_default_act(
 108         struct db_variable      *vp,
 109         db_expr_t               *valuep,
 110         int                     flag,
 111         db_var_aux_param_t      ap);
 112
 113 int db_get_task_act(
 114         struct db_variable      *vp,
 115         db_expr_t               *valuep,
 116         int                     flag,
 117         db_var_aux_param_t      ap);
 118
 119 #endif  /* !_DDB_DB_TASK_THREAD_H_ */