Coverage Report

Created: 2024-05-15 07:09

/src/libpcap/gencode.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996
3
 *  The Regents of the University of California.  All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that: (1) source code distributions
7
 * retain the above copyright notice and this paragraph in its entirety, (2)
8
 * distributions including binary code include the above copyright notice and
9
 * this paragraph in its entirety in the documentation or other materials
10
 * provided with the distribution, and (3) all advertising materials mentioning
11
 * features or use of this software display the following acknowledgement:
12
 * ``This product includes software developed by the University of California,
13
 * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14
 * the University nor the names of its contributors may be used to endorse
15
 * or promote products derived from this software without specific prior
16
 * written permission.
17
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18
 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
20
 */
21
22
#ifndef gencode_h
23
#define gencode_h
24
25
#include "pcap/funcattrs.h"
26
/*
27
 * pcap/bpf.h (a public header) needs u_char, u_short and u_int, which can be
28
 * made available via either pcap-types.h (a private header) or pcap/pcap.h
29
 * (a public header), none of which pcap/bpf.h includes.  Include the private
30
 * header to keep things simple, this way this private header should compile
31
 * even if included early from another file.
32
 */
33
#include "pcap-types.h"
34
#include "pcap/bpf.h" /* bpf_u_int32 and BPF_MEMWORDS */
35
36
/*
37
 * ATM support:
38
 *
39
 * Copyright (c) 1997 Yen Yen Lim and North Dakota State University
40
 * All rights reserved.
41
 *
42
 * Redistribution and use in source and binary forms, with or without
43
 * modification, are permitted provided that the following conditions
44
 * are met:
45
 * 1. Redistributions of source code must retain the above copyright
46
 *    notice, this list of conditions and the following disclaimer.
47
 * 2. Redistributions in binary form must reproduce the above copyright
48
 *    notice, this list of conditions and the following disclaimer in the
49
 *    documentation and/or other materials provided with the distribution.
50
 * 3. All advertising materials mentioning features or use of this software
51
 *    must display the following acknowledgement:
52
 *      This product includes software developed by Yen Yen Lim and
53
 *      North Dakota State University
54
 * 4. The name of the author may not be used to endorse or promote products
55
 *    derived from this software without specific prior written permission.
56
 *
57
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
59
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
60
 * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
61
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
62
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
63
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
65
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
66
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
67
 * POSSIBILITY OF SUCH DAMAGE.
68
 */
