Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 1 | /* |
| 2 | * include/types/pattern.h |
| 3 | * Macros, variables and structures for patterns management. |
| 4 | * |
| 5 | * Copyright (C) 2009-2010 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr> |
| 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
| 21 | |
| 22 | #ifndef _TYPES_PATTERN_H |
| 23 | #define _TYPES_PATTERN_H |
| 24 | |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 25 | #include <sys/socket.h> |
| 26 | #include <netinet/in.h> |
Willy Tarreau | ecfb8e8 | 2012-04-20 12:29:52 +0200 | [diff] [blame] | 27 | #include <types/arg.h> |
| 28 | #include <types/buffers.h> |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 29 | |
| 30 | /* pattern in and out types */ |
| 31 | enum { |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 32 | PATTERN_TYPE_IP = 0, /* ipv4 type */ |
David du Colombier | 4f92d32 | 2011-03-24 11:09:31 +0100 | [diff] [blame] | 33 | PATTERN_TYPE_IPV6, /* ipv6 type */ |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 34 | PATTERN_TYPE_INTEGER, /* unsigned 32bits integer type */ |
| 35 | PATTERN_TYPE_STRING, /* char string type */ |
Emeric Brun | 485479d | 2010-09-23 18:02:19 +0200 | [diff] [blame] | 36 | PATTERN_TYPE_DATA, /* buffer type */ |
| 37 | PATTERN_TYPE_CONSTSTRING, /* constant char string type, data need dup before conversion */ |
| 38 | PATTERN_TYPE_CONSTDATA, /* constant buffer type, data need dup before conversion */ |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 39 | PATTERN_TYPES /* number of types, must always be last */ |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 40 | }; |
| 41 | |
Emeric Brun | 485479d | 2010-09-23 18:02:19 +0200 | [diff] [blame] | 42 | |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 43 | /* pattern fetch direction */ |
| 44 | #define PATTERN_FETCH_REQ 1 |
| 45 | #define PATTERN_FETCH_RTR 2 |
| 46 | |
Emeric Brun | 485479d | 2010-09-23 18:02:19 +0200 | [diff] [blame] | 47 | |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 48 | /* pattern result data */ |
| 49 | union pattern_data { |
Willy Tarreau | aea940e | 2010-06-06 11:56:36 +0200 | [diff] [blame] | 50 | struct in_addr ip; /* used for ipv4 type */ |
David du Colombier | 4f92d32 | 2011-03-24 11:09:31 +0100 | [diff] [blame] | 51 | struct in6_addr ipv6; /* used for ipv6 type */ |
Willy Tarreau | b666bc7 | 2011-12-16 16:44:06 +0100 | [diff] [blame] | 52 | int integer; /* used for unsigned 32bits integer type */ |
Emeric Brun | 485479d | 2010-09-23 18:02:19 +0200 | [diff] [blame] | 53 | struct chunk str; /* used for char string type or buffers*/ |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 54 | }; |
| 55 | |
| 56 | /* pattern result */ |
| 57 | struct pattern { |
| 58 | int type; /* current type of data */ |
| 59 | union pattern_data data; /* data */ |
| 60 | }; |
| 61 | |
| 62 | /* pattern conversion */ |
| 63 | struct pattern_conv { |
| 64 | const char *kw; /* configuration keyword */ |
Willy Tarreau | ecfb8e8 | 2012-04-20 12:29:52 +0200 | [diff] [blame] | 65 | int (*process)(const struct arg *arg_p, |
Willy Tarreau | f995410 | 2012-04-20 14:03:29 +0200 | [diff] [blame^] | 66 | union pattern_data *data); /* process function */ |
Willy Tarreau | 9e92d32 | 2010-01-26 17:58:06 +0100 | [diff] [blame] | 67 | int (*parse_args)(const char *arg_str, |
Willy Tarreau | f995410 | 2012-04-20 14:03:29 +0200 | [diff] [blame^] | 68 | struct arg **arg_p); /* argument parser. May be NULL. */ |
Emeric Brun | 485479d | 2010-09-23 18:02:19 +0200 | [diff] [blame] | 69 | unsigned int in_type; /* input needed pattern type */ |
| 70 | unsigned int out_type; /* output pattern type */ |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 71 | }; |
| 72 | |
| 73 | /* pattern conversion expression */ |
| 74 | struct pattern_conv_expr { |
| 75 | struct list list; /* member of a pattern expression */ |
| 76 | struct pattern_conv *conv; /* pattern conversion */ |
Willy Tarreau | ecfb8e8 | 2012-04-20 12:29:52 +0200 | [diff] [blame] | 77 | struct arg *arg_p; /* pointer on args */ |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 78 | }; |
| 79 | |
| 80 | /* pattern fetch */ |
| 81 | struct pattern_fetch { |
| 82 | const char *kw; /* configuration keyword */ |
| 83 | int (*process)(struct proxy *px, |
| 84 | struct session *l4, |
| 85 | void *l7, |
Willy Tarreau | ecfb8e8 | 2012-04-20 12:29:52 +0200 | [diff] [blame] | 86 | int dir, const struct arg *arg_p, |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 87 | union pattern_data *data); /* fetch processing function */ |
Emeric Brun | 485479d | 2010-09-23 18:02:19 +0200 | [diff] [blame] | 88 | int (*parse_args)(const char *arg_str, |
Willy Tarreau | f995410 | 2012-04-20 14:03:29 +0200 | [diff] [blame^] | 89 | struct arg **arg_p); /* argument parser. Can be NULL. */ |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 90 | unsigned long out_type; /* output pattern type */ |
| 91 | int dir; /* usable directions */ |
| 92 | }; |
| 93 | |
| 94 | /* pattern expression */ |
| 95 | struct pattern_expr { |
| 96 | struct list list; /* member of list of pattern, currently not used */ |
| 97 | struct pattern_fetch *fetch; /* pattern fetch */ |
Willy Tarreau | ecfb8e8 | 2012-04-20 12:29:52 +0200 | [diff] [blame] | 98 | struct arg *arg_p; /* pointer on args */ |
Emeric Brun | 107ca30 | 2010-01-04 16:16:05 +0100 | [diff] [blame] | 99 | struct list conv_exprs; /* list of conversion expression to apply */ |
| 100 | }; |
| 101 | |
| 102 | /* pattern fetch keywords list */ |
| 103 | struct pattern_fetch_kw_list { |
| 104 | struct list list; /* head of pattern fetch keyword list */ |
| 105 | struct pattern_fetch kw[VAR_ARRAY]; /* array of pattern fetches */ |
| 106 | }; |
| 107 | |
| 108 | /* pattern conversion keywords list */ |
| 109 | struct pattern_conv_kw_list { |
| 110 | struct list list; /* head of pattern conversion keyword list */ |
| 111 | struct pattern_conv kw[VAR_ARRAY]; /* array of pattern ions */ |
| 112 | }; |
| 113 | |
| 114 | #endif /* _TYPES_PATTERN_H */ |