1 /* Kernel Object Display facility for Cisco
2 Copyright (C) 1999, 2000 Free Software Foundation, Inc.
4 Written by Tom Tromey <tromey@cygnus.com>.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
24 #include "gdb_string.h"
31 /* Define this to turn off communication with target. */
32 /* #define FAKE_PACKET */
34 /* Size of buffer used for remote communication. */
37 /* Pointers to gdb callbacks. */
38 static void (*gdb_kod_display) (char *);
39 static void (*gdb_kod_query) (char *, char *, int *);
43 /* Initialize and return library name and version.
44 The gdb side of KOD, kod.c, passes us two functions: one for
45 displaying output (presumably to the user) and the other for
46 querying the target. */
48 cisco_kod_open (kod_display_callback_ftype *display_func,
49 kod_query_callback_ftype *query_func)
55 gdb_kod_display = display_func;
56 gdb_kod_query = query_func;
58 /* Get the OS info, and check the version field. This is the stub
59 version, which we use to see whether we will understand what
60 comes back. This is lame, but the `qKoL' request doesn't
61 actually provide enough configurability.
63 Right now the only defined version number is `0.0.0'.
64 This stub supports qKoI and the `a' (any) object requests qKaL
65 and qKaI. Each `a' object is returned as a 4-byte integer ID.
66 An info request on an object returns a pair of 4-byte integers;
67 the first is the object pointer and the second is the thread ID. */
70 (*gdb_kod_query) ("oI;", buffer, &bufsiz);
72 strcpy (buffer, "Cisco IOS/Classic/13.4 0.0.0");
76 for (i = 0; count && buffer[i] != '\0'; ++i)
82 if (buffer[i] == '\0')
83 error (_("Remote returned malformed packet."));
84 if (strcmp (&buffer[i], "0.0.0"))
85 error (_("Remote returned unknown stub version: %s."), &buffer[i]);
87 /* Return name, version, and description. I hope we have enough
89 return (xstrdup ("gdbkodcisco v0.0.0 - Cisco Kernel Object Display"));
92 /* Close the connection. */
94 cisco_kod_close (void)
98 /* Print a "bad packet" message. */
102 (*gdb_kod_display) ("Remote target returned malformed packet.\n");
105 /* Print information about currently known kernel objects.
106 We currently ignore the argument. There is only one mode of
107 querying the Cisco kernel: we ask for a dump of everything, and
110 cisco_kod_request (char *arg, int from_tty)
112 char buffer[PBUFSIZ], command[PBUFSIZ];
116 char **sync_ids = NULL;
119 char *prev_id = NULL;
121 if (! arg || strcmp (arg, "any"))
123 /* "Top-level" command. This is really silly, but it also seems
124 to be how KOD is defined. */
125 /* Even sillier is the fact that this first line must start
126 with the word "List". See kod.tcl. */
127 (*gdb_kod_display) ("List of Cisco Kernel Objects\n");
128 (*gdb_kod_display) ("Object\tDescription\n");
129 (*gdb_kod_display) ("any\tAny and all objects\n");
135 int off = 0; /* Where we are in the string. */
136 long count; /* Number of objects in this packet. */
137 int bufsiz = PBUFSIZ;
140 strcpy (command, "aL");
143 strcat (command, ",");
144 strcat (command, prev_id);
146 strcat (command, ";");
149 /* We talk to the target by calling through the query function
150 passed to us when we were initialized. */
151 (*gdb_kod_query) (command, buffer, &bufsiz);
153 /* Fake up a multi-part packet. */
154 if (! strncmp (&command[3], "a500005a", 8))
155 strcpy (buffer, "KAL,01,1,f500005f;f500005f;");
157 strcpy (buffer, "KAL,02,0,a500005a;a500005a;de02869f;");
160 /* Empty response is an error. */
161 if (strlen (buffer) == 0)
163 (*gdb_kod_display) ("Remote target did not recognize kernel object query command.\n");
168 /* If we don't get a `K' response then the buffer holds the
169 target's error message. */
170 if (buffer[0] != 'K')
172 (*gdb_kod_display) (buffer);
177 /* Make sure we get the response we expect. */
178 if (strncmp (buffer, "KAL,", 4))
186 /* Parse out the count. We expect to convert exactly two
187 characters followed by a comma. */
188 count = strtol (&buffer[off], &s_end, 16);
189 if (s_end - &buffer[off] != 2 || buffer[off + 2] != ',')
197 /* Parse out the `done' flag. */
198 if ((buffer[off] != '0' && buffer[off] != '1')
199 || buffer[off + 1] != ',')
205 done = buffer[off] == '1';
208 /* Id of the last item; we might this to construct the next
210 prev_id = &buffer[off];
211 if (strlen (prev_id) < 8 || buffer[off + 8] != ';')
217 buffer[off + 8] = '\0';
221 sync_ids = (char **) xrealloc (sync_ids, sync_len * sizeof (char *));
223 for (i = 0; i < count; ++i)
225 if (strlen (&buffer[off]) < 8 || buffer[off + 8] != ';')
231 buffer[off + 8] = '\0';
232 sync_ids[sync_next++] = xstrdup (&buffer[off]);
236 if (buffer[off] != '\0')
244 /* We've collected all the sync object IDs. Now query to get the
245 specific information, and arrange to print this info. */
248 (*gdb_kod_display) ("Object ID\tObject Pointer\tThread ID\n");
250 for (i = 0; i < sync_next; ++i)
253 int bufsiz = PBUFSIZ;
255 /* For now assume a query can be accomplished in a single
256 transaction. This is implied in the protocol document.
257 See comments above, and the KOD protocol document, to
258 understand the parsing of the return value. */
259 strcpy (command, "aI,");
260 strcat (command, sync_ids[i]);
261 strcat (command, ";");
264 (*gdb_kod_query) (command, buffer, &bufsiz);
266 strcpy (buffer, "KAI,");
267 strcat (buffer, sync_ids[i]);
268 strcat (buffer, ",ffef00a0,cd00123d;");
271 if (strlen (buffer) == 0)
273 (*gdb_kod_display) ("Remote target did not recognize KOD command.\n");
277 if (strncmp (buffer, "KAI,", 4))
284 if (strncmp (&buffer[off], sync_ids[i], 8)
285 || buffer[off + 8] != ',')
292 /* Extract thread id and sync object pointer. */
293 if (strlen (&buffer[off]) != 2 * 8 + 2
294 || buffer[off + 8] != ','
295 || buffer[off + 17] != ';')
301 buffer[off + 8] = '\0';
302 buffer[off + 17] = '\0';
304 /* Display the result. */
305 (*gdb_kod_display) (sync_ids[i]);
306 (*gdb_kod_display) ("\t");
307 (*gdb_kod_display) (&buffer[off]);
308 (*gdb_kod_display) ("\t");
309 (*gdb_kod_display) (&buffer[off + 9]);
310 (*gdb_kod_display) ("\n");
315 for (i = 0; i < sync_next; ++i)