69
70
/* Address qualifiers. */
71
72
0
#define Q_HOST    1
73
0
#define Q_NET   2
74
0
#define Q_PORT    3
75
0
#define Q_GATEWAY 4
76
0
#define Q_PROTO   5
77
0
#define Q_PROTOCHAIN  6
78
0
#define Q_PORTRANGE 7
79
80
/* Protocol qualifiers. */
81
82
0
#define Q_LINK    1
83
0
#define Q_IP    2
84
0
#define Q_ARP   3
85
0
#define Q_RARP    4
86
0
#define Q_SCTP    5
87
0
#define Q_TCP   6
88
0
#define Q_UDP   7
89
0
#define Q_ICMP    8
90
0
#define Q_IGMP    9
91
0
#define Q_IGRP    10
92
93
94
0
#define Q_ATALK   11
95
0
#define Q_DECNET  12
96
0
#define Q_LAT   13
97
0
#define Q_SCA   14
98
0
#define Q_MOPRC   15
99
0
#define Q_MOPDL   16
100
101
102
0
#define Q_IPV6    17
103
0
#define Q_ICMPV6  18
104
0
#define Q_AH    19
105
0
#define Q_ESP   20
106
107
0
#define Q_PIM   21
108
0
#define Q_VRRP    22
109
110
0
#define Q_AARP    23
111
112
0
#define Q_ISO   24
113
0
#define Q_ESIS    25
114
0
#define Q_ISIS    26
115
0
#define Q_CLNP    27
116
117
0
#define Q_STP   28
118
119
0
#define Q_IPX   29
120
121
0
#define Q_NETBEUI 30
122
123
/* IS-IS Levels */
124
0
#define Q_ISIS_L1       31
125
0
#define Q_ISIS_L2       32
126
/* PDU types */
127
0
#define Q_ISIS_IIH      33
128
0
#define Q_ISIS_SNP      34
129
0
#define Q_ISIS_CSNP     35
130
0
#define Q_ISIS_PSNP     36
131
0
#define Q_ISIS_LSP      37
132
133
0
#define Q_RADIO   38
134
135
0
#define Q_CARP    39
136
137
/* Directional qualifiers. */
138
139
0
#define Q_SRC   1
140
0
#define Q_DST   2
141
0
#define Q_OR    3
142
0
#define Q_AND   4
143
0
#define Q_ADDR1   5
144
0
#define Q_ADDR2   6
145
0
#define Q_ADDR3   7
146
0
#define Q_ADDR4   8
147
0
#define Q_RA    9
148
0
#define Q_TA    10
149
150
0
#define Q_DEFAULT 0
151
0
#define Q_UNDEF   255
152
153
/* ATM types */
154
0
#define A_METAC   22  /* Meta signalling Circuit */
155
0
#define A_BCC   23  /* Broadcast Circuit */
156
0
#define A_OAMF4SC 24  /* Segment OAM F4 Circuit */
157
0
#define A_OAMF4EC 25  /* End-to-End OAM F4 Circuit */
158
0
#define A_SC    26  /* Signalling Circuit*/
159
0
#define A_ILMIC   27  /* ILMI Circuit */
160
0
#define A_OAM   28  /* OAM cells : F4 only */
161
0
#define A_OAMF4   29  /* OAM F4 cells: Segment + End-to-end */
162
0
#define A_LANE    30  /* LANE traffic */
163
0
#define A_LLC   31  /* LLC-encapsulated traffic */
164
165
/* Based on Q.2931 signalling protocol */
166
0
#define A_SETUP   41  /* Setup message */
167
0
#define A_CALLPROCEED 42  /* Call proceeding message */
168
0
#define A_CONNECT 43  /* Connect message */
169
0
#define A_CONNECTACK  44  /* Connect Ack message */
170
0
#define A_RELEASE 45  /* Release message */
171
0
#define A_RELEASE_DONE  46  /* Release message */
172
173
/* ATM field types */
174
0
#define A_VPI   51
175
0
#define A_VCI   52
176
0
#define A_PROTOTYPE 53
177
0
#define A_MSGTYPE 54
178
0
#define A_CALLREFTYPE 55
179
180
0
#define A_CONNECTMSG  70  /* returns Q.2931 signalling messages for
181
           establishing and destroying switched
182
           virtual connection */
183
0
#define A_METACONNECT 71  /* returns Q.2931 signalling messages for
184
           establishing and destroying predefined
185
           virtual circuits, such as broadcast
186
           circuit, oamf4 segment circuit, oamf4
187
           end-to-end circuits, ILMI circuits or
188
           connection signalling circuit. */
189
190
/* MTP2 types */
191
0
#define M_FISU    22  /* FISU */
192
0
#define M_LSSU    23  /* LSSU */
193
0
#define M_MSU   24  /* MSU */
194
195
/* MTP2 HSL types */
196
0
#define MH_FISU   25  /* FISU for HSL */
197
0
#define MH_LSSU   26  /* LSSU */
198
0
#define MH_MSU    27  /* MSU */
199
200
/* MTP3 field types */
201
0
#define M_SIO   1
202
0
#define M_OPC   2
203
0
#define M_DPC   3
204
0
#define M_SLS   4
205
206
/* MTP3 field types in case of MTP2 HSL */
207
0
#define MH_SIO    5
208
0
#define MH_OPC    6
209
0
#define MH_DPC    7
210
0
#define MH_SLS    8
211
212
213
struct slist;
214
215
/*
216
 * A single statement, corresponding to an instruction in a block.
217
 */
