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 * 2 - "memsync" and "received" attributes added for memsync mode 57 */ 58 #define HAST_PROTO_VERSION 2 59 60 #define EHAST_OK 0 61 #define EHAST_NOENTRY 1 62 #define EHAST_INVALID 2 63 #define EHAST_NOMEMORY 3 64 #define EHAST_UNIMPLEMENTED 4 65 66 #define HASTCTL_CMD_UNKNOWN 0 67 #define HASTCTL_CMD_SETROLE 1 68 #define HASTCTL_CMD_STATUS 2 69 70 #define HAST_ROLE_UNDEF 0 71 #define HAST_ROLE_INIT 1 72 #define HAST_ROLE_PRIMARY 2 73 #define HAST_ROLE_SECONDARY 3 74 75 #define HAST_SYNCSRC_UNDEF 0 76 #define HAST_SYNCSRC_PRIMARY 1 77 #define HAST_SYNCSRC_SECONDARY 2 78 79 #define HIO_UNDEF 0 80 #define HIO_READ 1 81 #define HIO_WRITE 2 82 #define HIO_DELETE 3 83 #define HIO_FLUSH 4 84 #define HIO_KEEPALIVE 5 85 86 #define HAST_USER "hast" 87 #define HAST_TIMEOUT 20 88 #define HAST_CONFIG "/etc/hast.conf" 89 #define HAST_CONTROL "/var/run/hastctl" 90 #define HASTD_LISTEN_TCP4 "tcp4://0.0.0.0:8457" 91 #define HASTD_LISTEN_TCP6 "tcp6://[::]:8457" 92 #define HASTD_PIDFILE "/var/run/hastd.pid" 93 94 /* Default extent size. */ 95 #define HAST_EXTENTSIZE 2097152 96 /* Default maximum number of extents that are kept dirty. */ 97 #define HAST_KEEPDIRTY 64 98 99 #define HAST_ADDRSIZE 1024 100 #define HAST_TOKEN_SIZE 16 101 102 /* Number of seconds to sleep between reconnect retries or keepalive packets. */ 103 #define HAST_KEEPALIVE 10 104 105 struct hastd_listen { 106 /* Address to listen on. */ 107 char hl_addr[HAST_ADDRSIZE]; 108 /* Protocol-specific data. */ 109 struct proto_conn *hl_conn; 110 TAILQ_ENTRY(hastd_listen) hl_next; 111 }; 112 113 struct hastd_config { 114 /* Address to communicate with hastctl(8). */ 115 char hc_controladdr[HAST_ADDRSIZE]; 116 /* Protocol-specific data. */ 117 struct proto_conn *hc_controlconn; 118 /* Incoming control connection. */ 119 struct proto_conn *hc_controlin; 120 /* PID file path. */ 121 char hc_pidfile[PATH_MAX]; 122 /* List of addresses to listen on. */ 123 TAILQ_HEAD(, hastd_listen) hc_listen; 124 /* List of resources. */ 125 TAILQ_HEAD(, hast_resource) hc_resources; 126 }; 127 128 #define HAST_REPLICATION_FULLSYNC 0 129 #define HAST_REPLICATION_MEMSYNC 1 130 #define HAST_REPLICATION_ASYNC 2 131 132 #define HAST_COMPRESSION_NONE 0 133 #define HAST_COMPRESSION_HOLE 1 134 #define HAST_COMPRESSION_LZF 2 135 136 #define HAST_CHECKSUM_NONE 0 137 #define HAST_CHECKSUM_CRC32 1 138 #define HAST_CHECKSUM_SHA256 2 139 140 struct nv; 141 142 /* 143 * Structure that describes single resource. 144 */ 145 struct hast_resource { 146 /* Resource name. */ 147 char hr_name[NAME_MAX]; 148 /* Negotiated replication mode (HAST_REPLICATION_*). */ 149 int hr_replication; 150 /* Configured replication mode (HAST_REPLICATION_*). */ 151 int hr_original_replication; 152 /* Provider name that will appear in /dev/hast/. */ 153 char hr_provname[NAME_MAX]; 154 /* Synchronization extent size. */ 155 int hr_extentsize; 156 /* Maximum number of extents that are kept dirty. */ 157 int hr_keepdirty; 158 /* Path to a program to execute on various events. */ 159 char hr_exec[PATH_MAX]; 160 /* Compression algorithm. */ 161 int hr_compression; 162 /* Checksum algorithm. */ 163 int hr_checksum; 164 /* Protocol version. */ 165 int hr_version; 166 167 /* Path to local component. */ 168 char hr_localpath[PATH_MAX]; 169 /* Descriptor to access local component. */ 170 int hr_localfd; 171 /* Offset into local component. */ 172 off_t hr_localoff; 173 /* Size of usable space. */ 174 off_t hr_datasize; 175 /* Size of entire local provider. */ 176 off_t hr_local_mediasize; 177 /* Sector size of local provider. */ 178 unsigned int hr_local_sectorsize; 179 /* Is flushing write cache supported by the local provider? */ 180 bool hr_localflush; 181 /* Flush write cache on metadata updates? */ 182 int hr_metaflush; 183 184 /* Descriptor for /dev/ggctl communication. */ 185 int hr_ggatefd; 186 /* Unit number for ggate communication. */ 187 int hr_ggateunit; 188 189 /* Address of the remote component. */ 190 char hr_remoteaddr[HAST_ADDRSIZE]; 191 /* Local address to bind to for outgoing connections. */ 192 char hr_sourceaddr[HAST_ADDRSIZE]; 193 /* Connection for incoming data. */ 194 struct proto_conn *hr_remotein; 195 /* Connection for outgoing data. */ 196 struct proto_conn *hr_remoteout; 197 /* Token to verify both in and out connection are coming from 198 the same node (not necessarily from the same address). */ 199 unsigned char hr_token[HAST_TOKEN_SIZE]; 200 /* Connection timeout. */ 201 int hr_timeout; 202 203 /* Resource unique identifier. */ 204 uint64_t hr_resuid; 205 /* Primary's local modification count. */ 206 uint64_t hr_primary_localcnt; 207 /* Primary's remote modification count. */ 208 uint64_t hr_primary_remotecnt; 209 /* Secondary's local modification count. */ 210 uint64_t hr_secondary_localcnt; 211 /* Secondary's remote modification count. */ 212 uint64_t hr_secondary_remotecnt; 213 /* Synchronization source. */ 214 uint8_t hr_syncsrc; 215 216 /* Resource role: HAST_ROLE_{INIT,PRIMARY,SECONDARY}. */ 217 int hr_role; 218 /* Previous resource role: HAST_ROLE_{INIT,PRIMARY,SECONDARY}. */ 219 int hr_previous_role; 220 /* PID of child worker process. 0 - no child. */ 221 pid_t hr_workerpid; 222 /* Control commands from parent to child. */ 223 struct proto_conn *hr_ctrl; 224 /* Events from child to parent. */ 225 struct proto_conn *hr_event; 226 /* Connection requests from child to parent. */ 227 struct proto_conn *hr_conn; 228 229 /* Activemap structure. */ 230 struct activemap *hr_amp; 231 /* Lock used to synchronize access to hr_amp. */ 232 pthread_mutex_t hr_amp_lock; 233 /* Lock used to synchronize access to hr_amp diskmap. */ 234 pthread_mutex_t hr_amp_diskmap_lock; 235 236 /* Number of BIO_READ requests. */ 237 uint64_t hr_stat_read; 238 /* Number of BIO_WRITE requests. */ 239 uint64_t hr_stat_write; 240 /* Number of BIO_DELETE requests. */ 241 uint64_t hr_stat_delete; 242 /* Number of BIO_FLUSH requests. */ 243 uint64_t hr_stat_flush; 244 /* Number of activemap updates. */ 245 uint64_t hr_stat_activemap_update; 246 /* Number of local read errors. */ 247 uint64_t hr_stat_read_error; 248 /* Number of local write errors. */ 249 uint64_t hr_stat_write_error; 250 /* Number of local delete errors. */ 251 uint64_t hr_stat_delete_error; 252 /* Number of flush errors. */ 253 uint64_t hr_stat_flush_error; 254 /* Number of activemap write errors. */ 255 uint64_t hr_stat_activemap_write_error; 256 /* Number of activemap flush errors. */ 257 uint64_t hr_stat_activemap_flush_error; 258 259 /* Function to output worker specific info on control status request. */ 260 void (*output_status_aux)(struct nv *); 261 262 /* Next resource. */ 263 TAILQ_ENTRY(hast_resource) hr_next; 264 }; 265 266 struct hastd_config *yy_config_parse(const char *config, bool exitonerror); 267 void yy_config_free(struct hastd_config *config); 268 269 #endif /* !_HAST_H_ */ 270