src/frontend/connection-private.h

   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  */
  27
  28 /*
  29  * private data structures used by frontend modules
  30  */
  31
  32 #ifndef SDB_FRONTEND_CONNECTION_PRIVATE_H
  33 #define SDB_FRONTEND_CONNECTION_PRIVATE_H 1
  34
  35 #include "frontend/connection.h"
  36
  37 #include "core/object.h"
  38 #include "core/store.h"
  39 #include "core/timeseries.h"
  40 #include "utils/strbuf.h"
  41
  42 #include <inttypes.h>
  43 #include <arpa/inet.h>
  44
  45 #include <stdlib.h>
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 struct sdb_conn {
  52         sdb_object_t super;
  53
  54         /* file-descriptor of the open connection */
  55         int fd;
  56
  57         /* connection and client information */
  58         struct sockaddr_storage client_addr;
  59         socklen_t client_addr_len;
  60
  61         /* read buffer */
  62         sdb_strbuf_t *buf;
  63
  64         /* connection / protocol state information */
  65         uint32_t cmd;
  66         uint32_t cmd_len;
  67
  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;
  71
  72         sdb_strbuf_t *errbuf;
  73
  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))
  79
  80 /*
  81  * node types
  82  */
  83
  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))
  89
  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))
  95
  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))
 102
 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))
 111
 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))
 119
 120 typedef struct {
 121         sdb_conn_node_t super;
 122         char *hostname;
 123         char *metric;
 124         sdb_timeseries_opts_t opts;
 125 } conn_ts_t;
 126 #define CONN_TS(obj) ((conn_ts_t *)(obj))
 127
 128 /*
 129  * type helper functions
 130  */
 131
 132 static void __attribute__((unused))
 133 conn_expr_destroy(sdb_object_t *obj)
 134 {
 135         sdb_object_deref(SDB_OBJ(CONN_EXPR(obj)->expr));
 136 } /* conn_expr_destroy */
 137
 138 static void __attribute__((unused))
 139 conn_matcher_destroy(sdb_object_t *obj)
 140 {
 141         sdb_object_deref(SDB_OBJ(CONN_MATCHER(obj)->matcher));
 142 } /* conn_matcher_destroy */
 143
 144 static void __attribute__((unused))
 145 conn_list_destroy(sdb_object_t *obj)
 146 {
 147         sdb_object_deref(SDB_OBJ(CONN_LIST(obj)->filter));
 148 } /* conn_list_destroy */
 149
 150 static void __attribute__((unused))
 151 conn_fetch_destroy(sdb_object_t *obj)
 152 {
 153         if (CONN_FETCH(obj)->host)
 154                 free(CONN_FETCH(obj)->host);
 155         if (CONN_FETCH(obj)->name)
 156                 free(CONN_FETCH(obj)->name);
 157         sdb_object_deref(SDB_OBJ(CONN_FETCH(obj)->filter));
 158 } /* conn_fetch_destroy */
 159
 160 static void __attribute__((unused))
 161 conn_lookup_destroy(sdb_object_t *obj)
 162 {
 163         sdb_object_deref(SDB_OBJ(CONN_LOOKUP(obj)->matcher));
 164         sdb_object_deref(SDB_OBJ(CONN_LOOKUP(obj)->filter));
 165 } /* conn_lookup_destroy */
 166
 167 static void __attribute__((unused))
 168 conn_ts_destroy(sdb_object_t *obj)
 169 {
 170         if (CONN_TS(obj)->hostname)
 171                 free(CONN_TS(obj)->hostname);
 172         if (CONN_TS(obj)->metric)
 173                 free(CONN_TS(obj)->metric);
 174 } /* conn_ts_destroy */
 175
 176 #ifdef __cplusplus
 177 } /* extern "C" */
 178 #endif
 179
 180 #endif /* ! SDB_FRONTEND_CONNECTION_H */
 181
 182 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 183