blob: 617464ce34a706961fb1ddcb99c59541f961a6eb [file] [log] [blame]
Willy Tarreau3fdb3662012-11-12 00:42:33 +01001/*
2 * include/proto/obj_type.h
3 * This file contains function prototypes to manipulate object types
4 *
Willy Tarreau66337a02013-09-29 09:15:31 +02005 * Copyright (C) 2000-2013 Willy Tarreau - w@1wt.eu
Willy Tarreau3fdb3662012-11-12 00:42:33 +01006 *
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 Tarreau8a8d83b2015-04-13 13:24:54 +020027#include <types/applet.h>
Willy Tarreau51c21842013-09-29 09:06:42 +020028#include <types/connection.h>
Willy Tarreau3fdb3662012-11-12 00:42:33 +010029#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
35static inline enum obj_type obj_type(enum obj_type *t)
36{
Willy Tarreau66337a02013-09-29 09:15:31 +020037 if (!t || *t >= OBJ_TYPE_ENTRIES)
Willy Tarreau3fdb3662012-11-12 00:42:33 +010038 return OBJ_TYPE_NONE;
39 return *t;
40}
41
Willy Tarreau55e4ecd2012-12-08 17:48:47 +010042static inline const char *obj_type_name(enum obj_type *t)
43{
44 switch (obj_type(t)) {
45 case OBJ_TYPE_LISTENER: return "LISTENER";
46 case OBJ_TYPE_PROXY: return "PROXY";
47 case OBJ_TYPE_SERVER: return "SERVER";
48 case OBJ_TYPE_APPLET: return "APPLET";
Willy Tarreau0788f472013-10-24 22:45:25 +020049 case OBJ_TYPE_APPCTX: return "APPCTX";
Willy Tarreau51c21842013-09-29 09:06:42 +020050 case OBJ_TYPE_CONN: return "CONN";
Willy Tarreau55e4ecd2012-12-08 17:48:47 +010051 default: return "NONE";
52 }
53}
54
Willy Tarreau66337a02013-09-29 09:15:31 +020055/* Note: for convenience, we provide two versions of each function :
56 * - __objt_<type> : converts the pointer without any control of its
57 * value nor type.
58 * - objt_<type> : same as above except that if the pointer is NULL
59 * or points to a non-matching type, NULL is returned instead.
60 */
61
62static inline struct listener *__objt_listener(enum obj_type *t)
63{
64 return container_of(t, struct listener, obj_type);
65}
66
Willy Tarreau3fdb3662012-11-12 00:42:33 +010067static inline struct listener *objt_listener(enum obj_type *t)
68{
69 if (!t || *t != OBJ_TYPE_LISTENER)
70 return NULL;
Willy Tarreau66337a02013-09-29 09:15:31 +020071 return __objt_listener(t);
72}
73
74static inline struct proxy *__objt_proxy(enum obj_type *t)
75{
76 return container_of(t, struct proxy, obj_type);
Willy Tarreau3fdb3662012-11-12 00:42:33 +010077}
78
79static inline struct proxy *objt_proxy(enum obj_type *t)
80{
81 if (!t || *t != OBJ_TYPE_PROXY)
82 return NULL;
Willy Tarreau66337a02013-09-29 09:15:31 +020083 return __objt_proxy(t);
84}
85
86static inline struct server *__objt_server(enum obj_type *t)
87{
88 return container_of(t, struct server, obj_type);
Willy Tarreau3fdb3662012-11-12 00:42:33 +010089}
90
91static inline struct server *objt_server(enum obj_type *t)
92{
93 if (!t || *t != OBJ_TYPE_SERVER)
94 return NULL;
Willy Tarreau66337a02013-09-29 09:15:31 +020095 return __objt_server(t);
Willy Tarreau3fdb3662012-11-12 00:42:33 +010096}
97
Willy Tarreau30576452015-04-13 13:50:30 +020098static inline struct applet *__objt_applet(enum obj_type *t)
Willy Tarreau66337a02013-09-29 09:15:31 +020099{
Willy Tarreau30576452015-04-13 13:50:30 +0200100 return container_of(t, struct applet, obj_type);
Willy Tarreau66337a02013-09-29 09:15:31 +0200101}
102
Willy Tarreau30576452015-04-13 13:50:30 +0200103static inline struct applet *objt_applet(enum obj_type *t)
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100104{
105 if (!t || *t != OBJ_TYPE_APPLET)
106 return NULL;
Willy Tarreau66337a02013-09-29 09:15:31 +0200107 return __objt_applet(t);
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100108}
109
Willy Tarreau0788f472013-10-24 22:45:25 +0200110static inline struct appctx *__objt_appctx(enum obj_type *t)
111{
112 return container_of(t, struct appctx, obj_type);
113}
114
115static inline struct appctx *objt_appctx(enum obj_type *t)
116{
117 if (!t || *t != OBJ_TYPE_APPCTX)
118 return NULL;
119 return __objt_appctx(t);
120}
121
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200122static inline struct conn_stream *__objt_cs(enum obj_type *t)
123{
124 return (container_of(t, struct conn_stream, obj_type));
125}
126
127static inline struct conn_stream *objt_cs(enum obj_type *t)
128{
129 if (!t || *t != OBJ_TYPE_CS)
130 return NULL;
131 return __objt_cs(t);
132}
133
Willy Tarreau51c21842013-09-29 09:06:42 +0200134static inline struct connection *__objt_conn(enum obj_type *t)
135{
136 return container_of(t, struct connection, obj_type);
137}
138
139static inline struct connection *objt_conn(enum obj_type *t)
140{
141 if (!t || *t != OBJ_TYPE_CONN)
142 return NULL;
143 return __objt_conn(t);
144}
145
Olivier Houcharde2c222b2017-08-04 18:31:56 +0200146static inline struct dns_srvrq *__objt_dns_srvrq(enum obj_type *t)
147{
148 return container_of(t, struct dns_srvrq, obj_type);
149}
150
151static inline struct dns_srvrq *objt_dns_srvrq(enum obj_type *t)
152{
153 if (!t || *t != OBJ_TYPE_SRVRQ)
154 return NULL;
155 return __objt_dns_srvrq(t);
156}
157
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100158static inline void *obj_base_ptr(enum obj_type *t)
159{
160 switch (obj_type(t)) {
Willy Tarreau66337a02013-09-29 09:15:31 +0200161 case OBJ_TYPE_LISTENER: return __objt_listener(t);
162 case OBJ_TYPE_PROXY: return __objt_proxy(t);
163 case OBJ_TYPE_SERVER: return __objt_server(t);
164 case OBJ_TYPE_APPLET: return __objt_applet(t);
Willy Tarreau0788f472013-10-24 22:45:25 +0200165 case OBJ_TYPE_APPCTX: return __objt_appctx(t);
Willy Tarreau51c21842013-09-29 09:06:42 +0200166 case OBJ_TYPE_CONN: return __objt_conn(t);
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200167 case OBJ_TYPE_CS: return __objt_cs(t);
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100168 default: return NULL;
169 }
170}
171
Willy Tarreau3fdb3662012-11-12 00:42:33 +0100172#endif /* _PROTO_OBJ_TYPE_H */
173
174/*
175 * Local variables:
176 * c-indent-level: 8
177 * c-basic-offset: 8
178 * End:
179 */