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  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * @OSF_COPYRIGHT@
  24  */
  25 /*
  26  * Mach Operating System
  27  * Copyright (c) 1991,1990 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie Mellon
  48  * the rights to redistribute these changes.
  49  */
  50 /*
  51  */
  52 /*
  53  *      Author: David B. Golub, Carnegie Mellon University
  54  *      Date:   7/90
  55  */
  56 /*
  57  * Command loop declarations.
  58  */
  59
  60 #ifndef _DDB_DB_COMMAND_H_
  61 #define _DDB_DB_COMMAND_H_
  62
  63 #include <machine/db_machdep.h>
  64 #include <db_machine_commands.h>
  65
  66 typedef void    (*db_func)(db_expr_t, int, db_expr_t, char *);
  67
  68 /*
  69  * Command table
  70  */
  71 struct db_command {
  72         char *  name;           /* command name */
  73         db_func fcn;            /* function to call */
  74         int     flag;           /* extra info: */
  75 #define CS_OWN          0x1         /* non-standard syntax */
  76 #define CS_MORE         0x2         /* standard syntax, but may have other
  77                                        words at end */
  78 #define CS_SET_DOT      0x100       /* set dot after command */
  79         struct db_command *more;   /* another level of command */
  80 };
  81
  82
  83 extern db_addr_t        db_dot;         /* current location */
  84 extern db_addr_t        db_last_addr;   /* last explicit address typed */
  85 extern db_addr_t        db_prev;        /* last address examined
  86                                            or written */
  87 extern db_addr_t        db_next;        /* next address to be examined
  88                                            or written */
  89
  90
  91 /* Prototypes for functions exported by this module.
  92  */
  93
  94 void db_command_loop(void);
  95
  96 void db_machine_commands_install(struct db_command *ptr);
  97
  98 boolean_t db_exec_cmd_nest(
  99         const char      *cmd,
 100         int             size);
 101
 102 void db_error(const char *s);
 103
 104 boolean_t db_option(
 105         const char      *modif,
 106         int             option);
 107
 108 #endif  /* !_DDB_DB_COMMAND_H_ */