xref: /freebsd/sbin/hastd/hast.h (revision 7a1c0d963366a31363d3705697a083dd8efee077)
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$
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	20
87 #define	HAST_CONFIG	"/etc/hast.conf"
88 #define	HAST_CONTROL	"/var/run/hastctl"
89 #define	HASTD_LISTEN	"tcp4://0.0.0.0:8457"
90 #define	HASTD_PIDFILE	"/var/run/hastd.pid"
91 
92 /* Default extent size. */
93 #define	HAST_EXTENTSIZE	2097152
94 /* Default maximum number of extents that are kept dirty. */
95 #define	HAST_KEEPDIRTY	64
96 
97 #define	HAST_ADDRSIZE	1024
98 #define	HAST_TOKEN_SIZE	16
99 
100 /* Number of seconds to sleep between reconnect retries or keepalive packets. */
101 #define	HAST_KEEPALIVE	10
102 
103 struct hastd_config {
104 	/* Address to communicate with hastctl(8). */
105 	char	 hc_controladdr[HAST_ADDRSIZE];
106 	/* Protocol-specific data. */
107 	struct proto_conn *hc_controlconn;
108 	/* Incoming control connection. */
109 	struct proto_conn *hc_controlin;
110 	/* Address to listen on. */
111 	char	 hc_listenaddr[HAST_ADDRSIZE];
112 	/* Protocol-specific data. */
113 	struct proto_conn *hc_listenconn;
114 	/* List of resources. */
115 	TAILQ_HEAD(, hast_resource) hc_resources;
116 };
117 
118 #define	HAST_REPLICATION_FULLSYNC	0
119 #define	HAST_REPLICATION_MEMSYNC	1
120 #define	HAST_REPLICATION_ASYNC		2
121 
122 #define	HAST_COMPRESSION_NONE	0
123 #define	HAST_COMPRESSION_HOLE	1
124 #define	HAST_COMPRESSION_LZF	2
125 
126 #define	HAST_CHECKSUM_NONE	0
127 #define	HAST_CHECKSUM_CRC32	1
128 #define	HAST_CHECKSUM_SHA256	2
129 
130 /*
131  * Structure that describes single resource.
132  */
133 struct hast_resource {
134 	/* Resource name. */
135 	char	hr_name[NAME_MAX];
136 	/* Replication mode (HAST_REPLICATION_*). */
137 	int	hr_replication;
138 	/* Provider name that will appear in /dev/hast/. */
139 	char	hr_provname[NAME_MAX];
140 	/* Synchronization extent size. */
141 	int	hr_extentsize;
142 	/* Maximum number of extents that are kept dirty. */
143 	int	hr_keepdirty;
144 	/* Path to a program to execute on various events. */
145 	char	hr_exec[PATH_MAX];
146 	/* Compression algorithm. */
147 	int	hr_compression;
148 	/* Checksum algorithm. */
149 	int	hr_checksum;
150 
151 	/* Path to local component. */
152 	char	hr_localpath[PATH_MAX];
153 	/* Descriptor to access local component. */
154 	int	hr_localfd;
155 	/* Offset into local component. */
156 	off_t	hr_localoff;
157 	/* Size of usable space. */
158 	off_t	hr_datasize;
159 	/* Size of entire local provider. */
160 	off_t	hr_local_mediasize;
161 	/* Sector size of local provider. */
162 	unsigned int hr_local_sectorsize;
163 
164 	/* Descriptor for /dev/ggctl communication. */
165 	int	hr_ggatefd;
166 	/* Unit number for ggate communication. */
167 	int	hr_ggateunit;
168 
169 	/* Address of the remote component. */
170 	char	hr_remoteaddr[HAST_ADDRSIZE];
171 	/* Local address to bind to for outgoing connections. */
172 	char	hr_sourceaddr[HAST_ADDRSIZE];
173 	/* Connection for incoming data. */
174 	struct proto_conn *hr_remotein;
175 	/* Connection for outgoing data. */
176 	struct proto_conn *hr_remoteout;
177 	/* Token to verify both in and out connection are coming from
178 	   the same node (not necessarily from the same address). */
179 	unsigned char hr_token[HAST_TOKEN_SIZE];
180 	/* Connection timeout. */
181 	int	hr_timeout;
182 
183 	/* Resource unique identifier. */
184 	uint64_t hr_resuid;
185 	/* Primary's local modification count. */
186 	uint64_t hr_primary_localcnt;
187 	/* Primary's remote modification count. */
188 	uint64_t hr_primary_remotecnt;
189 	/* Secondary's local modification count. */
190 	uint64_t hr_secondary_localcnt;
191 	/* Secondary's remote modification count. */
192 	uint64_t hr_secondary_remotecnt;
193 	/* Synchronization source. */
194 	uint8_t hr_syncsrc;
195 
196 	/* Resource role: HAST_ROLE_{INIT,PRIMARY,SECONDARY}. */
197 	int	hr_role;
198 	/* Previous resource role: HAST_ROLE_{INIT,PRIMARY,SECONDARY}. */
199 	int	hr_previous_role;
200 	/* PID of child worker process. 0 - no child. */
201 	pid_t	hr_workerpid;
202 	/* Control commands from parent to child. */
203 	struct proto_conn *hr_ctrl;
204 	/* Events from child to parent. */
205 	struct proto_conn *hr_event;
206 	/* Connection requests from child to parent. */
207 	struct proto_conn *hr_conn;
208 
209 	/* Activemap structure. */
210 	struct activemap *hr_amp;
211 	/* Locked used to synchronize access to hr_amp. */
212 	pthread_mutex_t hr_amp_lock;
213 
214 	/* Next resource. */
215 	TAILQ_ENTRY(hast_resource) hr_next;
216 };
217 
218 struct hastd_config *yy_config_parse(const char *config, bool exitonerror);
219 void yy_config_free(struct hastd_config *config);
220 
221 void yyerror(const char *);
222 int yylex(void);
223 int yyparse(void);
224 
225 #endif	/* !_HAST_H_ */
226