029ec7104c5c6c7a92d5819d25fda064113e960c
[external/binutils.git] / gdb / memrange.h
1 /* The memory range data structure, and associated utilities.
2
3    Copyright (C) 2010-2017 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 "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   /* Lowest address in the range.  */
36   CORE_ADDR start;
37
38   /* Length of the range.  */
39   int length;
40 };
41
42 typedef struct mem_range mem_range_s;
43
44 DEF_VEC_O(mem_range_s);
45
46 /* Returns true if the ranges defined by [start1, start1+len1) and
47    [start2, start2+len2) overlap.  */
48
49 extern int mem_ranges_overlap (CORE_ADDR start1, int len1,
50                                CORE_ADDR start2, int len2);
51
52 /* Returns true if ADDR is in RANGE.  */
53
54 extern int address_in_mem_range (CORE_ADDR addr,
55                                  const struct mem_range *range);
56
57 /* Sort ranges by start address, then coalesce contiguous or
58    overlapping ranges.  */
59
60 extern void normalize_mem_ranges (VEC(mem_range_s) *memory);
61
62 #endif