summaryrefslogtreecommitdiffstats
path: root/dwarflint/coverage.h
blob: d6418c2af8643e10d1590decbefbac7acc3ad6ae (plain)
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
/* Coverage analysis.

   Copyright (C) 2008,2009 Red Hat, Inc.
   This file is part of Red Hat elfutils.

   Red Hat elfutils 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; version 2 of the License.

   Red Hat elfutils 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 Red Hat elfutils; if not, write to the Free Software Foundation,
   Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA.

   Red Hat elfutils is an included package of the Open Invention Network.
   An included package of the Open Invention Network is a package for which
   Open Invention Network licensees cross-license their patents.  No patent
   license is granted, either expressly or impliedly, by designation as an
   included package.  Should you wish to participate in the Open Invention
   Network licensing program, please visit www.openinventionnetwork.com
   <http://www.openinventionnetwork.com>.  */

#ifndef DWARFLINT_COVERAGE_H
#define DWARFLINT_COVERAGE_H

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>

#include "misc.h"

#ifdef __cplusplus
extern "C"
{
#endif

/* Functions and data structures for handling of address range
   coverage.  We use that to find holes of unused bytes in DWARF
   string table.  */

struct cov_range
{
  uint64_t start;
  uint64_t length;

#ifdef __cplusplus
  uint64_t end () const { return start + length; }
#endif
};

struct coverage
{
  struct cov_range *ranges;
  size_t size;
  size_t alloc;

#ifdef __cplusplus
  cov_range &back () { return ranges[size - 1]; }
  cov_range const &back () const { return ranges[size - 1]; }
#endif
};

char *range_fmt (char *buf, size_t buf_size,
		 uint64_t start, uint64_t end);

struct coverage *coverage_clone (struct coverage const *cov)
  __attribute__ ((malloc));
void coverage_free (struct coverage *cov);

void coverage_add (struct coverage *cov, uint64_t start, uint64_t length);
void coverage_add_all (struct coverage *__restrict__ cov,
		       struct coverage const *__restrict__ other);

/* Returns true if something was actually removed, false if whole
   range falls into hole in coverage.  */
bool coverage_remove (struct coverage *cov, uint64_t start, uint64_t length);

/* Returns true if something was actually removed, false if whole
   range falls into hole in coverage.  */
bool coverage_remove_all (struct coverage *__restrict__ cov,
			  struct coverage const *__restrict__ other);

/* Returns true if whole range ADDRESS/LENGTH is covered by COV.
   LENGTH may not be zero.  */
bool coverage_is_covered (struct coverage const *cov,
			  uint64_t start, uint64_t length);

/* Returns true if at least some of the range ADDRESS/LENGTH is
   covered by COV.  Zero-LENGTH range never overlaps.  */
bool coverage_is_overlap (struct coverage const *cov,
			  uint64_t start, uint64_t length);

bool coverage_find_holes (struct coverage const *cov,
			  uint64_t start, uint64_t length,
			  bool (*cb)(uint64_t start, uint64_t length,
				     void *data),
			  void *data);
bool coverage_find_ranges (struct coverage const *cov,
			  bool (*cb)(uint64_t start, uint64_t length,
				     void *data),
			  void *data);

#ifdef __cplusplus
}
#endif

#endif//DWARFLINT_COVERAGE_H