218
struct stmt {
219
  int code;   /* opcode */
220
  struct slist *jt; /* only for relative jump in block */
221
  struct slist *jf; /* only for relative jump in block */
222
  bpf_u_int32 k;    /* k field */
223
};
224
225
struct slist {
226
  struct stmt s;
227
  struct slist *next;
228
};
229
230
/*
231
 * A bit vector to represent definition sets.  We assume TOT_REGISTERS
232
 * is smaller than 8*sizeof(atomset).
233
 */
234
typedef bpf_u_int32 atomset;
235
0
#define ATOMMASK(n) (1 << (n))
236
0
#define ATOMELEM(d, n) (d & ATOMMASK(n))
237
238
/*
239
 * An unbounded set.
240
 */
241
typedef bpf_u_int32 *uset;
242
243
/*
244
 * Total number of atomic entities, including accumulator (A) and index (X).
245
 * We treat all these guys similarly during flow analysis.
246
 */
247
0
#define N_ATOMS (BPF_MEMWORDS+2)
248
249
/*
250
 * Control flow graph of a program.
251
 * This corresponds to an edge in the CFG.
252
 * It's a directed graph, so an edge has a predecessor and a successor.
253
 */
254
struct edge {
255
  u_int id;
256
  int code;   /* opcode for branch corresponding to this edge */
257
  uset edom;
258
  struct block *succ; /* successor vertex */
259
  struct block *pred; /* predecessor vertex */
260
  struct edge *next;  /* link list of incoming edges for a node */
261
};
262
263
/*
264
 * A block is a vertex in the CFG.
265
 * It has a list of statements, with the final statement being a
266
 * branch to successor blocks.
267
 */
268
struct block {
269
  u_int id;
270
  struct slist *stmts;  /* side effect stmts */
271
  struct stmt s;    /* branch stmt */
272
  int mark;
273
  u_int longjt;   /* jt branch requires long jump */
274
  u_int longjf;   /* jf branch requires long jump */
275
  int level;
276
  int offset;
277
  int sense;
278
  struct edge et;   /* edge corresponding to the jt branch */
279
  struct edge ef;   /* edge corresponding to the jf branch */
280
  struct block *head;
281
  struct block *link; /* link field used by optimizer */
282
  uset dom;
283
  uset closure;
284
  struct edge *in_edges;  /* first edge in the set (linked list) of edges with this as a successor */
285
  atomset def, kill;
286
  atomset in_use;
287
  atomset out_use;
288
  int oval;   /* value ID for value tested in branch stmt */
289
  bpf_u_int32 val[N_ATOMS];
290
};
291
292
/*
293
 * A value of 0 for val[i] means the value is unknown.
294
 */
295
0
#define VAL_UNKNOWN 0
296
297
struct arth {
298
  struct block *b;  /* protocol checks */
299
  struct slist *s;  /* stmt list */
300
  int regno;    /* virtual register number of result */
301
};
302
303
struct qual {
304
  unsigned char addr;
305
  unsigned char proto;
306
  unsigned char dir;
307
  unsigned char pad;
308
};
309
310
struct _compiler_state;
311
312
typedef struct _compiler_state compiler_state_t;
313
314
struct arth *gen_loadi(compiler_state_t *, bpf_u_int32);
315
struct arth *gen_load(compiler_state_t *, int, struct arth *, bpf_u_int32);
316
struct arth *gen_loadlen(compiler_state_t *);
317
struct arth *gen_neg(compiler_state_t *, struct arth *);
318
struct arth *gen_arth(compiler_state_t *, int, struct arth *, struct arth *);
319
320
void gen_and(struct block *, struct block *);
321
void gen_or(struct block *, struct block *);
322
void gen_not(struct block *);
323
324
struct block *gen_scode(compiler_state_t *, const char *, struct qual);
325
struct block *gen_ecode(compiler_state_t *, const char *, struct qual);
326
struct block *gen_acode(compiler_state_t *, const char *, struct qual);
327
struct block *gen_mcode(compiler_state_t *, const char *, const char *,
328
    bpf_u_int32, struct qual);
329
#ifdef INET6
330
struct block *gen_mcode6(compiler_state_t *, const char *, const char *,
331
    bpf_u_int32, struct qual);
332
#endif
333
struct block *gen_ncode(compiler_state_t *, const char *, bpf_u_int32,
334
    struct qual);
