Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 1 | /* |
| 2 | * include/proto/obj_type.h |
| 3 | * This file contains function prototypes to manipulate object types |
| 4 | * |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 5 | * Copyright (C) 2000-2013 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 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 _PROTO_OBJ_TYPE_H |
| 23 | #define _PROTO_OBJ_TYPE_H |
| 24 | |
| 25 | #include <common/config.h> |
| 26 | #include <common/memory.h> |
Willy Tarreau | 8a8d83b | 2015-04-13 13:24:54 +0200 | [diff] [blame] | 27 | #include <types/applet.h> |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 28 | #include <types/connection.h> |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 29 | #include <types/listener.h> |
| 30 | #include <types/obj_type.h> |
| 31 | #include <types/proxy.h> |
| 32 | #include <types/server.h> |
| 33 | #include <types/stream_interface.h> |
| 34 | |
| 35 | static inline enum obj_type obj_type(enum obj_type *t) |
| 36 | { |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 37 | if (!t || *t >= OBJ_TYPE_ENTRIES) |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 38 | return OBJ_TYPE_NONE; |
| 39 | return *t; |
| 40 | } |
| 41 | |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 42 | static inline const char *obj_type_name(enum obj_type *t) |
| 43 | { |
| 44 | switch (obj_type(t)) { |
Willy Tarreau | d5e3c71 | 2018-12-18 16:29:48 +0100 | [diff] [blame] | 45 | case OBJ_TYPE_NONE: return "NONE"; |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 46 | case OBJ_TYPE_LISTENER: return "LISTENER"; |
| 47 | case OBJ_TYPE_PROXY: return "PROXY"; |
| 48 | case OBJ_TYPE_SERVER: return "SERVER"; |
| 49 | case OBJ_TYPE_APPLET: return "APPLET"; |
Willy Tarreau | 0788f47 | 2013-10-24 22:45:25 +0200 | [diff] [blame] | 50 | case OBJ_TYPE_APPCTX: return "APPCTX"; |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 51 | case OBJ_TYPE_CONN: return "CONN"; |
Willy Tarreau | d5e3c71 | 2018-12-18 16:29:48 +0100 | [diff] [blame] | 52 | case OBJ_TYPE_SRVRQ: return "SRVRQ"; |
| 53 | case OBJ_TYPE_CS: return "CS"; |
| 54 | default: return "!INVAL!"; |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 55 | } |
| 56 | } |
| 57 | |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 58 | /* Note: for convenience, we provide two versions of each function : |
| 59 | * - __objt_<type> : converts the pointer without any control of its |
| 60 | * value nor type. |
| 61 | * - objt_<type> : same as above except that if the pointer is NULL |
| 62 | * or points to a non-matching type, NULL is returned instead. |
| 63 | */ |
| 64 | |
| 65 | static inline struct listener *__objt_listener(enum obj_type *t) |
| 66 | { |
| 67 | return container_of(t, struct listener, obj_type); |
| 68 | } |
| 69 | |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 70 | static inline struct listener *objt_listener(enum obj_type *t) |
| 71 | { |
| 72 | if (!t || *t != OBJ_TYPE_LISTENER) |
| 73 | return NULL; |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 74 | return __objt_listener(t); |
| 75 | } |
| 76 | |
| 77 | static inline struct proxy *__objt_proxy(enum obj_type *t) |
| 78 | { |
| 79 | return container_of(t, struct proxy, obj_type); |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | static inline struct proxy *objt_proxy(enum obj_type *t) |
| 83 | { |
| 84 | if (!t || *t != OBJ_TYPE_PROXY) |
| 85 | return NULL; |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 86 | return __objt_proxy(t); |
| 87 | } |
| 88 | |
| 89 | static inline struct server *__objt_server(enum obj_type *t) |
| 90 | { |
| 91 | return container_of(t, struct server, obj_type); |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 92 | } |
| 93 | |
| 94 | static inline struct server *objt_server(enum obj_type *t) |
| 95 | { |
| 96 | if (!t || *t != OBJ_TYPE_SERVER) |
| 97 | return NULL; |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 98 | return __objt_server(t); |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 99 | } |
| 100 | |
Willy Tarreau | 3057645 | 2015-04-13 13:50:30 +0200 | [diff] [blame] | 101 | static inline struct applet *__objt_applet(enum obj_type *t) |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 102 | { |
Willy Tarreau | 3057645 | 2015-04-13 13:50:30 +0200 | [diff] [blame] | 103 | return container_of(t, struct applet, obj_type); |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 104 | } |
| 105 | |
Willy Tarreau | 3057645 | 2015-04-13 13:50:30 +0200 | [diff] [blame] | 106 | static inline struct applet *objt_applet(enum obj_type *t) |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 107 | { |
| 108 | if (!t || *t != OBJ_TYPE_APPLET) |
| 109 | return NULL; |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 110 | return __objt_applet(t); |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 111 | } |
| 112 | |
Willy Tarreau | 0788f47 | 2013-10-24 22:45:25 +0200 | [diff] [blame] | 113 | static inline struct appctx *__objt_appctx(enum obj_type *t) |
| 114 | { |
| 115 | return container_of(t, struct appctx, obj_type); |
| 116 | } |
| 117 | |
| 118 | static inline struct appctx *objt_appctx(enum obj_type *t) |
| 119 | { |
| 120 | if (!t || *t != OBJ_TYPE_APPCTX) |
| 121 | return NULL; |
| 122 | return __objt_appctx(t); |
| 123 | } |
| 124 | |
Olivier Houchard | e2b40b9 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 125 | static inline struct conn_stream *__objt_cs(enum obj_type *t) |
| 126 | { |
| 127 | return (container_of(t, struct conn_stream, obj_type)); |
| 128 | } |
| 129 | |
| 130 | static inline struct conn_stream *objt_cs(enum obj_type *t) |
| 131 | { |
| 132 | if (!t || *t != OBJ_TYPE_CS) |
| 133 | return NULL; |
| 134 | return __objt_cs(t); |
| 135 | } |
| 136 | |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 137 | static inline struct connection *__objt_conn(enum obj_type *t) |
| 138 | { |
| 139 | return container_of(t, struct connection, obj_type); |
| 140 | } |
| 141 | |
| 142 | static inline struct connection *objt_conn(enum obj_type *t) |
| 143 | { |
| 144 | if (!t || *t != OBJ_TYPE_CONN) |
| 145 | return NULL; |
| 146 | return __objt_conn(t); |
| 147 | } |
| 148 | |
Olivier Houchard | e2c222b | 2017-08-04 18:31:56 +0200 | [diff] [blame] | 149 | static inline struct dns_srvrq *__objt_dns_srvrq(enum obj_type *t) |
| 150 | { |
| 151 | return container_of(t, struct dns_srvrq, obj_type); |
| 152 | } |
| 153 | |
| 154 | static inline struct dns_srvrq *objt_dns_srvrq(enum obj_type *t) |
| 155 | { |
| 156 | if (!t || *t != OBJ_TYPE_SRVRQ) |
| 157 | return NULL; |
| 158 | return __objt_dns_srvrq(t); |
| 159 | } |
| 160 | |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 161 | static inline void *obj_base_ptr(enum obj_type *t) |
| 162 | { |
| 163 | switch (obj_type(t)) { |
Willy Tarreau | d5e3c71 | 2018-12-18 16:29:48 +0100 | [diff] [blame] | 164 | case OBJ_TYPE_NONE: return NULL; |
Willy Tarreau | 66337a0 | 2013-09-29 09:15:31 +0200 | [diff] [blame] | 165 | case OBJ_TYPE_LISTENER: return __objt_listener(t); |
| 166 | case OBJ_TYPE_PROXY: return __objt_proxy(t); |
| 167 | case OBJ_TYPE_SERVER: return __objt_server(t); |
| 168 | case OBJ_TYPE_APPLET: return __objt_applet(t); |
Willy Tarreau | 0788f47 | 2013-10-24 22:45:25 +0200 | [diff] [blame] | 169 | case OBJ_TYPE_APPCTX: return __objt_appctx(t); |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 170 | case OBJ_TYPE_CONN: return __objt_conn(t); |
Willy Tarreau | d5e3c71 | 2018-12-18 16:29:48 +0100 | [diff] [blame] | 171 | case OBJ_TYPE_SRVRQ: return __objt_dns_srvrq(t); |
Olivier Houchard | e2b40b9 | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 172 | case OBJ_TYPE_CS: return __objt_cs(t); |
Willy Tarreau | d5e3c71 | 2018-12-18 16:29:48 +0100 | [diff] [blame] | 173 | default: return t; // exact pointer for invalid case |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 174 | } |
| 175 | } |
| 176 | |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 177 | #endif /* _PROTO_OBJ_TYPE_H */ |
| 178 | |
| 179 | /* |
| 180 | * Local variables: |
| 181 | * c-indent-level: 8 |
| 182 | * c-basic-offset: 8 |
| 183 | * End: |
| 184 | */ |