osfmk/ddb/db_command.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_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  *      Author: David B. Golub, Carnegie Mellon University
  60  *      Date:   7/90
  61  */
  62 /*
  63  * Command loop declarations.
  64  */
  65
  66 #ifndef _DDB_DB_COMMAND_H_
  67 #define _DDB_DB_COMMAND_H_
  68
  69 #include <machine/db_machdep.h>
  70 #include <db_machine_commands.h>
  71
  72 typedef void    (*db_func)(db_expr_t, boolean_t, db_expr_t, char *);
  73
  74 /*
  75  * Command table
  76  */
  77 struct db_command {
  78         const char *name;       /* command name */
  79         db_func fcn;            /* function to call */
  80         int     flag;           /* extra info: */
  81 #define CS_OWN          0x1         /* non-standard syntax */
  82 #define CS_MORE         0x2         /* standard syntax, but may have other
  83                                        words at end */
  84 #define CS_SET_DOT      0x100       /* set dot after command */
  85         struct db_command *more;   /* another level of command */
  86 };
  87
  88
  89 extern db_addr_t        db_dot;         /* current location */
  90 extern db_addr_t        db_last_addr;   /* last explicit address typed */
  91 extern db_addr_t        db_prev;        /* last address examined
  92                                            or written */
  93 extern db_addr_t        db_next;        /* next address to be examined
  94                                            or written */
  95
  96
  97 /* Prototypes for functions exported by this module.
  98  */
  99
 100 void db_command_loop(void);
 101
 102 void db_machine_commands_install(struct db_command *ptr);
 103
 104 boolean_t db_exec_cmd_nest(
 105         const char      *cmd,
 106         int             size);
 107
 108 void db_error(const char *s);
 109
 110 boolean_t db_option(
 111         const char      *modif,
 112         int             option);
 113
 114 #endif  /* !_DDB_DB_COMMAND_H_ */