osfmk/ddb/db_command.h

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