gdb/memory-map.c

   1 /* Routines for handling XML memory maps provided by target.
   2
   3    Copyright (C) 2006-2014 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "defs.h"
  21 #include "memory-map.h"
  22 #include "exceptions.h"
  23
  24 #if !defined(HAVE_LIBEXPAT)
  25
  26 VEC(mem_region_s) *
  27 parse_memory_map (const char *memory_map)
  28 {
  29   static int have_warned;
  30
  31   if (!have_warned)
  32     {
  33       have_warned = 1;
  34       warning (_("Can not parse XML memory map; XML support was disabled "
  35                  "at compile time"));
  36     }
  37
  38   return NULL;
  39 }
  40
  41 #else /* HAVE_LIBEXPAT */
  42
  43 #include "xml-support.h"
  44
  45 /* Internal parsing data passed to all XML callbacks.  */
  46 struct memory_map_parsing_data
  47   {
  48     VEC(mem_region_s) **memory_map;
  49     char property_name[32];
  50   };
  51
  52 /* Handle the start of a <memory> element.  */
  53
  54 static void
  55 memory_map_start_memory (struct gdb_xml_parser *parser,
  56                          const struct gdb_xml_element *element,
  57                          void *user_data, VEC(gdb_xml_value_s) *attributes)
  58 {
  59   struct memory_map_parsing_data *data = user_data;
  60   struct mem_region *r = VEC_safe_push (mem_region_s, *data->memory_map, NULL);
  61   ULONGEST *start_p, *length_p, *type_p;
  62
  63   start_p = xml_find_attribute (attributes, "start")->value;
  64   length_p = xml_find_attribute (attributes, "length")->value;
  65   type_p = xml_find_attribute (attributes, "type")->value;
  66
  67   mem_region_init (r);
  68   r->lo = *start_p;
  69   r->hi = r->lo + *length_p;
  70   r->attrib.mode = *type_p;
  71   r->attrib.blocksize = -1;
  72 }
  73
  74 /* Handle the end of a <memory> element.  Verify that any necessary
  75    children were present.  */
  76
  77 static void
  78 memory_map_end_memory (struct gdb_xml_parser *parser,
  79                        const struct gdb_xml_element *element,
  80                        void *user_data, const char *body_text)
  81 {
  82   struct memory_map_parsing_data *data = user_data;
  83   struct mem_region *r = VEC_last (mem_region_s, *data->memory_map);
  84
  85   if (r->attrib.mode == MEM_FLASH && r->attrib.blocksize == -1)
  86     gdb_xml_error (parser, _("Flash block size is not set"));
  87 }
  88
  89 /* Handle the start of a <property> element by saving the name
  90    attribute for later.  */
  91
  92 static void
  93 memory_map_start_property (struct gdb_xml_parser *parser,
  94                            const struct gdb_xml_element *element,
  95                            void *user_data, VEC(gdb_xml_value_s) *attributes)
  96 {
  97   struct memory_map_parsing_data *data = user_data;
  98   char *name;
  99
 100   name = xml_find_attribute (attributes, "name")->value;
 101   snprintf (data->property_name, sizeof (data->property_name), "%s", name);
 102 }
 103
 104 /* Handle the end of a <property> element and its value.  */
 105
 106 static void
 107 memory_map_end_property (struct gdb_xml_parser *parser,
 108                          const struct gdb_xml_element *element,
 109                          void *user_data, const char *body_text)
 110 {
 111   struct memory_map_parsing_data *data = user_data;
 112   char *name = data->property_name;
 113
 114   if (strcmp (name, "blocksize") == 0)
 115     {
 116       struct mem_region *r = VEC_last (mem_region_s, *data->memory_map);
 117
 118       r->attrib.blocksize = gdb_xml_parse_ulongest (parser, body_text);
 119     }
 120   else
 121     gdb_xml_debug (parser, _("Unknown property \"%s\""), name);
 122 }
 123
 124 /* Discard the constructed memory map (if an error occurs).  */
 125
 126 static void
 127 clear_result (void *p)
 128 {
 129   VEC(mem_region_s) **result = p;
 130   VEC_free (mem_region_s, *result);
 131   *result = NULL;
 132 }
 133
 134 /* The allowed elements and attributes for an XML memory map.  */
 135
 136 const struct gdb_xml_attribute property_attributes[] = {
 137   { "name", GDB_XML_AF_NONE, NULL, NULL },
 138   { NULL, GDB_XML_AF_NONE, NULL, NULL }
 139 };
 140
 141 const struct gdb_xml_element memory_children[] = {
 142   { "property", property_attributes, NULL,
 143     GDB_XML_EF_REPEATABLE | GDB_XML_EF_OPTIONAL,
 144     memory_map_start_property, memory_map_end_property },
 145   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 146 };
 147
 148 const struct gdb_xml_enum memory_type_enum[] = {
 149   { "ram", MEM_RW },
 150   { "rom", MEM_RO },
 151   { "flash", MEM_FLASH },
 152   { NULL, 0 }
 153 };
 154
 155 const struct gdb_xml_attribute memory_attributes[] = {
 156   { "start", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
 157   { "length", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
 158   { "type", GDB_XML_AF_NONE, gdb_xml_parse_attr_enum, &memory_type_enum },
 159   { NULL, GDB_XML_AF_NONE, NULL, NULL }
 160 };
 161
 162 const struct gdb_xml_element memory_map_children[] = {
 163   { "memory", memory_attributes, memory_children, GDB_XML_EF_REPEATABLE,
 164     memory_map_start_memory, memory_map_end_memory },
 165   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 166 };
 167
 168 const struct gdb_xml_element memory_map_elements[] = {
 169   { "memory-map", NULL, memory_map_children, GDB_XML_EF_NONE,
 170     NULL, NULL },
 171   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 172 };
 173
 174 VEC(mem_region_s) *
 175 parse_memory_map (const char *memory_map)
 176 {
 177   VEC(mem_region_s) *result = NULL;
 178   struct cleanup *back_to;
 179   struct memory_map_parsing_data data = { NULL };
 180
 181   data.memory_map = &result;
 182   back_to = make_cleanup (clear_result, &result);
 183   if (gdb_xml_parse_quick (_("target memory map"), NULL, memory_map_elements,
 184                            memory_map, &data) == 0)
 185     {
 186       /* Parsed successfully, keep the result.  */
 187       discard_cleanups (back_to);
 188       return result;
 189     }
 190
 191   do_cleanups (back_to);
 192   return NULL;
 193 }
 194
 195 #endif /* HAVE_LIBEXPAT */