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