8988e5cba806741631fe45a0d36ef7f6ff66c0e3
[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  splitted from data_lump.h (andrei)
37  *
38  */
39
40
41 #ifndef lump_struct_h
42 #define lump_struct_h
43
44
45
46 enum lump_op { LUMP_NOP=0, LUMP_DEL, LUMP_ADD, LUMP_ADD_SUBST, LUMP_ADD_OPT };
47 enum lump_subst{ SUBST_NOP=0,                     /* do nothing */
48                                  SUBST_RCV_IP,    SUBST_SND_IP,   /* add ip address */
49                                  SUBST_RCV_PORT,  SUBST_SND_PORT, /* add port no */
50                                  SUBST_RCV_PROTO, SUBST_SND_PROTO,/* add protocol(udp,tcp,tls)*/
51                                  SUBST_RCV_ALL,   SUBST_SND_ALL   /*  ip:port;transport=proto */
52                                 };
53                                 /* Where:
54                                    SND = sending, e.g the src ip of the outgoing message
55                                    RCV = received e.g the dst ip of the original incoming msg,
56                                     or the ip of the ser socket on which the msg was received
57                                    For SUBST_{RCV,SND}_ALL, :port is added only if port!=5060
58                                     and transport=proto only if proto!=udp
59                                         */
60
61 enum lump_conditions {  COND_FALSE,         /* always false */
62                                                 COND_TRUE,          /* always true */
63                                                 COND_IF_DIFF_REALMS,/* true if RCV realm != SND realm */
64                                                 COND_IF_DIFF_AF,    /* true if RCV af != SND af */
65                                                 COND_IF_DIFF_PROTO, /* true if RCV proto != SND proto */
66                                                 COND_IF_DIFF_PORT,  /* true if RCV port != SND port */
67                                                 COND_IF_DIFF_IP,    /* true if RCV ip != SND ip */
68                                                 COND_IF_RAND        /* 50-50 random prob.of being true*/
69                                                 };
70                                                 /* Where: 
71                                                    REALM= ip_addr:port:proto
72                                                    af   = address family (ipv4 or ipv6)
73                                                    proto = protocol (tcp, udp, tls)
74                                                 */
75
76 enum lump_flag { LUMPFLAG_NONE=0, LUMPFLAG_DUPED=1, LUMPFLAG_SHMEM=2 };
77
78
79 struct lump{
80         int type; /* VIA, OTHER, UNSPEC(=0), ... */
81         enum lump_op op;   /* DEL, ADD, NOP, UNSPEC(=0) */
82         
83         union{
84                 int offset; /* used for DEL, MODIFY */
85                 enum lump_subst subst; /*what to subst: ip addr, port, proto*/
86                 enum lump_conditions cond; /* condition for LUMP_ADD_OPT */
87                 char * value; /* used for ADD */
88         }u;
89         int len; /* length of this header field */
90         
91         
92         struct lump* before; /* list of headers to be inserted in front of the
93                                                                 current one */
94         struct lump* after; /* list of headers to be inserted immediately after
95                                                           the current one */
96         
97         struct lump* next;
98
99         enum lump_flag flags; /* additional hints for use from TM's shmem */
100 };
101
102
103 /*
104  * hdrs must be kept sorted after their offset (DEL, NOP, UNSPEC)
105  * and/or their position (ADD). E.g.:
106  *  - to delete header Z insert it in to the list according to its offset 
107  *   and with op=DELETE
108  * - if you want to add a new header X after a  header Y, insert Y in the list
109  *   with op NOP and after it X (op ADD).
110  * - if you want X before Y, insert X in Y's before list.
111  * - if you want X to be the first header just put it first in hdr_lst.
112  *  -if you want to replace Y with X, insert Y with op=DELETE and then X with
113  *  op=ADD.
114  * before and after must contain only ADD ops!
115  * 
116  * Difference between "after" & "next" when ADDing:
117  * "after" forces the new header immediately after the current one while
118  * "next" means another header can be inserted between them.
119  * 
120  */
121
122 /* frees the content of a lump struct */
123 void free_lump(struct lump* l);
124 /*frees an entire lump list, recursively */
125 void free_lump_list(struct lump* lump_list);
126
127 #endif