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