The Tcpdump Group git mirrors - libpcap/blob - gencode.h

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