parser/sdp: more suggestive debug message
[sip-router] / lump_struct.h
1 /*
2  * $Id$
3  *
4  * adding/removing headers or any other data chunk from a message
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  *
8  * This file is part of ser, a free SIP server.
9  *
10  * ser is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version
14  *
15  * For a license to use the ser software under conditions
16  * other than those described here, or to purchase support for this
17  * software, please contact iptel.org by e-mail at the following addresses:
18  *    info@iptel.org
19  *
20  * ser is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License 
26  * along with this program; if not, write to the Free Software 
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28  */
29 /* History:
30  * --------
31  *  2003-01-29  s/int/enum ... more convenient for gdb (jiri)
32  *  2003-03-31  added subst lumps -- they expand in ip addr, port a.s.o (andrei)
33  *  2003-04-01  added opt (condition) lumps (andrei)
34  *  2003-04-02  added more subst lumps: SUBST_{SND,RCV}_ALL  
35  *              => ip:port;transport=proto (andrei)
36  *  2003-10-20  split from data_lump.h (andrei)
37  *  2005-03-24  the type of type attribute changed to enum _hdr_types_t (janakj)
38  *
39  */
40
41
42 #ifndef lump_struct_h
43 #define lump_struct_h
44
45 #include "./parser/hf.h"
46
47
48 enum lump_op { LUMP_NOP=0, LUMP_DEL, LUMP_ADD, LUMP_ADD_SUBST, LUMP_ADD_OPT };
49 enum lump_subst{ SUBST_NOP=0,                     /* do nothing */
50                                  SUBST_RCV_IP,    SUBST_SND_IP,   /* add ip address */
51                                  SUBST_RCV_PORT,  SUBST_SND_PORT, /* add port no */
52                                  SUBST_RCV_PROTO, SUBST_SND_PROTO,/* add protocol(udp,tcp,tls)*/
53                                  SUBST_RCV_ALL,   SUBST_SND_ALL   /*  ip:port;transport=proto */
54                                 };
55                                 /* Where:
56                                    SND = sending, e.g the src ip of the outgoing message
57                                    RCV = received e.g the dst ip of the original incoming msg,
58                                     or the ip of the ser socket on which the msg was received
59                                    For SUBST_{RCV,SND}_ALL, :port is added only if port!=5060
60                                     and transport=proto only if proto!=udp
61                                         */
62
63 enum lump_conditions {  COND_FALSE,         /* always false */
64                                                 COND_TRUE,          /* always true */
65                                                 COND_IF_DIFF_REALMS,/* true if RCV realm != SND realm */
66                                                 COND_IF_DIFF_AF,    /* true if RCV af != SND af */
67                                                 COND_IF_DIFF_PROTO, /* true if RCV proto != SND proto */
68                                                 COND_IF_DIFF_PORT,  /* true if RCV port != SND port */
69                                                 COND_IF_DIFF_IP,    /* true if RCV ip != SND ip */
70                                                 COND_IF_RAND        /* 50-50 random prob.of being true*/
71                                                 };
72                                                 /* Where: 
73                                                    REALM= ip_addr:port:proto
74                                                    af   = address family (ipv4 or ipv6)
75                                                    proto = protocol (tcp, udp, tls)
76                                                 */
77
78 enum lump_flag { LUMPFLAG_NONE=0, LUMPFLAG_DUPED=1, LUMPFLAG_SHMEM=2,
79         LUMPFLAG_BRANCH=4, LUMPFLAG_COND_TRUE=8 };
80
81 #define LUMP_SET_COND_TRUE(_lump)        (_lump)->flags |= LUMPFLAG_COND_TRUE
82 #define LUMP_IS_COND_TRUE(_lump)         ((_lump)->flags & LUMPFLAG_COND_TRUE)
83
84 struct lump{
85         enum _hdr_types_t type; /* HDR_VIA_T, HDR_OTHER_T (0), ... */
86         enum lump_op op;   /* DEL, ADD, NOP, UNSPEC(=0) */
87         
88         union{
89                 int offset; /* used for DEL, MODIFY */
90                 enum lump_subst subst; /*what to subst: ip addr, port, proto*/
91                 enum lump_conditions cond; /* condition for LUMP_ADD_OPT */
92                 char * value; /* used for ADD */
93         }u;
94         int len; /* length of this header field */
95         
96         
97         struct lump* before; /* list of headers to be inserted in front of the
98                                                                 current one */
99         struct lump* after; /* list of headers to be inserted immediately after
100                                                           the current one */
101         
102         struct lump* next;
103
104         enum lump_flag flags; /* additional hints for use from TM's shmem */
105 };
106
107
108 /*
109  * hdrs must be kept sorted after their offset (DEL, NOP, UNSPEC)
110  * and/or their position (ADD). E.g.:
111  *  - to delete header Z insert it in to the list according to its offset 
112  *   and with op=DELETE
113  * - if you want to add a new header X after a  header Y, insert Y in the list
114  *   with op NOP and after it X (op ADD).
115  * - if you want X before Y, insert X in Y's before list.
116  * - if you want X to be the first header just put it first in hdr_lst.
117  *  -if you want to replace Y with X, insert Y with op=DELETE and then X with
118  *  op=ADD.
119  * before and after must contain only ADD ops!
120  * 
121  * Difference between "after" & "next" when Adding:
122  * "after" forces the new header immediately after the current one while
123  * "next" means another header can be inserted between them.
124  * 
125  */
126
127 /* frees the content of a lump struct */
128 void free_lump(struct lump* l);
129 /* frees an entire lump list, recursively */
130 void free_lump_list(struct lump* lump_list);
131 /* count applied lumps in a list having a specific type */
132 unsigned int count_applied_lumps(struct lump *ll, int type);
133 #endif