Blame view

socket.h 6.53 KB
redmine authored
1
/*
redmine authored
2
    clsync - file tree sync utility based on inotify
redmine authored
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
    
    Copyright (C) 2013  Dmitry Yu Okunev <dyokunev@ut.mephi.ru> 0x8E30679C
    
    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 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

redmine authored
20 21 22
#ifndef __CLSYNC_SOCKET_H
#define __CLSYNC_SOCKET_H

redmine authored
23
#ifdef __linux__
Andrew Savchenko authored
24
#include <linux/limits.h>
redmine authored
25 26
#endif

redmine authored
27
#include <pthread.h>
Andrew Savchenko authored
28
#include <stdint.h>
redmine authored
29

Andrew Savchenko authored
30 31 32
#include "clsync.h"
#include "ctx.h"

redmine authored
33 34
#define SOCKET_DEFAULT_PROT	0
#define SOCKET_DEFAULT_SUBPROT	SUBPROT0_TEXT
redmine authored
35 36 37 38

// buffer size
#define SOCKET_BUFSIZ			(1<<12)

redmine authored
39 40 41 42 43 44 45 46 47 48 49 50 51
#if PIC
#	define SOCKET_PROVIDER_LIBCLSYNC
#else
#	define SOCKET_PROVIDER_CLSYNC
#endif

#ifdef SOCKET_PROVIDER_LIBCLSYNC
#	define SOCKET_MAX SOCKET_MAX_LIBCLSYNC
#endif
#ifdef SOCKET_PROVIDER_CLSYNC
#	define SOCKET_MAX SOCKET_MAX_CLSYNC
#endif

redmine authored
52 53 54 55 56 57 58 59 60 61 62 63
struct socket_sockthreaddata;
struct sockcmd;

typedef int (*clsyncsock_cb_funct_t)(struct socket_sockthreaddata *thread, struct sockcmd *sockcmd_p, void *arg);
struct clsynccbqueue {
	uint64_t		 cmd_num;

	clsyncsock_cb_funct_t	 callback_funct;
	void			*callback_arg;
};
typedef struct clsynccbqueue clsynccbqueue_t;

redmine authored
64
struct clsyncsock {
redmine authored
65 66 67
	int sock;
	uint16_t prot;
	uint16_t subprot;
redmine authored
68 69 70 71 72 73

	uint64_t cmd_num;

	size_t		 cbqueue_len;
	clsynccbqueue_t  cbqueue[CLSYNCSOCK_WINDOW+1];
	clsynccbqueue_t *cbqueue_cache[4*CLSYNCSOCK_WINDOW+1];	// It's a hacky hash-table of size "CLSYNCSOCK_WINDOW*2"
redmine authored
74
};
redmine authored
75
typedef struct clsyncsock clsyncsock_t;
redmine authored
76

redmine authored
77
struct clsyncthread {
redmine authored
78
	clsyncsock_t *clsyncsock_p;
redmine authored
79 80 81 82 83
	void *arg;
	void *funct_arg_free;
};
typedef struct clsyncthread clsyncthread_t;

redmine authored
84 85 86 87 88 89
enum subprot0 {
	SUBPROT0_TEXT,
	SUBPROT0_BINARY,
};
typedef enum subprot0 subprot0_t;

redmine authored
90
enum clsyncsock_state {
redmine authored
91 92 93 94 95 96
	CLSTATE_NONE	= 0,
	CLSTATE_AUTH,
	CLSTATE_MAIN,
	CLSTATE_DYING,
	CLSTATE_DIED,
};
redmine authored
97
typedef enum clsyncsock_state clsyncsock_state_t;
redmine authored
98 99

enum sockcmd_id {
redmine authored
100 101 102 103 104 105
	SOCKCMD_REQUEST_NEGOTIATION	= 000,
	SOCKCMD_REPLY_NEGOTIATION	= 001,
	SOCKCMD_REPLY_ACK		= 150,
	SOCKCMD_REPLY_UNKNOWNCMD	= 160,
	SOCKCMD_REPLY_INVALIDCMDID	= 161,
	SOCKCMD_REPLY_EINVAL		= 162,
redmine authored
106 107 108
	SOCKCMD_REPLY_EEXIST		= 163,
	SOCKCMD_REPLY_EPERM		= 164,
	SOCKCMD_REPLY_ECUSTOM		= 199,
redmine authored
109 110 111 112 113 114
	SOCKCMD_REQUEST_VERSION		= 200,
	SOCKCMD_REQUEST_INFO		= 201,
	SOCKCMD_REQUEST_DUMP		= 202,
	SOCKCMD_REQUEST_LOGIN		= 210,
	SOCKCMD_REQUEST_SET		= 211,
	SOCKCMD_REQUEST_DIE		= 240,
redmine authored
115
	SOCKCMD_REQUEST_QUIT		= 250,
redmine authored
116 117 118 119 120 121
	SOCKCMD_REPLY_VERSION		= 300,
	SOCKCMD_REPLY_INFO		= 301,
	SOCKCMD_REPLY_DUMP		= 302,
	SOCKCMD_REPLY_LOGIN		= 310,
	SOCKCMD_REPLY_SET		= 311,
	SOCKCMD_REPLY_DIE		= 340,
redmine authored
122
	SOCKCMD_REPLY_BYE		= 350,
redmine authored
123
	SOCKCMD_REPLY_UNEXPECTEDEND	= 351,
redmine authored
124
	SOCKCMD_MAXID
redmine authored
125 126 127
};
typedef enum sockcmd_id sockcmd_id_t;

redmine authored
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
struct sockcmd_dat_negotiation {
	uint16_t prot;
	uint16_t subprot;
};
typedef struct sockcmd_dat_negotiation sockcmd_dat_negotiation_t;

struct sockcmd_dat_ack {
	uint64_t	 cmd_num;
	uint16_t	 cmd_id;
};
typedef struct sockcmd_dat_ack sockcmd_dat_ack_t;
#define sockcmd_dat_einval       sockcmd_dat_ack
#define sockcmd_dat_einval_t     sockcmd_dat_ack_t
#define sockcmd_dat_unknowncmd   sockcmd_dat_ack
#define sockcmd_dat_unknowncmd_t sockcmd_dat_ack_t

struct sockcmd_dat_invalidcmd {
	uint64_t	 cmd_num;
};
typedef struct sockcmd_dat_invalidcmd sockcmd_dat_invalidcmd_t;

struct sockcmd_dat_version {
	int		major;
	int		minor;
	char		revision[1<<8];
};
typedef struct sockcmd_dat_version sockcmd_dat_version_t;

struct sockcmd_dat_info {
	char		config_block[1<<8];
	char		label[1<<8];
	char		flags[OPTION_FLAGS];
	char		flags_set[OPTION_FLAGS];
};
typedef struct sockcmd_dat_info sockcmd_dat_info_t;

redmine authored
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
struct sockcmd_dat_dump {
	char		dir_path[PATH_MAX];
};
typedef struct sockcmd_dat_dump sockcmd_dat_dump_t;

struct sockcmd_dat_eexist {
	char		file_path[PATH_MAX];
};
typedef struct sockcmd_dat_eexist sockcmd_dat_eexist_t;

struct sockcmd_dat_eperm {
	char		descr[BUFSIZ];
};
typedef struct sockcmd_dat_eperm sockcmd_dat_eperm_t;

redmine authored
179 180 181 182 183 184
struct sockcmd_dat_set {
	char		key[BUFSIZ];
	char		value[BUFSIZ];
};
typedef struct sockcmd_dat_set sockcmd_dat_set_t;

redmine authored
185
struct sockcmd {
redmine authored
186 187 188
	uint64_t	 cmd_num;
	uint16_t	 cmd_id;
	size_t		 data_len;
redmine authored
189
	void		*data;
redmine authored
190 191
};
typedef struct sockcmd sockcmd_t;
redmine authored
192

redmine authored
193
enum sockprocflags {
redmine authored
194
	SOCKPROCFLAG_NONE		= 0x00,
redmine authored
195 196 197 198 199 200 201 202 203 204
};
typedef enum sockprocflags sockprocflags_t;

enum sockauth_id {
	SOCKAUTH_UNSET	= 0,
	SOCKAUTH_NULL,
	SOCKAUTH_PAM,
};
typedef enum sockauth_id sockauth_id_t;

redmine authored
205 206
struct socket_sockthreaddata;
typedef int (*clsyncsock_procfunct_t)(struct socket_sockthreaddata *, sockcmd_t *);
redmine authored
207
typedef void (*freefunct_t)(void *);
redmine authored
208
struct socket_sockthreaddata {
redmine authored
209
	int			 id;
redmine authored
210
	clsyncsock_procfunct_t	 procfunct;
redmine authored
211
	freefunct_t		 freefunct_arg;
redmine authored
212
	clsyncsock_t		*clsyncsock_p;
redmine authored
213
	void			*arg;
redmine authored
214
	clsyncsock_state_t	 state;
redmine authored
215 216 217
	sockauth_id_t		 authtype;
	int			*running;		// Pointer to interger with non-zero value to continue running
	sockprocflags_t		 flags;
redmine authored
218
	pthread_t		 thread;
redmine authored
219
};
redmine authored
220
typedef struct socket_sockthreaddata socket_sockthreaddata_t;
redmine authored
221

redmine authored
222
extern int socket_reply(clsyncsock_t *clsyncsock_p, sockcmd_t *sockcmd_p, sockcmd_id_t cmd_id, ...);
redmine authored
223
extern int socket_send(clsyncsock_t *clsyncsock, sockcmd_id_t cmd_id, ...);
redmine authored
224
extern int socket_send_cb(clsyncsock_t *clsyncsock_p, sockcmd_id_t cmd_id, clsyncsock_cb_funct_t cb, void *cb_arg, ...);
redmine authored
225 226
extern int socket_sendinvalid(clsyncsock_t *clsyncsock_p, sockcmd_t *sockcmd_p);
extern int socket_recv(clsyncsock_t *clsyncsock, sockcmd_t *sockcmd);
redmine authored
227
extern int socket_check_bysock(int sock);
redmine authored
228 229
extern clsyncsock_t *socket_accept(int sock);
extern int socket_cleanup(clsyncsock_t *clsyncsock_p);
redmine authored
230
extern int socket_close(clsyncsock_t *clsyncsock_p);
redmine authored
231 232
extern int socket_init();
extern int socket_deinit();
redmine authored
233 234 235
extern int socket_procclsyncsock(socket_sockthreaddata_t *arg);
extern clsyncsock_t *socket_connect_unix(const char *const socket_path);
extern clsyncsock_t *socket_listen_unix (const char *const socket_path);
redmine authored
236

redmine authored
237 238
extern socket_sockthreaddata_t *socket_thread_attach(clsyncsock_t *clsyncsock_p);
extern int socket_thread_start(socket_sockthreaddata_t *threaddata_p);
redmine authored
239

redmine authored
240 241 242
extern int clsyncsocks_num;
extern int clsyncsocks_count;
extern int clsyncsocks_last;
redmine authored
243

redmine authored
244 245
extern const char *const textmessage_args[];
extern const char *const textmessage_descr[];
redmine authored
246

redmine authored
247 248
#endif