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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/** @file
*
* User Accessible Tables
* Maintain an array of user accessible data structures
* Internal interface
*
* (c) 2007, Luis E. Garcia Ontanon <luis@ontanon.org>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 2001 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
*/
#ifndef __UAT_INT_H__
#define __UAT_INT_H__
#include "uat.h"
#include "ws_symbol_export.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
typedef struct _uat_fld_rep_t uat_fld_rep_t;
typedef struct _uat_rep_t uat_rep_t;
typedef void (*uat_rep_fld_free_cb_t)(uat_fld_rep_t*);
typedef void (*uat_rep_free_cb_t)(uat_rep_t*);
typedef struct _fld_data_t {
unsigned colnum;
uat_fld_rep_t* rep;
uat_rep_fld_free_cb_t free_rep;
} fld_data_t;
struct epan_uat {
char* name;
size_t record_size;
char* filename;
bool from_profile;
char* help;
unsigned flags;
void** user_ptr; /**< Pointer to a dissector variable where an array of valid records are stored. */
unsigned* nrows_p; /**< Pointer to a dissector variable where the number of valid records in user_ptr are written. */
uat_copy_cb_t copy_cb;
uat_update_cb_t update_cb;
uat_free_cb_t free_cb;
uat_post_update_cb_t post_update_cb;
uat_reset_cb_t reset_cb;
uat_field_t* fields;
const char** default_values;
unsigned ncols;
GArray* user_data; /**< An array of valid records that will be exposed to the dissector. */
GArray* raw_data; /**< An array of records containing possibly invalid data. For internal use only. */
GArray* valid_data; /**< An array of booleans describing whether the records in 'raw_data' are valid or not. */
bool changed;
uat_rep_t* rep;
uat_rep_free_cb_t free_rep;
bool loaded;
bool from_global;
};
WS_DLL_PUBLIC
char* uat_get_actual_filename(uat_t* uat, bool for_writing);
/**
* Clones the given record and stores it internally in the UAT. If it is
* considered a valid record, then it will also be cloned and stored in the
* externally visible list.
*/
WS_DLL_PUBLIC
void* uat_add_record(uat_t *uat, const void *orig_rec_ptr, bool valid_rec);
/**
* Marks the internal record in the UAT as valid or invalid. The record must
* exist in the UAT.
*/
WS_DLL_PUBLIC
void uat_update_record(uat_t *uat, const void *record, bool valid_rec);
/**
* Changes the order of two internal UAT records.
*/
WS_DLL_PUBLIC
void uat_swap(uat_t *uat, unsigned idx_a, unsigned idx_b);
/**
* Inserts the record at the given index in the internal record list.
*/
WS_DLL_PUBLIC
void uat_insert_record_idx(uat_t *uat, unsigned rec_idx, const void *src_record);
/**
* Removes the record with the given index from the internal record list.
*/
WS_DLL_PUBLIC
void uat_remove_record_idx(uat_t *uat, unsigned rec_idx);
/**
* Moves the entry from the old position to the new one
*/
WS_DLL_PUBLIC
void uat_move_index(uat_t *uat, unsigned old_idx, unsigned new_idx);
/**
* Removes and destroys all records from the UAT.
*/
WS_DLL_PUBLIC
void uat_clear(uat_t *uat);
/**
* Saves the records from an UAT to file.
* Returns true on success and false on failure, storing the reason in 'error'
* (which must be freed using g_free).
*/
WS_DLL_PUBLIC
bool uat_save(uat_t *uat, char **error);
/**
* Loads the records for all registered UATs from file.
*/
void uat_load_all(void);
/**
* Dump given UAT record to string in form, which can be later loaded with uat_load_str().
*/
WS_DLL_PUBLIC
char *uat_fld_tostr(void *rec, uat_field_t *f);
/**
* Exposes the array of valid records to the UAT consumer (dissectors), updating
* the contents of 'data_ptr' and 'num_items_ptr' (see 'uat_new').
*/
#define UAT_UPDATE(uat) do { *((uat)->user_ptr) = (void*)((uat)->user_data->data); *((uat)->nrows_p) = (uat)->user_data->len; } while(0)
/**
* Get a record from the array of all UAT entries, whether they are semantically
* valid or not. This memory must only be used internally in the UAT core and
* must not be exposed to dissectors.
*/
#define UAT_INDEX_PTR(uat,idx) (uat->raw_data->data + (uat->record_size * (idx)))
/**
* Get a record from the array of all valid entries. These records will be
* shared with UAT consumers (dissectors).
*/
#define UAT_USER_INDEX_PTR(uat,idx) (uat->user_data->data + (uat->record_size * (idx)))
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __UAT_INT_H__ */
/*
* Editor modelines - https://www.wireshark.org/tools/modelines.html
*
* Local variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/
|
