contrib/spoa_server/spoa.h

/* Main SPOA server includes
 *
 * Copyright 2016 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com>
 * Copyright 2018 OZON / Thierry Fournier <thierry.fournier@ozon.io>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */
#ifndef __SPOA_H__
#define __SPOA_H__

#include <pthread.h>
#include <stdbool.h>
#include <stdint.h>
#include <netinet/in.h>
#include <sys/time.h>

#define MAX_FRAME_SIZE    16384
#define SPOP_VERSION      "2.0"
#define SPOA_CAPABILITIES ""

/* Flags set on the SPOE frame */
#define SPOE_FRM_FL_FIN         0x00000001

/* All supported data types */
enum spoe_data_type {
	SPOE_DATA_T_NULL = 0,
	SPOE_DATA_T_BOOL,
	SPOE_DATA_T_INT32,
	SPOE_DATA_T_UINT32,
	SPOE_DATA_T_INT64,
	SPOE_DATA_T_UINT64,
	SPOE_DATA_T_IPV4,
	SPOE_DATA_T_IPV6,
	SPOE_DATA_T_STR,
	SPOE_DATA_T_BIN,
	SPOE_DATA_TYPES
};

/* Scopes used for variables set by agents. It is a way to be agnotic to vars
 * scope. */
enum spoe_vars_scope {
	SPOE_SCOPE_PROC = 0, /* <=> SCOPE_PROC  */
	SPOE_SCOPE_SESS,     /* <=> SCOPE_SESS */
	SPOE_SCOPE_TXN,      /* <=> SCOPE_TXN  */
	SPOE_SCOPE_REQ,      /* <=> SCOPE_REQ  */
	SPOE_SCOPE_RES,      /* <=> SCOPE_RES  */
};

struct worker {
	unsigned int id;
	char         buf[MAX_FRAME_SIZE];
	unsigned int len;
	unsigned int size;
	int          status_code;
	unsigned int stream_id;
	unsigned int frame_id;
	bool         healthcheck;
	char         ack[MAX_FRAME_SIZE];
	unsigned int ack_len;
};

struct chunk {
	char *str;	/* beginning of the string itself. Might not be 0-terminated */
	int len;	/* current size of the string from first to last char */
};

union spoe_value {
	bool            boolean; /* use for boolean */
	int32_t         sint32;  /* used for signed 32bits integers */
	uint32_t        uint32;  /* used for signed 32bits integers */
	int32_t         sint64;  /* used for signed 64bits integers */
	uint32_t        uint64;  /* used for signed 64bits integers */
	struct in_addr  ipv4;    /* used for ipv4 addresses */
	struct in6_addr ipv6;    /* used for ipv6 addresses */
	struct chunk    buffer;  /* used for char strings or buffers */
};

/* Used to store sample constant */
struct spoe_data {
	enum spoe_data_type type;  /* SPOE_DATA_T_* */
	union spoe_value    u;     /* spoe data value */
};

struct spoe_kv {
	struct chunk name;
	struct spoe_data value;
};

struct ps {
	struct ps *next;
	char *ext;
	int (*init_worker)(struct worker *w);
	int (*exec_message)(struct worker *w, void *ref, int nargs, struct spoe_kv *args);
	int (*load_file)(struct worker *w, const char *file);
};

struct ps_message {
	struct ps_message *next;
	const char *name;
	struct ps *ps;
	void *ref;
};

extern bool debug;
extern pthread_key_t worker_id;

void ps_register(struct ps *ps);
void ps_register_message(struct ps *ps, const char *name, void *ref);

int set_var_null(struct worker *w,
                 const char *name, int name_len,
                 unsigned char scope);
int set_var_bool(struct worker *w,
                 const char *name, int name_len,
                 unsigned char scope, bool value);
int set_var_uint32(struct worker *w,
                   const char *name, int name_len,
                   unsigned char scope, uint32_t value);
int set_var_int32(struct worker *w,
                  const char *name, int name_len,
                  unsigned char scope, int32_t value);
int set_var_uint64(struct worker *w,
                   const char *name, int name_len,
                   unsigned char scope, uint64_t value);
int set_var_int64(struct worker *w,
                  const char *name, int name_len,
                  unsigned char scope, int64_t value);
int set_var_ipv4(struct worker *w,
                 const char *name, int name_len,
                 unsigned char scope,
                 struct in_addr *ipv4);
int set_var_ipv6(struct worker *w,
                 const char *name, int name_len,
                 unsigned char scope,
                 struct in6_addr *ipv6);
int set_var_string(struct worker *w,
                   const char *name, int name_len,
                   unsigned char scope,
                   const char *str, int strlen);
int set_var_bin(struct worker *w,
                const char *name, int name_len,
                unsigned char scope,
                const char *str, int strlen);

#define LOG(fmt, args...) \
	do { \
		struct timeval now; \
		int wid = *((int*)pthread_getspecific(worker_id)); \
		\
		gettimeofday(&now, NULL); \
		fprintf(stderr, "%ld.%06ld [%02d] " fmt "\n", \
		        now.tv_sec, now.tv_usec, wid, ##args); \
	} while (0)

#define DEBUG(x...) \
	do { \
		if (debug) \
			LOG(x); \
	} while (0)

#endif /* __SPOA_H__ */