361af166867e5ce230415c64475af57812952723
1 /*
2 * SysDB - src/frontend/connection-private.h
3 * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 /*
29 * private data structures used by frontend modules
30 */
32 #ifndef SDB_FRONTEND_CONNECTION_PRIVATE_H
33 #define SDB_FRONTEND_CONNECTION_PRIVATE_H 1
35 #include "frontend/connection.h"
37 #include "core/object.h"
38 #include "core/store.h"
39 #include "core/timeseries.h"
40 #include "utils/strbuf.h"
42 #include <inttypes.h>
43 #include <arpa/inet.h>
45 #include <stdlib.h>
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
51 struct sdb_conn {
52 sdb_object_t super;
54 /* file-descriptor of the open connection */
55 int fd;
57 /* connection and client information */
58 struct sockaddr_storage client_addr;
59 socklen_t client_addr_len;
61 /* read buffer */
62 sdb_strbuf_t *buf;
64 /* connection / protocol state information */
65 uint32_t cmd;
66 uint32_t cmd_len;
68 /* amount of data to skip, e.g., after receiving invalid commands; if this
69 * is non-zero, the 'skip_len' first bytes of 'buf' are invalid */
70 size_t skip_len;
72 sdb_strbuf_t *errbuf;
74 /* user information */
75 char *username; /* NULL if the user has not been authenticated */
76 bool ready; /* indicates that startup finished successfully */
77 };
78 #define CONN(obj) ((sdb_conn_t *)(obj))
80 /*
81 * node types
82 */
84 typedef struct {
85 sdb_conn_node_t super;
86 sdb_store_expr_t *expr;
87 } conn_expr_t;
88 #define CONN_EXPR(obj) ((conn_expr_t *)(obj))
90 typedef struct {
91 sdb_conn_node_t super;
92 sdb_store_matcher_t *matcher;
93 } conn_matcher_t;
94 #define CONN_MATCHER(obj) ((conn_matcher_t *)(obj))
96 typedef struct {
97 sdb_conn_node_t super;
98 int type;
99 conn_matcher_t *filter;
100 } conn_list_t;
101 #define CONN_LIST(obj) ((conn_list_t *)(obj))
103 typedef struct {
104 sdb_conn_node_t super;
105 int type;
106 char *host;
107 char *name; /* NULL for type == SDB_HOST */
108 conn_matcher_t *filter;
109 } conn_fetch_t;
110 #define CONN_FETCH(obj) ((conn_fetch_t *)(obj))
112 typedef struct {
113 sdb_conn_node_t super;
114 int type;
115 conn_matcher_t *matcher;
116 conn_matcher_t *filter;
117 } conn_lookup_t;
118 #define CONN_LOOKUP(obj) ((conn_lookup_t *)(obj))
120 typedef struct {
121 sdb_conn_node_t super;
122 char *name;
123 sdb_time_t last_update;
124 } conn_store_host_t;
125 #define CONN_STORE_HOST(obj) ((conn_store_host_t *)(obj))
127 typedef struct {
128 sdb_conn_node_t super;
129 char *hostname;
130 char *name;
131 sdb_time_t last_update;
132 } conn_store_svc_t;
133 #define CONN_STORE_SVC(obj) ((conn_store_svc_t *)(obj))
135 typedef struct {
136 sdb_conn_node_t super;
137 char *hostname;
138 char *name;
139 char *store_type; /* optional */
140 char *store_id; /* optional */
141 sdb_time_t last_update;
142 } conn_store_metric_t;
143 #define CONN_STORE_METRIC(obj) ((conn_store_metric_t *)(obj))
145 typedef struct {
146 sdb_conn_node_t super;
147 int parent_type;
148 char *hostname; /* optional */
149 char *parent;
150 char *key;
151 sdb_data_t value;
152 sdb_time_t last_update;
153 } conn_store_attr_t;
154 #define CONN_STORE_ATTR(obj) ((conn_store_attr_t *)(obj))
156 typedef struct {
157 sdb_conn_node_t super;
158 char *hostname;
159 char *metric;
160 sdb_timeseries_opts_t opts;
161 } conn_ts_t;
162 #define CONN_TS(obj) ((conn_ts_t *)(obj))
164 /*
165 * type helper functions
166 */
168 static void __attribute__((unused))
169 conn_expr_destroy(sdb_object_t *obj)
170 {
171 sdb_object_deref(SDB_OBJ(CONN_EXPR(obj)->expr));
172 } /* conn_expr_destroy */
174 static void __attribute__((unused))
175 conn_matcher_destroy(sdb_object_t *obj)
176 {
177 sdb_object_deref(SDB_OBJ(CONN_MATCHER(obj)->matcher));
178 } /* conn_matcher_destroy */
180 static void __attribute__((unused))
181 conn_list_destroy(sdb_object_t *obj)
182 {
183 sdb_object_deref(SDB_OBJ(CONN_LIST(obj)->filter));
184 } /* conn_list_destroy */
186 static void __attribute__((unused))
187 conn_fetch_destroy(sdb_object_t *obj)
188 {
189 if (CONN_FETCH(obj)->host)
190 free(CONN_FETCH(obj)->host);
191 if (CONN_FETCH(obj)->name)
192 free(CONN_FETCH(obj)->name);
193 sdb_object_deref(SDB_OBJ(CONN_FETCH(obj)->filter));
194 } /* conn_fetch_destroy */
196 static void __attribute__((unused))
197 conn_lookup_destroy(sdb_object_t *obj)
198 {
199 sdb_object_deref(SDB_OBJ(CONN_LOOKUP(obj)->matcher));
200 sdb_object_deref(SDB_OBJ(CONN_LOOKUP(obj)->filter));
201 } /* conn_lookup_destroy */
203 static void __attribute__((unused))
204 conn_store_host_destroy(sdb_object_t *obj)
205 {
206 conn_store_host_t *host = CONN_STORE_HOST(obj);
207 if (host->name)
208 free((void *)host->name);
209 host->name = NULL;
210 } /* conn_store_host_destroy */
212 static void __attribute__((unused))
213 conn_store_svc_destroy(sdb_object_t *obj)
214 {
215 conn_store_svc_t *svc = CONN_STORE_SVC(obj);
216 if (svc->hostname)
217 free((void *)svc->hostname);
218 svc->hostname = NULL;
219 if (svc->name)
220 free((void *)svc->name);
221 svc->name = NULL;
222 } /* conn_store_svc_destroy */
224 static void __attribute__((unused))
225 conn_store_metric_destroy(sdb_object_t *obj)
226 {
227 conn_store_metric_t *metric = CONN_STORE_METRIC(obj);
228 if (metric->hostname)
229 free((void *)metric->hostname);
230 metric->hostname = NULL;
231 if (metric->name)
232 free((void *)metric->name);
233 metric->name = NULL;
234 if (metric->store_type)
235 free((void *)metric->store_type);
236 metric->store_type = NULL;
237 if (metric->store_id)
238 free((void *)metric->store_id);
239 metric->store_id = NULL;
240 } /* conn_store_metric_destroy */
242 static void __attribute__((unused))
243 conn_store_attr_destroy(sdb_object_t *obj)
244 {
245 conn_store_attr_t *attr = CONN_STORE_ATTR(obj);
246 if (attr->hostname)
247 free((void *)attr->hostname);
248 attr->hostname = NULL;
249 if (attr->parent)
250 free((void *)attr->parent);
251 attr->parent = NULL;
252 if (attr->key)
253 free((void *)attr->key);
254 attr->key = NULL;
255 sdb_data_free_datum(&attr->value);
256 } /* conn_store_attr_destroy */
258 static void __attribute__((unused))
259 conn_ts_destroy(sdb_object_t *obj)
260 {
261 if (CONN_TS(obj)->hostname)
262 free(CONN_TS(obj)->hostname);
263 if (CONN_TS(obj)->metric)
264 free(CONN_TS(obj)->metric);
265 } /* conn_ts_destroy */
267 #ifdef __cplusplus
268 } /* extern "C" */
269 #endif
271 #endif /* ! SDB_FRONTEND_CONNECTION_H */
273 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */