hast.h revision 219721
1/*-
2 * Copyright (c) 2009-2010 The FreeBSD Foundation
3 * Copyright (c) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>
4 * All rights reserved.
5 *
6 * This software was developed by Pawel Jakub Dawidek under sponsorship from
7 * the FreeBSD Foundation.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD: head/sbin/hastd/hast.h 219721 2011-03-17 21:02:14Z trociny $
31 */
32
33#ifndef	_HAST_H_
34#define	_HAST_H_
35
36#include <sys/queue.h>
37#include <sys/socket.h>
38
39#include <arpa/inet.h>
40
41#include <netinet/in.h>
42
43#include <limits.h>
44#include <pthread.h>
45#include <stdbool.h>
46#include <stdint.h>
47
48#include <activemap.h>
49
50#include "proto.h"
51
52/*
53 * Version history:
54 * 0 - initial version
55 * 1 - HIO_KEEPALIVE added
56 */
57#define	HAST_PROTO_VERSION	1
58
59#define	EHAST_OK		0
60#define	EHAST_NOENTRY		1
61#define	EHAST_INVALID		2
62#define	EHAST_NOMEMORY		3
63#define	EHAST_UNIMPLEMENTED	4
64
65#define	HASTCTL_CMD_UNKNOWN	0
66#define	HASTCTL_CMD_SETROLE	1
67#define	HASTCTL_CMD_STATUS	2
68
69#define	HAST_ROLE_UNDEF		0
70#define	HAST_ROLE_INIT		1
71#define	HAST_ROLE_PRIMARY	2
72#define	HAST_ROLE_SECONDARY	3
73
74#define	HAST_SYNCSRC_UNDEF	0
75#define	HAST_SYNCSRC_PRIMARY	1
76#define	HAST_SYNCSRC_SECONDARY	2
77
78#define	HIO_UNDEF		0
79#define	HIO_READ		1
80#define	HIO_WRITE		2
81#define	HIO_DELETE		3
82#define	HIO_FLUSH		4
83#define	HIO_KEEPALIVE		5
84
85#define	HAST_USER	"hast"
86#define	HAST_TIMEOUT	5
87#define	HAST_CONFIG	"/etc/hast.conf"
88#define	HAST_CONTROL	"/var/run/hastctl"
89#define	HASTD_PORT	8457
90#define	HASTD_LISTEN	"tcp4://0.0.0.0:8457"
91#define	HASTD_PIDFILE	"/var/run/hastd.pid"
92
93/* Default extent size. */
94#define	HAST_EXTENTSIZE	2097152
95/* Default maximum number of extents that are kept dirty. */
96#define	HAST_KEEPDIRTY	64
97
98#define	HAST_ADDRSIZE	1024
99#define	HAST_TOKEN_SIZE	16
100
101/* Number of seconds to sleep between reconnect retries or keepalive packets. */
102#define	HAST_KEEPALIVE	10
103
104struct hastd_config {
105	/* Address to communicate with hastctl(8). */
106	char	 hc_controladdr[HAST_ADDRSIZE];
107	/* Protocol-specific data. */
108	struct proto_conn *hc_controlconn;
109	/* Incoming control connection. */
110	struct proto_conn *hc_controlin;
111	/* Address to listen on. */
112	char	 hc_listenaddr[HAST_ADDRSIZE];
113	/* Protocol-specific data. */
114	struct proto_conn *hc_listenconn;
115	/* List of resources. */
116	TAILQ_HEAD(, hast_resource) hc_resources;
117};
118
119#define	HAST_REPLICATION_FULLSYNC	0
120#define	HAST_REPLICATION_MEMSYNC	1
121#define	HAST_REPLICATION_ASYNC		2
122
123#define	HAST_COMPRESSION_NONE	0
124#define	HAST_COMPRESSION_HOLE	1
125#define	HAST_COMPRESSION_LZF	2
126
127#define	HAST_CHECKSUM_NONE	0
128#define	HAST_CHECKSUM_CRC32	1
129#define	HAST_CHECKSUM_SHA256	2
130
131/*
132 * Structure that describes single resource.
133 */
134struct hast_resource {
135	/* Resource name. */
136	char	hr_name[NAME_MAX];
137	/* Replication mode (HAST_REPLICATION_*). */
138	int	hr_replication;
139	/* Provider name that will appear in /dev/hast/. */
140	char	hr_provname[NAME_MAX];
141	/* Synchronization extent size. */
142	int	hr_extentsize;
143	/* Maximum number of extents that are kept dirty. */
144	int	hr_keepdirty;
145	/* Path to a program to execute on various events. */
146	char	hr_exec[PATH_MAX];
147	/* Compression algorithm. */
148	int	hr_compression;
149	/* Checksum algorithm. */
150	int	hr_checksum;
151
152	/* Path to local component. */
153	char	hr_localpath[PATH_MAX];
154	/* Descriptor to access local component. */
155	int	hr_localfd;
156	/* Offset into local component. */
157	off_t	hr_localoff;
158	/* Size of usable space. */
159	off_t	hr_datasize;
160	/* Size of entire local provider. */
161	off_t	hr_local_mediasize;
162	/* Sector size of local provider. */
163	unsigned int hr_local_sectorsize;
164
165	/* Descriptor for /dev/ggctl communication. */
166	int	hr_ggatefd;
167	/* Unit number for ggate communication. */
168	int	hr_ggateunit;
169
170	/* Address of the remote component. */
171	char	hr_remoteaddr[HAST_ADDRSIZE];
172	/* Connection for incoming data. */
173	struct proto_conn *hr_remotein;
174	/* Connection for outgoing data. */
175	struct proto_conn *hr_remoteout;
176	/* Token to verify both in and out connection are coming from
177	   the same node (not necessarily from the same address). */
178	unsigned char hr_token[HAST_TOKEN_SIZE];
179	/* Connection timeout. */
180	int	hr_timeout;
181
182	/* Resource unique identifier. */
183	uint64_t hr_resuid;
184	/* Primary's local modification count. */
185	uint64_t hr_primary_localcnt;
186	/* Primary's remote modification count. */
187	uint64_t hr_primary_remotecnt;
188	/* Secondary's local modification count. */
189	uint64_t hr_secondary_localcnt;
190	/* Secondary's remote modification count. */
191	uint64_t hr_secondary_remotecnt;
192	/* Synchronization source. */
193	uint8_t hr_syncsrc;
194
195	/* Resource role: HAST_ROLE_{INIT,PRIMARY,SECONDARY}. */
196	int	hr_role;
197	/* Previous resource role: HAST_ROLE_{INIT,PRIMARY,SECONDARY}. */
198	int	hr_previous_role;
199	/* PID of child worker process. 0 - no child. */
200	pid_t	hr_workerpid;
201	/* Control commands from parent to child. */
202	struct proto_conn *hr_ctrl;
203	/* Events from child to parent. */
204	struct proto_conn *hr_event;
205	/* Connection requests from child to parent. */
206	struct proto_conn *hr_conn;
207
208	/* Activemap structure. */
209	struct activemap *hr_amp;
210	/* Locked used to synchronize access to hr_amp. */
211	pthread_mutex_t hr_amp_lock;
212
213	/* Next resource. */
214	TAILQ_ENTRY(hast_resource) hr_next;
215};
216
217struct hastd_config *yy_config_parse(const char *config, bool exitonerror);
218void yy_config_free(struct hastd_config *config);
219
220void yyerror(const char *);
221int yylex(void);
222int yyparse(void);
223
224#endif	/* !_HAST_H_ */
225