1 /* XML target description support for GDB.
3 Copyright (C) 2006, 2008, 2009 Free Software Foundation, Inc.
5 Contributed by CodeSourcery.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "target-descriptions.h"
25 #include "xml-support.h"
26 #include "xml-tdesc.h"
29 #include "filenames.h"
31 #include "gdb_assert.h"
33 #if !defined(HAVE_LIBEXPAT)
35 /* Parse DOCUMENT into a target description. Or don't, since we don't have
38 static struct target_desc *
39 tdesc_parse_xml (const char *document, xml_fetch_another fetcher,
42 static int have_warned;
47 warning (_("Can not parse XML target description; XML support was "
48 "disabled at compile time"));
54 #else /* HAVE_LIBEXPAT */
56 /* A record of every XML description we have parsed. We never discard
57 old descriptions, because we never discard gdbarches. As long as we
58 have a gdbarch referencing this description, we want to have a copy
59 of it here, so that if we parse the same XML document again we can
60 return the same "struct target_desc *"; if they are not singletons,
61 then we will create unnecessary duplicate gdbarches. See
62 gdbarch_list_lookup_by_info. */
64 struct tdesc_xml_cache
66 const char *xml_document;
67 struct target_desc *tdesc;
69 typedef struct tdesc_xml_cache tdesc_xml_cache_s;
70 DEF_VEC_O(tdesc_xml_cache_s);
72 static VEC(tdesc_xml_cache_s) *xml_cache;
74 /* Callback data for target description parsing. */
76 struct tdesc_parsing_data
78 /* The target description we are building. */
79 struct target_desc *tdesc;
81 /* The target feature we are currently parsing, or last parsed. */
82 struct tdesc_feature *current_feature;
84 /* The register number to use for the next register we see, if
85 it does not have its own. This starts at zero. */
88 /* The union we are currently parsing, or last parsed. */
89 struct tdesc_type *current_union;
92 /* Handle the end of an <architecture> element and its value. */
95 tdesc_end_arch (struct gdb_xml_parser *parser,
96 const struct gdb_xml_element *element,
97 void *user_data, const char *body_text)
99 struct tdesc_parsing_data *data = user_data;
100 const struct bfd_arch_info *arch;
102 arch = bfd_scan_arch (body_text);
104 gdb_xml_error (parser, _("Target description specified unknown "
105 "architecture \"%s\""), body_text);
106 set_tdesc_architecture (data->tdesc, arch);
109 /* Handle the end of an <osabi> element and its value. */
112 tdesc_end_osabi (struct gdb_xml_parser *parser,
113 const struct gdb_xml_element *element,
114 void *user_data, const char *body_text)
116 struct tdesc_parsing_data *data = user_data;
117 enum gdb_osabi osabi;
119 osabi = osabi_from_tdesc_string (body_text);
120 if (osabi == GDB_OSABI_UNKNOWN)
121 warning (_("Target description specified unknown osabi \"%s\""),
124 set_tdesc_osabi (data->tdesc, osabi);
127 /* Handle the end of a <compatible> element and its value. */
130 tdesc_end_compatible (struct gdb_xml_parser *parser,
131 const struct gdb_xml_element *element,
132 void *user_data, const char *body_text)
134 struct tdesc_parsing_data *data = user_data;
135 const struct bfd_arch_info *arch;
137 arch = bfd_scan_arch (body_text);
138 tdesc_add_compatible (data->tdesc, arch);
141 /* Handle the start of a <target> element. */
144 tdesc_start_target (struct gdb_xml_parser *parser,
145 const struct gdb_xml_element *element,
146 void *user_data, VEC(gdb_xml_value_s) *attributes)
148 struct tdesc_parsing_data *data = user_data;
149 char *version = VEC_index (gdb_xml_value_s, attributes, 0)->value;
151 if (strcmp (version, "1.0") != 0)
152 gdb_xml_error (parser,
153 _("Target description has unsupported version \"%s\""),
157 /* Handle the start of a <feature> element. */
160 tdesc_start_feature (struct gdb_xml_parser *parser,
161 const struct gdb_xml_element *element,
162 void *user_data, VEC(gdb_xml_value_s) *attributes)
164 struct tdesc_parsing_data *data = user_data;
165 char *name = VEC_index (gdb_xml_value_s, attributes, 0)->value;
167 data->current_feature = tdesc_create_feature (data->tdesc, name);
170 /* Handle the start of a <reg> element. Fill in the optional
171 attributes and attach it to the containing feature. */
174 tdesc_start_reg (struct gdb_xml_parser *parser,
175 const struct gdb_xml_element *element,
176 void *user_data, VEC(gdb_xml_value_s) *attributes)
178 struct tdesc_parsing_data *data = user_data;
179 struct gdb_xml_value *attrs = VEC_address (gdb_xml_value_s, attributes);
181 char *name, *group, *type;
182 int bitsize, regnum, save_restore;
184 length = VEC_length (gdb_xml_value_s, attributes);
186 name = attrs[ix++].value;
187 bitsize = * (ULONGEST *) attrs[ix++].value;
189 if (ix < length && strcmp (attrs[ix].name, "regnum") == 0)
190 regnum = * (ULONGEST *) attrs[ix++].value;
192 regnum = data->next_regnum;
194 if (ix < length && strcmp (attrs[ix].name, "type") == 0)
195 type = attrs[ix++].value;
199 if (ix < length && strcmp (attrs[ix].name, "group") == 0)
200 group = attrs[ix++].value;
204 if (ix < length && strcmp (attrs[ix].name, "save-restore") == 0)
205 save_restore = * (ULONGEST *) attrs[ix++].value;
209 if (strcmp (type, "int") != 0
210 && strcmp (type, "float") != 0
211 && tdesc_named_type (data->current_feature, type) == NULL)
212 gdb_xml_error (parser, _("Register \"%s\" has unknown type \"%s\""),
215 tdesc_create_reg (data->current_feature, name, regnum, save_restore, group,
218 data->next_regnum = regnum + 1;
221 /* Handle the start of a <union> element. Initialize the type and
222 record it with the current feature. */
225 tdesc_start_union (struct gdb_xml_parser *parser,
226 const struct gdb_xml_element *element,
227 void *user_data, VEC(gdb_xml_value_s) *attributes)
229 struct tdesc_parsing_data *data = user_data;
230 char *id = VEC_index (gdb_xml_value_s, attributes, 0)->value;
232 data->current_union = tdesc_create_union (data->current_feature, id);
235 /* Handle the start of a <field> element. Attach the field to the
239 tdesc_start_field (struct gdb_xml_parser *parser,
240 const struct gdb_xml_element *element,
241 void *user_data, VEC(gdb_xml_value_s) *attributes)
243 struct tdesc_parsing_data *data = user_data;
244 struct gdb_xml_value *attrs = VEC_address (gdb_xml_value_s, attributes);
245 struct tdesc_type *field_type;
246 char *field_name, *field_type_id;
248 field_name = attrs[0].value;
249 field_type_id = attrs[1].value;
251 field_type = tdesc_named_type (data->current_feature, field_type_id);
252 if (field_type == NULL)
253 gdb_xml_error (parser, _("Union field \"%s\" references undefined "
255 field_name, field_type_id);
257 tdesc_add_field (data->current_union, field_name, field_type);
260 /* Handle the start of a <vector> element. Initialize the type and
261 record it with the current feature. */
264 tdesc_start_vector (struct gdb_xml_parser *parser,
265 const struct gdb_xml_element *element,
266 void *user_data, VEC(gdb_xml_value_s) *attributes)
268 struct tdesc_parsing_data *data = user_data;
269 struct gdb_xml_value *attrs = VEC_address (gdb_xml_value_s, attributes);
270 struct tdesc_type *field_type;
271 char *id, *field_type_id;
275 field_type_id = attrs[1].value;
276 count = * (ULONGEST *) attrs[2].value;
278 field_type = tdesc_named_type (data->current_feature, field_type_id);
279 if (field_type == NULL)
280 gdb_xml_error (parser, _("Vector \"%s\" references undefined type \"%s\""),
283 tdesc_create_vector (data->current_feature, id, field_type, count);
286 /* The elements and attributes of an XML target description. */
288 static const struct gdb_xml_attribute field_attributes[] = {
289 { "name", GDB_XML_AF_NONE, NULL, NULL },
290 { "type", GDB_XML_AF_NONE, NULL, NULL },
291 { NULL, GDB_XML_AF_NONE, NULL, NULL }
294 static const struct gdb_xml_element union_children[] = {
295 { "field", field_attributes, NULL, GDB_XML_EF_REPEATABLE,
296 tdesc_start_field, NULL },
297 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
300 static const struct gdb_xml_attribute reg_attributes[] = {
301 { "name", GDB_XML_AF_NONE, NULL, NULL },
302 { "bitsize", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
303 { "regnum", GDB_XML_AF_OPTIONAL, gdb_xml_parse_attr_ulongest, NULL },
304 { "type", GDB_XML_AF_OPTIONAL, NULL, NULL },
305 { "group", GDB_XML_AF_OPTIONAL, NULL, NULL },
306 { "save-restore", GDB_XML_AF_OPTIONAL,
307 gdb_xml_parse_attr_enum, gdb_xml_enums_boolean },
308 { NULL, GDB_XML_AF_NONE, NULL, NULL }
311 static const struct gdb_xml_attribute union_attributes[] = {
312 { "id", GDB_XML_AF_NONE, NULL, NULL },
313 { NULL, GDB_XML_AF_NONE, NULL, NULL }
316 static const struct gdb_xml_attribute vector_attributes[] = {
317 { "id", GDB_XML_AF_NONE, NULL, NULL },
318 { "type", GDB_XML_AF_NONE, NULL, NULL },
319 { "count", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
320 { NULL, GDB_XML_AF_NONE, NULL, NULL }
323 static const struct gdb_xml_attribute feature_attributes[] = {
324 { "name", GDB_XML_AF_NONE, NULL, NULL },
325 { NULL, GDB_XML_AF_NONE, NULL, NULL }
328 static const struct gdb_xml_element feature_children[] = {
329 { "reg", reg_attributes, NULL,
330 GDB_XML_EF_OPTIONAL | GDB_XML_EF_REPEATABLE,
331 tdesc_start_reg, NULL },
332 { "union", union_attributes, union_children,
333 GDB_XML_EF_OPTIONAL | GDB_XML_EF_REPEATABLE,
334 tdesc_start_union, NULL },
335 { "vector", vector_attributes, NULL,
336 GDB_XML_EF_OPTIONAL | GDB_XML_EF_REPEATABLE,
337 tdesc_start_vector, NULL },
338 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
341 static const struct gdb_xml_attribute target_attributes[] = {
342 { "version", GDB_XML_AF_NONE, NULL, NULL },
343 { NULL, GDB_XML_AF_NONE, NULL, NULL }
346 static const struct gdb_xml_element target_children[] = {
347 { "architecture", NULL, NULL, GDB_XML_EF_OPTIONAL,
348 NULL, tdesc_end_arch },
349 { "osabi", NULL, NULL, GDB_XML_EF_OPTIONAL,
350 NULL, tdesc_end_osabi },
351 { "compatible", NULL, NULL, GDB_XML_EF_OPTIONAL | GDB_XML_EF_REPEATABLE,
352 NULL, tdesc_end_compatible },
353 { "feature", feature_attributes, feature_children,
354 GDB_XML_EF_OPTIONAL | GDB_XML_EF_REPEATABLE,
355 tdesc_start_feature, NULL },
356 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
359 static const struct gdb_xml_element tdesc_elements[] = {
360 { "target", target_attributes, target_children, GDB_XML_EF_NONE,
361 tdesc_start_target, NULL },
362 { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
365 /* Parse DOCUMENT into a target description and return it. */
367 static struct target_desc *
368 tdesc_parse_xml (const char *document, xml_fetch_another fetcher,
371 struct cleanup *back_to, *result_cleanup;
372 struct gdb_xml_parser *parser;
373 struct tdesc_parsing_data data;
374 struct tdesc_xml_cache *cache;
378 /* Expand all XInclude directives. */
379 expanded_text = xml_process_xincludes (_("target description"),
380 document, fetcher, fetcher_baton, 0);
381 if (expanded_text == NULL)
383 warning (_("Could not load XML target description; ignoring"));
387 /* Check for an exact match in the list of descriptions we have
388 previously parsed. strcmp is a slightly inefficient way to
389 do this; an SHA-1 checksum would work as well. */
390 for (ix = 0; VEC_iterate (tdesc_xml_cache_s, xml_cache, ix, cache); ix++)
391 if (strcmp (cache->xml_document, expanded_text) == 0)
393 xfree (expanded_text);
397 back_to = make_cleanup (null_cleanup, NULL);
398 parser = gdb_xml_create_parser_and_cleanup (_("target description"),
399 tdesc_elements, &data);
400 gdb_xml_use_dtd (parser, "gdb-target.dtd");
402 memset (&data, 0, sizeof (struct tdesc_parsing_data));
403 data.tdesc = allocate_target_description ();
404 result_cleanup = make_cleanup_free_target_description (data.tdesc);
405 make_cleanup (xfree, expanded_text);
407 if (gdb_xml_parse (parser, expanded_text) == 0)
409 /* Parsed successfully. */
410 struct tdesc_xml_cache new_cache;
412 new_cache.xml_document = expanded_text;
413 new_cache.tdesc = data.tdesc;
414 VEC_safe_push (tdesc_xml_cache_s, xml_cache, &new_cache);
415 discard_cleanups (result_cleanup);
416 do_cleanups (back_to);
421 warning (_("Could not load XML target description; ignoring"));
422 do_cleanups (back_to);
426 #endif /* HAVE_LIBEXPAT */
429 /* Open FILENAME, read all its text into memory, close it, and return
430 the text. If something goes wrong, return NULL and warn. */
433 fetch_xml_from_file (const char *filename, void *baton)
435 const char *dirname = baton;
437 struct cleanup *back_to;
441 if (dirname && *dirname)
443 char *fullname = concat (dirname, "/", filename, (char *) NULL);
444 if (fullname == NULL)
446 file = fopen (fullname, FOPEN_RT);
450 file = fopen (filename, FOPEN_RT);
455 back_to = make_cleanup_fclose (file);
457 /* Read in the whole file, one chunk at a time. */
460 text = xmalloc (len);
461 make_cleanup (free_current_contents, &text);
466 /* Continue reading where the last read left off. Leave at least
467 one byte so that we can NUL-terminate the result. */
468 bytes_read = fread (text + offset, 1, len - offset - 1, file);
471 warning (_("Read error from \"%s\""), filename);
472 do_cleanups (back_to);
476 offset += bytes_read;
482 text = xrealloc (text, len);
486 discard_cleanups (back_to);
492 /* Read an XML target description from FILENAME. Parse it, and return
493 the parsed description. */
495 const struct target_desc *
496 file_read_description_xml (const char *filename)
498 struct target_desc *tdesc;
500 struct cleanup *back_to;
503 tdesc_str = fetch_xml_from_file (filename, NULL);
504 if (tdesc_str == NULL)
506 warning (_("Could not open \"%s\""), filename);
510 back_to = make_cleanup (xfree, tdesc_str);
512 dirname = ldirname (filename);
514 make_cleanup (xfree, dirname);
516 tdesc = tdesc_parse_xml (tdesc_str, fetch_xml_from_file, dirname);
517 do_cleanups (back_to);
522 /* Read a string representation of available features from the target,
523 using TARGET_OBJECT_AVAILABLE_FEATURES. The returned string is
524 malloc allocated and NUL-terminated. NAME should be a non-NULL
525 string identifying the XML document we want; the top level document
526 is "target.xml". Other calls may be performed for the DTD or
530 fetch_available_features_from_target (const char *name, void *baton_)
532 struct target_ops *ops = baton_;
534 /* Read this object as a string. This ensures that a NUL
535 terminator is added. */
536 return target_read_stralloc (ops,
537 TARGET_OBJECT_AVAILABLE_FEATURES,
542 /* Read an XML target description using OPS. Parse it, and return the
543 parsed description. */
545 const struct target_desc *
546 target_read_description_xml (struct target_ops *ops)
548 struct target_desc *tdesc;
550 struct cleanup *back_to;
552 tdesc_str = fetch_available_features_from_target ("target.xml", ops);
553 if (tdesc_str == NULL)
556 back_to = make_cleanup (xfree, tdesc_str);
557 tdesc = tdesc_parse_xml (tdesc_str,
558 fetch_available_features_from_target,
560 do_cleanups (back_to);