summaryrefslogtreecommitdiff
path: root/usr/src/cmd/sgs/demo_rdb/common/help.c
blob: 49204b33ef5e99c8c1a6f39f6ebb99320c77f18b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
 */

#include <stdio.h>
#include <libelf.h>
#include <string.h>

#include "rdb.h"

typedef struct {
	char	*ht_key;		/* HELP keyword for topic */
	char	*ht_desc;		/* description of topic */
	void	(*ht_func)();		/* detailed info on topic */
} help_topics;

static void
break_help()
{
	(void) printf("Break Help:\n"
	    "\tbreak            - list breakpoints\n"
	    "\tbreak <address>  - set break point at <address\n");
}

static void
delete_help()
{
	(void) printf("Delete Help:\n"
	    "\tdelete <address> - delete breakpoint at <address>\n");
}

static void
dis_help()
{
	(void) printf("Disassemble Help:\n"
	    "\tdis -\t\t\tdisassemble from current PC\n"
	    "\tdis <address> [count] -\tdisassemble from address for\n"
	    "\t\t\t\t<count> instructions\n");
}

static void
echo_help()
{
	(void) printf("Echo Help:\n"
	    "\tEcho '<quoted string>'\n"
	    "\t\tthe echo command can be used to display output to\n"
	    "\t\tthe main terminal.  This is useful when running\n"
	    "\t\tcommand scripts and wanting to display status\n"
	    "\n"
	    "\t\tcurrently only <quoted strings> may be displayed\n");
}

static void
print_help()
{
	(void) printf("Print Help:\n"
	    "\tprint <address> [count [format]]\n"
	    "\t\tcount  - number of units to print (default 4)\n"
	    "\t\tformat - how to display data:\n"
	    "\t\t\t\tX - Hex Words (default)\n"
	    "\t\t\t\tb - unsigned hex bytes\n"
	    "\t\t\t\ts - string\n"
	    "\tprint <varname>\n"
	    "\t\thelp varname for more info\n");
}

static void
step_help()
{
	(void) printf("Step Help:\n");
	(void) printf("\tstep -		step one instruction.\n");
	(void) printf("\tstep count [silent] -	step count instructions\n");
	(void) printf("\t\t\t\tif silent is specified to not disassemble\n"
	    "\t\t\t\tinstr. during stepping\n");
}

static void
value_help()
{
	(void) printf("Value Help:\n"
	    "\tvalue <symbol name> -\tdisplay the value associated with\n"
	    "\t\t\t\tsymbol <symbol name>.\n");
}

static void
varname_help()
{
	(void) printf("Variable Name Help:\n"
	    "\tVariable names are in the form of $<name> and are used\n"
	    "\tto access special information.  Possible varnames\n"
	    "\tare:\n"
	    "\t\tcommon:\n"
	    "\t\t\t$regs - display all registers\n"
	    "\t\tsparc:\n"
	    "\t\t\t$ins -   display IN registers\n"
	    "\t\t\t$globs - display GLOBAL registers\n"
	    "\t\t\t$outs -  display OUT registers\n"
	    "\t\t\t$locs -  display LOCAL registers\n"
	    "\t\t\t$specs -  display SPECIAL registers\n"
	    "\t\ti86pc:\n");
}

static const help_topics	htops[] = {
	{
		"break",
		"Set and display breakpoints",
		break_help
	},
	{
		"cont",
		"continue execution of process",
		0
	},
	{
		"delete",
		"delete breakpoints",
		delete_help
	},
	{
		"dis",
		"Help on the Disassemble Command",
		dis_help
	},
	{
		"echo",
		"Help on the Echo Command",
		echo_help
	},
	{
		"event",
		"event [on|off] to enable or disable event information",
		0
	},
	{
		"getmaps",
		"Read Link_Map structure from run-time linker",
		0
	},
	{
		"linkmaps",
		"Display link-map information",
		0
	},
	{
		"maps",
		"Display memory mapping information",
		0
	},
	{
		"objpad",
		"Set object padding for ld.so.1 mmap'ed objects",
		0
	},
	{
		"pltskip",
		"Enables and disables stepping through PLT's",
		0
	},
	{
		"print",
		"Display memory at <address>",
		print_help
	},
	{
		"step",
		"Help on the Step Command",
		step_help
	},
	{
		"value",
		"Help on the Value Command",
		value_help
	},
	{
		"varname",
		"Help on $variable values",
		varname_help
	},
	{
		"where",
		"Display stack trace",
		0
	},
	{
		0,
		0,
		0
	}
};

void
rdb_help(const char *topic) {
	int	i;

	if (topic) {
		for (i = 0; htops[i].ht_key; i++) {
			if (strcmp(htops[i].ht_key, topic) == 0) {
				if (htops[i].ht_func)
					htops[i].ht_func();
				else
					(void) printf("no additional help "
					    "available for %s\n",
					    htops[i].ht_key);
				return;
			}
		}
		(void) printf("Help not available for topic: %s\n", topic);
	}

	(void) printf("The following commands are available\n");

	for (i = 0; htops[i].ht_key; i++) {
		(void) printf("\t%10s\t%s", htops[i].ht_key, htops[i].ht_desc);
		if (htops[i].ht_func)
			(void) putchar('*');
		(void) putchar('\n');
	}
	(void) printf("\n(*) more help is available by typing "
	    "'help <topic>'\n\n");
}