1 /* Memory attributes support, for GDB.
3 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 Free Software Foundation, Inc.
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. */
31 #include "gdb_string.h"
33 const struct mem_attrib default_mem_attrib =
36 MEM_WIDTH_UNSPECIFIED,
40 -1 /* Flash blocksize not specified. */
43 const struct mem_attrib unknown_mem_attrib =
46 MEM_WIDTH_UNSPECIFIED,
50 -1 /* Flash blocksize not specified. */
54 VEC(mem_region_s) *mem_region_list, *target_mem_region_list;
55 static int mem_number = 0;
57 /* If this flag is set, the memory region list should be automatically
58 updated from the target. If it is clear, the list is user-controlled
59 and should be left alone. */
60 static int mem_use_target = 1;
62 /* If this flag is set, we have tried to fetch the target memory regions
63 since the last time it was invalidated. If that list is still
64 empty, then the target can't supply memory regions. */
65 static int target_mem_regions_valid;
67 /* If this flag is set, gdb will assume that memory ranges not
68 specified by the memory map have type MEM_NONE, and will
69 emit errors on all accesses to that memory. */
70 static int inaccessible_by_default = 0;
73 show_inaccessible_by_default (struct ui_file *file, int from_tty,
74 struct cmd_list_element *c,
77 if (inaccessible_by_default)
78 fprintf_filtered (file, _("\
79 Unknown memory addresses will be treated as inaccessible.\n"));
81 fprintf_filtered (file, _("\
82 Unknown memory addresses will be treated as RAM.\n"));
86 /* Predicate function which returns true if LHS should sort before RHS
87 in a list of memory regions, useful for VEC_lower_bound. */
90 mem_region_lessthan (const struct mem_region *lhs,
91 const struct mem_region *rhs)
93 return lhs->lo < rhs->lo;
96 /* A helper function suitable for qsort, used to sort a
97 VEC(mem_region_s) by starting address. */
100 mem_region_cmp (const void *untyped_lhs, const void *untyped_rhs)
102 const struct mem_region *lhs = untyped_lhs;
103 const struct mem_region *rhs = untyped_rhs;
105 if (lhs->lo < rhs->lo)
107 else if (lhs->lo == rhs->lo)
113 /* Allocate a new memory region, with default settings. */
116 mem_region_init (struct mem_region *new)
118 memset (new, 0, sizeof (struct mem_region));
120 new->attrib = default_mem_attrib;
123 /* This function should be called before any command which would
124 modify the memory region list. It will handle switching from
125 a target-provided list to a local list, if necessary. */
128 require_user_regions (int from_tty)
130 struct mem_region *m;
133 /* If we're already using a user-provided list, nothing to do. */
137 /* Switch to a user-provided list (possibly a copy of the current
141 /* If we don't have a target-provided region list yet, then
143 if (mem_region_list == NULL)
146 /* Otherwise, let the user know how to get back. */
148 warning (_("Switching to manual control of memory regions; use "
149 "\"mem auto\" to fetch regions from the target again."));
151 /* And create a new list for the user to modify. */
152 length = VEC_length (mem_region_s, target_mem_region_list);
153 mem_region_list = VEC_alloc (mem_region_s, length);
154 for (ix = 0; VEC_iterate (mem_region_s, target_mem_region_list, ix, m); ix++)
155 VEC_quick_push (mem_region_s, mem_region_list, m);
158 /* This function should be called before any command which would
159 read the memory region list, other than those which call
160 require_user_regions. It will handle fetching the
161 target-provided list, if necessary. */
164 require_target_regions (void)
166 if (mem_use_target && !target_mem_regions_valid)
168 target_mem_regions_valid = 1;
169 target_mem_region_list = target_memory_map ();
170 mem_region_list = target_mem_region_list;
175 create_mem_region (CORE_ADDR lo, CORE_ADDR hi,
176 const struct mem_attrib *attrib)
178 struct mem_region new;
181 /* lo == hi is a useless empty region */
182 if (lo >= hi && hi != 0)
184 printf_unfiltered (_("invalid memory region: low >= high\n"));
188 mem_region_init (&new);
192 ix = VEC_lower_bound (mem_region_s, mem_region_list, &new,
193 mem_region_lessthan);
195 /* Check for an overlapping memory region. We only need to check
196 in the vicinity - at most one before and one after the
198 for (i = ix - 1; i < ix + 1; i++)
200 struct mem_region *n;
204 if (i >= VEC_length (mem_region_s, mem_region_list))
207 n = VEC_index (mem_region_s, mem_region_list, i);
209 if ((lo >= n->lo && (lo < n->hi || n->hi == 0))
210 || (hi > n->lo && (hi <= n->hi || n->hi == 0))
211 || (lo <= n->lo && (hi >= n->hi || hi == 0)))
213 printf_unfiltered (_("overlapping memory region\n"));
218 new.number = ++mem_number;
219 new.attrib = *attrib;
220 VEC_safe_insert (mem_region_s, mem_region_list, ix, &new);
224 * Look up the memory region cooresponding to ADDR.
227 lookup_mem_region (CORE_ADDR addr)
229 static struct mem_region region;
230 struct mem_region *m;
235 require_target_regions ();
237 /* First we initialize LO and HI so that they describe the entire
238 memory space. As we process the memory region chain, they are
239 redefined to describe the minimal region containing ADDR. LO
240 and HI are used in the case where no memory region is defined
241 that contains ADDR. If a memory region is disabled, it is
242 treated as if it does not exist. The initial values for LO
243 and HI represent the bottom and top of memory. */
248 /* Either find memory range containing ADDRESS, or set LO and HI
249 to the nearest boundaries of an existing memory range.
251 If we ever want to support a huge list of memory regions, this
252 check should be replaced with a binary search (probably using
254 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
256 if (m->enabled_p == 1)
258 /* If the address is in the memory region, return that memory range. */
259 if (addr >= m->lo && (addr < m->hi || m->hi == 0))
262 /* This (correctly) won't match if m->hi == 0, representing
263 the top of the address space, because CORE_ADDR is unsigned;
264 no value of LO is less than zero. */
265 if (addr >= m->hi && lo < m->hi)
268 /* This will never set HI to zero; if we're here and ADDR
269 is at or below M, and the region starts at zero, then ADDR
270 would have been in the region. */
271 if (addr <= m->lo && (hi == 0 || hi > m->lo))
276 /* Because no region was found, we must cons up one based on what
277 was learned above. */
281 /* When no memory map is defined at all, we always return
282 'default_mem_attrib', so that we do not make all memory
283 inaccessible for targets that don't provide a memory map. */
284 if (inaccessible_by_default && !VEC_empty (mem_region_s, mem_region_list))
285 region.attrib = unknown_mem_attrib;
287 region.attrib = default_mem_attrib;
292 /* Invalidate any memory regions fetched from the target. */
295 invalidate_target_mem_regions (void)
297 struct mem_region *m;
300 if (!target_mem_regions_valid)
303 target_mem_regions_valid = 0;
304 VEC_free (mem_region_s, target_mem_region_list);
306 mem_region_list = NULL;
309 /* Clear memory region list */
314 VEC_free (mem_region_s, mem_region_list);
319 mem_command (char *args, int from_tty)
323 struct mem_attrib attrib;
326 error_no_arg (_("No mem"));
328 /* For "mem auto", switch back to using a target provided list. */
329 if (strcmp (args, "auto") == 0)
334 if (mem_region_list != target_mem_region_list)
337 mem_region_list = target_mem_region_list;
344 require_user_regions (from_tty);
346 tok = strtok (args, " \t");
348 error (_("no lo address"));
349 lo = parse_and_eval_address (tok);
351 tok = strtok (NULL, " \t");
353 error (_("no hi address"));
354 hi = parse_and_eval_address (tok);
356 attrib = default_mem_attrib;
357 while ((tok = strtok (NULL, " \t")) != NULL)
359 if (strcmp (tok, "rw") == 0)
360 attrib.mode = MEM_RW;
361 else if (strcmp (tok, "ro") == 0)
362 attrib.mode = MEM_RO;
363 else if (strcmp (tok, "wo") == 0)
364 attrib.mode = MEM_WO;
366 else if (strcmp (tok, "8") == 0)
367 attrib.width = MEM_WIDTH_8;
368 else if (strcmp (tok, "16") == 0)
370 if ((lo % 2 != 0) || (hi % 2 != 0))
371 error (_("region bounds not 16 bit aligned"));
372 attrib.width = MEM_WIDTH_16;
374 else if (strcmp (tok, "32") == 0)
376 if ((lo % 4 != 0) || (hi % 4 != 0))
377 error (_("region bounds not 32 bit aligned"));
378 attrib.width = MEM_WIDTH_32;
380 else if (strcmp (tok, "64") == 0)
382 if ((lo % 8 != 0) || (hi % 8 != 0))
383 error (_("region bounds not 64 bit aligned"));
384 attrib.width = MEM_WIDTH_64;
388 else if (strcmp (tok, "hwbreak") == 0)
390 else if (strcmp (tok, "swbreak") == 0)
394 else if (strcmp (tok, "cache") == 0)
396 else if (strcmp (tok, "nocache") == 0)
400 else if (strcmp (tok, "verify") == 0)
402 else if (strcmp (tok, "noverify") == 0)
407 error (_("unknown attribute: %s"), tok);
410 create_mem_region (lo, hi, &attrib);
415 mem_info_command (char *args, int from_tty)
417 struct mem_region *m;
418 struct mem_attrib *attrib;
422 printf_filtered (_("Using memory regions provided by the target.\n"));
424 printf_filtered (_("Using user-defined memory regions.\n"));
426 require_target_regions ();
428 if (!mem_region_list)
430 printf_unfiltered (_("There are no memory regions defined.\n"));
434 printf_filtered ("Num ");
435 printf_filtered ("Enb ");
436 printf_filtered ("Low Addr ");
437 if (gdbarch_addr_bit (current_gdbarch) > 32)
438 printf_filtered (" ");
439 printf_filtered ("High Addr ");
440 if (gdbarch_addr_bit (current_gdbarch) > 32)
441 printf_filtered (" ");
442 printf_filtered ("Attrs ");
443 printf_filtered ("\n");
445 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
448 printf_filtered ("%-3d %-3c\t",
450 m->enabled_p ? 'y' : 'n');
451 if (gdbarch_addr_bit (current_gdbarch) <= 32)
452 tmp = hex_string_custom ((unsigned long) m->lo, 8);
454 tmp = hex_string_custom ((unsigned long) m->lo, 16);
456 printf_filtered ("%s ", tmp);
458 if (gdbarch_addr_bit (current_gdbarch) <= 32)
463 tmp = hex_string_custom ((unsigned long) m->hi, 8);
468 tmp = "0x10000000000000000";
470 tmp = hex_string_custom ((unsigned long) m->hi, 16);
473 printf_filtered ("%s ", tmp);
475 /* Print a token for each attribute.
477 * FIXME: Should we output a comma after each token? It may
478 * make it easier for users to read, but we'd lose the ability
479 * to cut-and-paste the list of attributes when defining a new
480 * region. Perhaps that is not important.
482 * FIXME: If more attributes are added to GDB, the output may
483 * become cluttered and difficult for users to read. At that
484 * time, we may want to consider printing tokens only if they
485 * are different from the default attribute. */
488 switch (attrib->mode)
491 printf_filtered ("rw ");
494 printf_filtered ("ro ");
497 printf_filtered ("wo ");
500 printf_filtered ("flash blocksize 0x%x ", attrib->blocksize);
504 switch (attrib->width)
507 printf_filtered ("8 ");
510 printf_filtered ("16 ");
513 printf_filtered ("32 ");
516 printf_filtered ("64 ");
518 case MEM_WIDTH_UNSPECIFIED:
524 printf_filtered ("hwbreak");
526 printf_filtered ("swbreak");
530 printf_filtered ("cache ");
532 printf_filtered ("nocache ");
536 printf_filtered ("verify ");
538 printf_filtered ("noverify ");
541 printf_filtered ("\n");
543 gdb_flush (gdb_stdout);
548 /* Enable the memory region number NUM. */
553 struct mem_region *m;
556 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
557 if (m->number == num)
562 printf_unfiltered (_("No memory region number %d.\n"), num);
566 mem_enable_command (char *args, int from_tty)
571 struct mem_region *m;
574 require_user_regions (from_tty);
576 dcache_invalidate (target_dcache);
580 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
587 while (*p1 >= '0' && *p1 <= '9')
589 if (*p1 && *p1 != ' ' && *p1 != '\t')
590 error (_("Arguments must be memory region numbers."));
596 while (*p == ' ' || *p == '\t')
602 /* Disable the memory region number NUM. */
605 mem_disable (int num)
607 struct mem_region *m;
610 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
611 if (m->number == num)
616 printf_unfiltered (_("No memory region number %d.\n"), num);
620 mem_disable_command (char *args, int from_tty)
625 struct mem_region *m;
628 require_user_regions (from_tty);
630 dcache_invalidate (target_dcache);
634 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
641 while (*p1 >= '0' && *p1 <= '9')
643 if (*p1 && *p1 != ' ' && *p1 != '\t')
644 error (_("Arguments must be memory region numbers."));
650 while (*p == ' ' || *p == '\t')
655 /* Delete the memory region number NUM. */
660 struct mem_region *m1, *m;
663 if (!mem_region_list)
665 printf_unfiltered (_("No memory region number %d.\n"), num);
669 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
670 if (m->number == num)
675 printf_unfiltered (_("No memory region number %d.\n"), num);
679 VEC_ordered_remove (mem_region_s, mem_region_list, ix);
683 mem_delete_command (char *args, int from_tty)
689 require_user_regions (from_tty);
691 dcache_invalidate (target_dcache);
695 if (query ("Delete all memory regions? "))
704 while (*p1 >= '0' && *p1 <= '9')
706 if (*p1 && *p1 != ' ' && *p1 != '\t')
707 error (_("Arguments must be memory region numbers."));
713 while (*p == ' ' || *p == '\t')
721 dummy_cmd (char *args, int from_tty)
725 extern initialize_file_ftype _initialize_mem; /* -Wmissing-prototype */
727 static struct cmd_list_element *mem_set_cmdlist;
728 static struct cmd_list_element *mem_show_cmdlist;
731 _initialize_mem (void)
733 add_com ("mem", class_vars, mem_command, _("\
734 Define attributes for memory region or reset memory region handling to\n\
737 mem <lo addr> <hi addr> [<mode> <width> <cache>], \n\
738 where <mode> may be rw (read/write), ro (read-only) or wo (write-only), \n\
739 <width> may be 8, 16, 32, or 64, and \n\
740 <cache> may be cache or nocache"));
742 add_cmd ("mem", class_vars, mem_enable_command, _("\
743 Enable memory region.\n\
744 Arguments are the code numbers of the memory regions to enable.\n\
745 Usage: enable mem <code number>\n\
746 Do \"info mem\" to see current list of code numbers."), &enablelist);
748 add_cmd ("mem", class_vars, mem_disable_command, _("\
749 Disable memory region.\n\
750 Arguments are the code numbers of the memory regions to disable.\n\
751 Usage: disable mem <code number>\n\
752 Do \"info mem\" to see current list of code numbers."), &disablelist);
754 add_cmd ("mem", class_vars, mem_delete_command, _("\
755 Delete memory region.\n\
756 Arguments are the code numbers of the memory regions to delete.\n\
757 Usage: delete mem <code number>\n\
758 Do \"info mem\" to see current list of code numbers."), &deletelist);
760 add_info ("mem", mem_info_command,
761 _("Memory region attributes"));
763 add_prefix_cmd ("mem", class_vars, dummy_cmd, _("\
764 Memory regions settings"),
765 &mem_set_cmdlist, "set mem ",
766 0/* allow-unknown */, &setlist);
767 add_prefix_cmd ("mem", class_vars, dummy_cmd, _("\
768 Memory regions settings"),
769 &mem_show_cmdlist, "show mem ",
770 0/* allow-unknown */, &showlist);
772 add_setshow_boolean_cmd ("inaccessible-by-default", no_class,
773 &inaccessible_by_default, _("\
774 Set handling of unknown memory regions."), _("\
775 Show handling of unknown memory regions."), _("\
776 If on, and some memory map is defined, debugger will emit errors on\n\
777 accesses to memory not defined in the memory map. If off, accesses to all\n\
778 memory addresses will be allowed."),
780 show_inaccessible_by_default,