xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/memrange.h (revision 7d62b00eb9ad855ffcd7da46b41e23feb5476fac)
1 /* The memory range data structure, and associated utilities.
2 
3    Copyright (C) 2010-2019 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 #ifndef MEMRANGE_H
21 #define MEMRANGE_H
22 
23 #include "common/vec.h"
24 
25 /* Defines a [START, START + LENGTH) memory range.  */
26 
27 struct mem_range
28 {
29   mem_range () = default;
30 
31   mem_range (CORE_ADDR start_, int length_)
32   : start (start_), length (length_)
33   {}
34 
35   bool operator< (const mem_range &other) const
36   {
37     return this->start < other.start;
38   }
39 
40   bool operator== (const mem_range &other) const
41   {
42     return (this->start == other.start
43 	    && this->length == other.length);
44   }
45 
46   /* Lowest address in the range.  */
47   CORE_ADDR start;
48 
49   /* Length of the range.  */
50   int length;
51 };
52 
53 /* Returns true if the ranges defined by [start1, start1+len1) and
54    [start2, start2+len2) overlap.  */
55 
56 extern int mem_ranges_overlap (CORE_ADDR start1, int len1,
57 			       CORE_ADDR start2, int len2);
58 
59 /* Returns true if ADDR is in RANGE.  */
60 
61 extern int address_in_mem_range (CORE_ADDR addr,
62 				 const struct mem_range *range);
63 
64 /* Sort ranges by start address, then coalesce contiguous or
65    overlapping ranges.  */
66 
67 extern void normalize_mem_ranges (std::vector<mem_range> *memory);
68 
69 #endif
70