335
struct block *gen_proto_abbrev(compiler_state_t *, int);
336
struct block *gen_relation(compiler_state_t *, int, struct arth *,
337
    struct arth *, int);
338
struct block *gen_less(compiler_state_t *, int);
339
struct block *gen_greater(compiler_state_t *, int);
340
struct block *gen_byteop(compiler_state_t *, int, int, bpf_u_int32);
341
struct block *gen_broadcast(compiler_state_t *, int);
342
struct block *gen_multicast(compiler_state_t *, int);
343
struct block *gen_ifindex(compiler_state_t *, int);
344
struct block *gen_inbound(compiler_state_t *, int);
345
346
struct block *gen_llc(compiler_state_t *);
347
struct block *gen_llc_i(compiler_state_t *);
348
struct block *gen_llc_s(compiler_state_t *);
349
struct block *gen_llc_u(compiler_state_t *);
350
struct block *gen_llc_s_subtype(compiler_state_t *, bpf_u_int32);
351
struct block *gen_llc_u_subtype(compiler_state_t *, bpf_u_int32);
352
353
struct block *gen_vlan(compiler_state_t *, bpf_u_int32, int);
354
struct block *gen_mpls(compiler_state_t *, bpf_u_int32, int);
355
356
struct block *gen_pppoed(compiler_state_t *);
357
struct block *gen_pppoes(compiler_state_t *, bpf_u_int32, int);
358
359
struct block *gen_geneve(compiler_state_t *, bpf_u_int32, int);
360
361
struct block *gen_atmfield_code(compiler_state_t *, int, bpf_u_int32,
362
    int, int);
363
struct block *gen_atmtype_abbrev(compiler_state_t *, int);
364
struct block *gen_atmmulti_abbrev(compiler_state_t *, int);
365
366
struct block *gen_mtp2type_abbrev(compiler_state_t *, int);
367
struct block *gen_mtp3field_code(compiler_state_t *, int, bpf_u_int32,
368
    int, int);
369
370
struct block *gen_pf_ifname(compiler_state_t *, const char *);
371
struct block *gen_pf_rnr(compiler_state_t *, int);
372
struct block *gen_pf_srnr(compiler_state_t *, int);
373
struct block *gen_pf_ruleset(compiler_state_t *, char *);
374
struct block *gen_pf_reason(compiler_state_t *, int);
375
struct block *gen_pf_action(compiler_state_t *, int);
376
377
struct block *gen_p80211_type(compiler_state_t *, bpf_u_int32, bpf_u_int32);
378
struct block *gen_p80211_fcdir(compiler_state_t *, bpf_u_int32);
379
380
/*
381
 * Representation of a program as a tree of blocks, plus current mark.
382
 * A block is marked if only if its mark equals the current mark.
383
 * Rather than traverse the code array, marking each item, 'cur_mark'
384
 * is incremented.  This automatically makes each element unmarked.
385
 */
386
0
#define isMarked(icp, p) ((p)->mark == (icp)->cur_mark)
387
0
#define unMarkAll(icp) (icp)->cur_mark += 1
388
0
#define Mark(icp, p) ((p)->mark = (icp)->cur_mark)
389
390
struct icode {
391
  struct block *root;
392
  int cur_mark;
393
};
394
395
int bpf_optimize(struct icode *, char *);
396
void bpf_set_error(compiler_state_t *, const char *, ...)
397
    PCAP_PRINTFLIKE(2, 3);
398
399
int finish_parse(compiler_state_t *, struct block *);
400
char *sdup(compiler_state_t *, const char *);
401
402
struct bpf_insn *icode_to_fcode(struct icode *, struct block *, u_int *,
403
    char *);
404
void sappend(struct slist *, struct slist *);
405
406
/*
407
 * Older versions of Bison don't put this declaration in
408
 * grammar.h.
409
 */
410
int pcap_parse(void *, compiler_state_t *);
411
412
/* XXX */
413
0
#define JT(b)  ((b)->et.succ)
414
0
#define JF(b)  ((b)->ef.succ)
415
416
#endif /* gencode_h */