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