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
|
/* range.h
* Range routines
*
* Dick Gooris <gooris@lucent.com>
* Ulf Lamping <ulf.lamping@web.de>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __RANGE_H__
#define __RANGE_H__
#include "ws_symbol_export.h"
#include <epan/wmem_scopes.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** @file
* Range strings a variant of value_strings
*/
/**@todo where's the best place for these? */
#define MAX_SCTP_PORT 65535
#define MAX_TCP_PORT 65535
#define MAX_UDP_PORT 65535
#define MAX_DCCP_PORT 65535
typedef struct range_admin_tag {
uint32_t low;
uint32_t high;
} range_admin_t;
#define RANGE_ADMIN_T_INITIALIZER { 0, 0 }
/** user specified range(s) */
typedef struct epan_range {
unsigned nranges; /**< number of entries in ranges */
range_admin_t ranges[]; /**< flexible array of range entries */
} range_t;
/**
* Return value from range_convert_str().
*/
typedef enum {
CVT_NO_ERROR,
CVT_SYNTAX_ERROR,
CVT_NUMBER_TOO_BIG
} convert_ret_t;
WS_DLL_PUBLIC range_t *range_empty(wmem_allocator_t *scope);
/*** Converts a range string to a fast comparable array of ranges.
* This function allocates a range_t large enough to hold the number
* of ranges specified, and fills the array range->ranges containing
* low and high values with the number of ranges being range->nranges.
* After having called this function, the function value_is_in_range()
* determines whether a given number is within the range or not.<BR>
* In case of a single number, we make a range where low is equal to high.
* We take care on wrongly entered ranges; opposite order will be taken
* care of.
*
* The following syntax is accepted :
*
* 1-20,30-40 Range from 1 to 20, and packets 30 to 40
* -20,30 Range from 1 to 20, and packet 30
* 20,30,40- 20, 30, and the range from 40 to the end
* 20-10,30-25 Range from 10 to 20, and from 25 to 30
* - All values
* @param scope memory scope for the range
* @param range the range
* @param es points to the string to be converted.
* @param max_value specifies the maximum value in a range.
* @return convert_ret_t
*/
WS_DLL_PUBLIC convert_ret_t range_convert_str(wmem_allocator_t *scope, range_t **range, const char *es,
uint32_t max_value);
WS_DLL_PUBLIC convert_ret_t range_convert_str_work(wmem_allocator_t *scope, range_t **range, const char *es,
uint32_t max_value, bool err_on_max);
/** This function returns true if a given value is within one of the ranges
* stored in the ranges array.
* @param range the range
* @param val the value to check
* @return true if the value is in range
*/
WS_DLL_PUBLIC bool value_is_in_range(const range_t *range, uint32_t val);
/** This function returns true if val has successfully been added to
* a range. This may extend an existing range or create a new one
* @param scope memory scope of range (in case of reallocation)
* @param range to add value
* @param val value to add to range
* @return true if the value is successfully added to range
*/
WS_DLL_PUBLIC bool range_add_value(wmem_allocator_t *scope, range_t **range, uint32_t val);
/** This function returns true if val has successfully been removed from
* a range. This may remove an existing range.
* @param scope memory scope of range (in case of reallocation)
* @param range to remove value
* @param val value to remove within range
* @return true if the value is successfully removed to range
*/
WS_DLL_PUBLIC bool range_remove_value(wmem_allocator_t *scope, range_t **range, uint32_t val);
/** This function returns true if the two given range_t's are equal.
* @param a first range
* @param b second range
* @return true if the value is in range
*/
WS_DLL_PUBLIC bool ranges_are_equal(const range_t *a, const range_t *b);
/** This function calls the provided callback function for each value in
* in the range. Takes a pointer argument, which is passed to the
* callback, along with the value in the range.
* @param range the range
* @param callback the callback function
* @param ptr pointer passed to the callback
*/
WS_DLL_PUBLIC void range_foreach(range_t *range, void (*callback)(uint32_t val, void *ptr), void *ptr);
/**
* This function converts a range_t to a (wmem_alloc()-allocated) string.
*/
WS_DLL_PUBLIC char *range_convert_range(wmem_allocator_t *scope, const range_t *range);
/**
* Create a (wmem-alloc()ed) copy of a range
* @param scope memory scope for the copied range
* @param src the range to copy
* @return ep allocated copy of the range
*/
WS_DLL_PUBLIC range_t *range_copy(wmem_allocator_t *scope, const range_t *src);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __RANGE_H__ */
|
