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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
|
/* addrmap.c --- implementation of address map data structure.
Copyright (C) 2007-2022 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
#include "splay-tree.h"
#include "gdb_obstack.h"
#include "addrmap.h"
#include "gdbsupport/selftest.h"
/* Make sure splay trees can actually hold the values we want to
store in them. */
gdb_static_assert (sizeof (splay_tree_key) >= sizeof (CORE_ADDR *));
gdb_static_assert (sizeof (splay_tree_value) >= sizeof (void *));
/* The "abstract class". */
/* Functions implementing the addrmap functions for a particular
implementation. */
struct addrmap_funcs
{
void (*set_empty) (struct addrmap *self,
CORE_ADDR start, CORE_ADDR end_inclusive,
void *obj);
void *(*find) (struct addrmap *self, CORE_ADDR addr);
struct addrmap *(*create_fixed) (struct addrmap *self,
struct obstack *obstack);
void (*relocate) (struct addrmap *self, CORE_ADDR offset);
int (*foreach) (struct addrmap *self, addrmap_foreach_fn fn);
};
struct addrmap
{
const struct addrmap_funcs *funcs;
};
void
addrmap_set_empty (struct addrmap *map,
CORE_ADDR start, CORE_ADDR end_inclusive,
void *obj)
{
map->funcs->set_empty (map, start, end_inclusive, obj);
}
void *
addrmap_find (struct addrmap *map, CORE_ADDR addr)
{
return map->funcs->find (map, addr);
}
struct addrmap *
addrmap_create_fixed (struct addrmap *original, struct obstack *obstack)
{
return original->funcs->create_fixed (original, obstack);
}
/* Relocate all the addresses in MAP by OFFSET. (This can be applied
to either mutable or immutable maps.) */
void
addrmap_relocate (struct addrmap *map, CORE_ADDR offset)
{
map->funcs->relocate (map, offset);
}
int
addrmap_foreach (struct addrmap *map, addrmap_foreach_fn fn)
{
return map->funcs->foreach (map, fn);
}
/* Fixed address maps. */
/* A transition: a point in an address map where the value changes.
The map maps ADDR to VALUE, but if ADDR > 0, it maps ADDR-1 to
something else. */
struct addrmap_transition
{
CORE_ADDR addr;
void *value;
};
struct addrmap_fixed
{
struct addrmap addrmap;
/* The number of transitions in TRANSITIONS. */
size_t num_transitions;
/* An array of transitions, sorted by address. For every point in
the map where either ADDR == 0 or ADDR is mapped to one value and
ADDR - 1 is mapped to something different, we have an entry here
containing ADDR and VALUE. (Note that this means we always have
an entry for address 0). */
struct addrmap_transition transitions[1];
};
static void
addrmap_fixed_set_empty (struct addrmap *self,
CORE_ADDR start, CORE_ADDR end_inclusive,
void *obj)
{
internal_error (__FILE__, __LINE__,
"addrmap_fixed_set_empty: "
"fixed addrmaps can't be changed\n");
}
static void *
addrmap_fixed_find (struct addrmap *self, CORE_ADDR addr)
{
struct addrmap_fixed *map = (struct addrmap_fixed *) self;
struct addrmap_transition *bottom = &map->transitions[0];
struct addrmap_transition *top = &map->transitions[map->num_transitions - 1];
while (bottom < top)
{
/* This needs to round towards top, or else when top = bottom +
1 (i.e., two entries are under consideration), then mid ==
bottom, and then we may not narrow the range when (mid->addr
< addr). */
struct addrmap_transition *mid = top - (top - bottom) / 2;
if (mid->addr == addr)
{
bottom = mid;
break;
}
else if (mid->addr < addr)
/* We don't eliminate mid itself here, since each transition
covers all subsequent addresses until the next. This is why
we must round up in computing the midpoint. */
bottom = mid;
else
top = mid - 1;
}
return bottom->value;
}
static struct addrmap *
addrmap_fixed_create_fixed (struct addrmap *self, struct obstack *obstack)
{
internal_error (__FILE__, __LINE__,
_("addrmap_create_fixed is not implemented yet "
"for fixed addrmaps"));
}
static void
addrmap_fixed_relocate (struct addrmap *self, CORE_ADDR offset)
{
struct addrmap_fixed *map = (struct addrmap_fixed *) self;
size_t i;
for (i = 0; i < map->num_transitions; i++)
map->transitions[i].addr += offset;
}
static int
addrmap_fixed_foreach (struct addrmap *self, addrmap_foreach_fn fn)
{
struct addrmap_fixed *map = (struct addrmap_fixed *) self;
size_t i;
for (i = 0; i < map->num_transitions; i++)
{
int res = fn (map->transitions[i].addr, map->transitions[i].value);
if (res != 0)
return res;
}
return 0;
}
static const struct addrmap_funcs addrmap_fixed_funcs =
{
addrmap_fixed_set_empty,
addrmap_fixed_find,
addrmap_fixed_create_fixed,
addrmap_fixed_relocate,
addrmap_fixed_foreach
};
/* Mutable address maps. */
struct addrmap_mutable
{
struct addrmap addrmap;
/* The obstack to use for allocations for this map. */
struct obstack *obstack;
/* A splay tree, with a node for each transition; there is a
transition at address T if T-1 and T map to different objects.
Any addresses below the first node map to NULL. (Unlike
fixed maps, we have no entry at (CORE_ADDR) 0; it doesn't
simplify enough.)
The last region is assumed to end at CORE_ADDR_MAX.
Since we can't know whether CORE_ADDR is larger or smaller than
splay_tree_key (unsigned long) --- I think both are possible,
given all combinations of 32- and 64-bit hosts and targets ---
our keys are pointers to CORE_ADDR values. Since the splay tree
library doesn't pass any closure pointer to the key free
function, we can't keep a freelist for keys. Since mutable
addrmaps are only used temporarily right now, we just leak keys
from deleted nodes; they'll be freed when the obstack is freed. */
splay_tree tree;
/* A freelist for splay tree nodes, allocated on obstack, and
chained together by their 'right' pointers. */
splay_tree_node free_nodes;
};
/* Allocate a copy of CORE_ADDR in MAP's obstack. */
static splay_tree_key
allocate_key (struct addrmap_mutable *map, CORE_ADDR addr)
{
CORE_ADDR *key = XOBNEW (map->obstack, CORE_ADDR);
*key = addr;
return (splay_tree_key) key;
}
/* Type-correct wrappers for splay tree access. */
static splay_tree_node
addrmap_splay_tree_lookup (struct addrmap_mutable *map, CORE_ADDR addr)
{
return splay_tree_lookup (map->tree, (splay_tree_key) &addr);
}
static splay_tree_node
addrmap_splay_tree_predecessor (struct addrmap_mutable *map, CORE_ADDR addr)
{
return splay_tree_predecessor (map->tree, (splay_tree_key) &addr);
}
static splay_tree_node
addrmap_splay_tree_successor (struct addrmap_mutable *map, CORE_ADDR addr)
{
return splay_tree_successor (map->tree, (splay_tree_key) &addr);
}
static void
addrmap_splay_tree_remove (struct addrmap_mutable *map, CORE_ADDR addr)
{
splay_tree_remove (map->tree, (splay_tree_key) &addr);
}
static CORE_ADDR
addrmap_node_key (splay_tree_node node)
{
return * (CORE_ADDR *) node->key;
}
static void *
addrmap_node_value (splay_tree_node node)
{
return (void *) node->value;
}
static void
addrmap_node_set_value (splay_tree_node node, void *value)
{
node->value = (splay_tree_value) value;
}
static void
addrmap_splay_tree_insert (struct addrmap_mutable *map,
CORE_ADDR key, void *value)
{
splay_tree_insert (map->tree,
allocate_key (map, key),
(splay_tree_value) value);
}
/* Without changing the mapping of any address, ensure that there is a
tree node at ADDR, even if it would represent a "transition" from
one value to the same value. */
static void
force_transition (struct addrmap_mutable *self, CORE_ADDR addr)
{
splay_tree_node n
= addrmap_splay_tree_lookup (self, addr);
if (! n)
{
n = addrmap_splay_tree_predecessor (self, addr);
addrmap_splay_tree_insert (self, addr,
n ? addrmap_node_value (n) : NULL);
}
}
static void
addrmap_mutable_set_empty (struct addrmap *self,
CORE_ADDR start, CORE_ADDR end_inclusive,
void *obj)
{
struct addrmap_mutable *map = (struct addrmap_mutable *) self;
splay_tree_node n, next;
void *prior_value;
/* If we're being asked to set all empty portions of the given
address range to empty, then probably the caller is confused.
(If that turns out to be useful in some cases, then we can change
this to simply return, since overriding NULL with NULL is a
no-op.) */
gdb_assert (obj);
/* We take a two-pass approach, for simplicity.
- Establish transitions where we think we might need them.
- First pass: change all NULL regions to OBJ.
- Second pass: remove any unnecessary transitions. */
/* Establish transitions at the start and end. */
force_transition (map, start);
if (end_inclusive < CORE_ADDR_MAX)
force_transition (map, end_inclusive + 1);
/* Walk the area, changing all NULL regions to OBJ. */
for (n = addrmap_splay_tree_lookup (map, start), gdb_assert (n);
n && addrmap_node_key (n) <= end_inclusive;
n = addrmap_splay_tree_successor (map, addrmap_node_key (n)))
{
if (! addrmap_node_value (n))
addrmap_node_set_value (n, obj);
}
/* Walk the area again, removing transitions from any value to
itself. Be sure to visit both the transitions we forced
above. */
n = addrmap_splay_tree_predecessor (map, start);
prior_value = n ? addrmap_node_value (n) : NULL;
for (n = addrmap_splay_tree_lookup (map, start), gdb_assert (n);
n && (end_inclusive == CORE_ADDR_MAX
|| addrmap_node_key (n) <= end_inclusive + 1);
n = next)
{
next = addrmap_splay_tree_successor (map, addrmap_node_key (n));
if (addrmap_node_value (n) == prior_value)
addrmap_splay_tree_remove (map, addrmap_node_key (n));
else
prior_value = addrmap_node_value (n);
}
}
static void *
addrmap_mutable_find (struct addrmap *self, CORE_ADDR addr)
{
struct addrmap_mutable *map = (struct addrmap_mutable *) self;
splay_tree_node n = addrmap_splay_tree_lookup (map, addr);
if (n != nullptr)
{
gdb_assert (addrmap_node_key (n) == addr);
return addrmap_node_value (n);
}
n = addrmap_splay_tree_predecessor (map, addr);
if (n != nullptr)
{
gdb_assert (addrmap_node_key (n) < addr);
return addrmap_node_value (n);
}
return nullptr;
}
/* A function to pass to splay_tree_foreach to count the number of nodes
in the tree. */
static int
splay_foreach_count (splay_tree_node n, void *closure)
{
size_t *count = (size_t *) closure;
(*count)++;
return 0;
}
/* A function to pass to splay_tree_foreach to copy entries into a
fixed address map. */
static int
splay_foreach_copy (splay_tree_node n, void *closure)
{
struct addrmap_fixed *fixed = (struct addrmap_fixed *) closure;
struct addrmap_transition *t = &fixed->transitions[fixed->num_transitions];
t->addr = addrmap_node_key (n);
t->value = addrmap_node_value (n);
fixed->num_transitions++;
return 0;
}
static struct addrmap *
addrmap_mutable_create_fixed (struct addrmap *self, struct obstack *obstack)
{
struct addrmap_mutable *mutable_obj = (struct addrmap_mutable *) self;
struct addrmap_fixed *fixed;
size_t num_transitions;
size_t alloc_len;
/* Count the number of transitions in the tree. */
num_transitions = 0;
splay_tree_foreach (mutable_obj->tree, splay_foreach_count, &num_transitions);
/* Include an extra entry for the transition at zero (which fixed
maps have, but mutable maps do not.) */
num_transitions++;
alloc_len = sizeof (*fixed)
+ (num_transitions * sizeof (fixed->transitions[0]));
fixed = (struct addrmap_fixed *) obstack_alloc (obstack, alloc_len);
fixed->addrmap.funcs = &addrmap_fixed_funcs;
fixed->num_transitions = 1;
fixed->transitions[0].addr = 0;
fixed->transitions[0].value = NULL;
/* Copy all entries from the splay tree to the array, in order
of increasing address. */
splay_tree_foreach (mutable_obj->tree, splay_foreach_copy, fixed);
/* We should have filled the array. */
gdb_assert (fixed->num_transitions == num_transitions);
return (struct addrmap *) fixed;
}
static void
addrmap_mutable_relocate (struct addrmap *self, CORE_ADDR offset)
{
/* Not needed yet. */
internal_error (__FILE__, __LINE__,
_("addrmap_relocate is not implemented yet "
"for mutable addrmaps"));
}
/* This is a splay_tree_foreach_fn. */
static int
addrmap_mutable_foreach_worker (splay_tree_node node, void *data)
{
addrmap_foreach_fn *fn = (addrmap_foreach_fn *) data;
return (*fn) (addrmap_node_key (node), addrmap_node_value (node));
}
static int
addrmap_mutable_foreach (struct addrmap *self, addrmap_foreach_fn fn)
{
struct addrmap_mutable *mutable_obj = (struct addrmap_mutable *) self;
return splay_tree_foreach (mutable_obj->tree, addrmap_mutable_foreach_worker,
&fn);
}
static const struct addrmap_funcs addrmap_mutable_funcs =
{
addrmap_mutable_set_empty,
addrmap_mutable_find,
addrmap_mutable_create_fixed,
addrmap_mutable_relocate,
addrmap_mutable_foreach
};
static void *
splay_obstack_alloc (int size, void *closure)
{
struct addrmap_mutable *map = (struct addrmap_mutable *) closure;
splay_tree_node n;
/* We should only be asked to allocate nodes and larger things.
(If, at some point in the future, this is no longer true, we can
just round up the size to sizeof (*n).) */
gdb_assert (size >= sizeof (*n));
if (map->free_nodes)
{
n = map->free_nodes;
map->free_nodes = n->right;
return n;
}
else
return obstack_alloc (map->obstack, size);
}
static void
splay_obstack_free (void *obj, void *closure)
{
struct addrmap_mutable *map = (struct addrmap_mutable *) closure;
splay_tree_node n = (splay_tree_node) obj;
/* We've asserted in the allocation function that we only allocate
nodes or larger things, so it should be safe to put whatever
we get passed back on the free list. */
n->right = map->free_nodes;
map->free_nodes = n;
}
/* Compare keys as CORE_ADDR * values. */
static int
splay_compare_CORE_ADDR_ptr (splay_tree_key ak, splay_tree_key bk)
{
CORE_ADDR a = * (CORE_ADDR *) ak;
CORE_ADDR b = * (CORE_ADDR *) bk;
/* We can't just return a-b here, because of over/underflow. */
if (a < b)
return -1;
else if (a == b)
return 0;
else
return 1;
}
struct addrmap *
addrmap_create_mutable (struct obstack *obstack)
{
struct addrmap_mutable *map = XOBNEW (obstack, struct addrmap_mutable);
map->addrmap.funcs = &addrmap_mutable_funcs;
map->obstack = obstack;
/* splay_tree_new_with_allocator uses the provided allocation
function to allocate the main splay_tree structure itself, so our
free list has to be initialized before we create the tree. */
map->free_nodes = NULL;
map->tree = splay_tree_new_with_allocator (splay_compare_CORE_ADDR_ptr,
NULL, /* no delete key */
NULL, /* no delete value */
splay_obstack_alloc,
splay_obstack_free,
map);
return (struct addrmap *) map;
}
/* See addrmap.h. */
void
addrmap_dump (struct addrmap *map, struct ui_file *outfile, void *payload)
{
/* True if the previously printed addrmap entry was for PAYLOAD.
If so, we want to print the next one as well (since the next
addrmap entry defines the end of the range). */
bool previous_matched = false;
auto callback = [&] (CORE_ADDR start_addr, void *obj)
{
QUIT;
bool matches = payload == nullptr || payload == obj;
const char *addr_str = nullptr;
if (matches)
addr_str = host_address_to_string (obj);
else if (previous_matched)
addr_str = "<ends here>";
if (matches || previous_matched)
fprintf_filtered (outfile, " %s%s %s\n",
payload != nullptr ? " " : "",
core_addr_to_string (start_addr),
addr_str);
previous_matched = matches;
return 0;
};
addrmap_foreach (map, callback);
}
#if GDB_SELF_TEST
namespace selftests {
/* Convert P to CORE_ADDR. */
static CORE_ADDR
core_addr (void *p)
{
return (CORE_ADDR)(uintptr_t)p;
}
/* Check that &ARRAY[LOW]..&ARRAY[HIGH] has VAL in MAP. */
#define CHECK_ADDRMAP_FIND(MAP, ARRAY, LOW, HIGH, VAL) \
do \
{ \
for (unsigned i = LOW; i <= HIGH; ++i) \
SELF_CHECK (addrmap_find (MAP, core_addr (&ARRAY[i])) == VAL); \
} \
while (0)
/* Entry point for addrmap unit tests. */
static void
test_addrmap ()
{
/* We'll verify using the addresses of the elements of this array. */
char array[20];
/* We'll verify using these values stored into the map. */
void *val1 = &array[1];
void *val2 = &array[2];
/* Create mutable addrmap. */
struct obstack temp_obstack;
obstack_init (&temp_obstack);
struct addrmap *map = addrmap_create_mutable (&temp_obstack);
SELF_CHECK (map != nullptr);
/* Check initial state. */
CHECK_ADDRMAP_FIND (map, array, 0, 19, nullptr);
/* Insert address range into mutable addrmap. */
addrmap_set_empty (map, core_addr (&array[10]), core_addr (&array[12]),
val1);
CHECK_ADDRMAP_FIND (map, array, 0, 9, nullptr);
CHECK_ADDRMAP_FIND (map, array, 10, 12, val1);
CHECK_ADDRMAP_FIND (map, array, 13, 19, nullptr);
/* Create corresponding fixed addrmap. */
struct addrmap *map2 = addrmap_create_fixed (map, &temp_obstack);
SELF_CHECK (map2 != nullptr);
CHECK_ADDRMAP_FIND (map2, array, 0, 9, nullptr);
CHECK_ADDRMAP_FIND (map2, array, 10, 12, val1);
CHECK_ADDRMAP_FIND (map2, array, 13, 19, nullptr);
/* Iterate over both addrmaps. */
auto callback = [&] (CORE_ADDR start_addr, void *obj)
{
if (start_addr == core_addr (nullptr))
SELF_CHECK (obj == nullptr);
else if (start_addr == core_addr (&array[10]))
SELF_CHECK (obj == val1);
else if (start_addr == core_addr (&array[13]))
SELF_CHECK (obj == nullptr);
else
SELF_CHECK (false);
return 0;
};
SELF_CHECK (addrmap_foreach (map, callback) == 0);
SELF_CHECK (addrmap_foreach (map2, callback) == 0);
/* Relocate fixed addrmap. */
addrmap_relocate (map2, 1);
CHECK_ADDRMAP_FIND (map2, array, 0, 10, nullptr);
CHECK_ADDRMAP_FIND (map2, array, 11, 13, val1);
CHECK_ADDRMAP_FIND (map2, array, 14, 19, nullptr);
/* Insert partially overlapping address range into mutable addrmap. */
addrmap_set_empty (map, core_addr (&array[11]), core_addr (&array[13]),
val2);
CHECK_ADDRMAP_FIND (map, array, 0, 9, nullptr);
CHECK_ADDRMAP_FIND (map, array, 10, 12, val1);
CHECK_ADDRMAP_FIND (map, array, 13, 13, val2);
CHECK_ADDRMAP_FIND (map, array, 14, 19, nullptr);
/* Cleanup. */
obstack_free (&temp_obstack, NULL);
}
} // namespace selftests
#endif /* GDB_SELF_TEST */
void _initialize_addrmap ();
void
_initialize_addrmap ()
{
#if GDB_SELF_TEST
selftests::register_test ("addrmap", selftests::test_addrmap);
#endif /* GDB_SELF_TEST */
}
|