xref: /freebsd/sbin/hastd/control.c (revision 7079fc4e0236ff334c2fb0f4367159be6df39332)
1 /*-
2  * Copyright (c) 2009-2010 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Pawel Jakub Dawidek under sponsorship from
6  * the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include <sys/types.h>
34 #include <sys/wait.h>
35 
36 #include <errno.h>
37 #include <pthread.h>
38 #include <signal.h>
39 #include <stdio.h>
40 #include <string.h>
41 #include <unistd.h>
42 
43 #include "hast.h"
44 #include "hastd.h"
45 #include "hast_checksum.h"
46 #include "hast_compression.h"
47 #include "hast_proto.h"
48 #include "hooks.h"
49 #include "nv.h"
50 #include "pjdlog.h"
51 #include "proto.h"
52 #include "subr.h"
53 
54 #include "control.h"
55 
56 void
57 child_cleanup(struct hast_resource *res)
58 {
59 
60 	proto_close(res->hr_ctrl);
61 	res->hr_ctrl = NULL;
62 	if (res->hr_event != NULL) {
63 		proto_close(res->hr_event);
64 		res->hr_event = NULL;
65 	}
66 	if (res->hr_conn != NULL) {
67 		proto_close(res->hr_conn);
68 		res->hr_conn = NULL;
69 	}
70 	res->hr_workerpid = 0;
71 }
72 
73 static void
74 control_set_role_common(struct hastd_config *cfg, struct nv *nvout,
75     uint8_t role, struct hast_resource *res, const char *name, unsigned int no)
76 {
77 	int oldrole;
78 
79 	/* Name is always needed. */
80 	if (name != NULL)
81 		nv_add_string(nvout, name, "resource%u", no);
82 
83 	if (res == NULL) {
84 		PJDLOG_ASSERT(cfg != NULL);
85 		PJDLOG_ASSERT(name != NULL);
86 
87 		TAILQ_FOREACH(res, &cfg->hc_resources, hr_next) {
88 			if (strcmp(res->hr_name, name) == 0)
89 				break;
90 		}
91 		if (res == NULL) {
92 			nv_add_int16(nvout, EHAST_NOENTRY, "error%u", no);
93 			return;
94 		}
95 	}
96 	PJDLOG_ASSERT(res != NULL);
97 
98 	/* Send previous role back. */
99 	nv_add_string(nvout, role2str(res->hr_role), "role%u", no);
100 
101 	/* Nothing changed, return here. */
102 	if (role == res->hr_role)
103 		return;
104 
105 	pjdlog_prefix_set("[%s] (%s) ", res->hr_name, role2str(res->hr_role));
106 	pjdlog_info("Role changed to %s.", role2str(role));
107 
108 	/* Change role to the new one. */
109 	oldrole = res->hr_role;
110 	res->hr_role = role;
111 	pjdlog_prefix_set("[%s] (%s) ", res->hr_name, role2str(res->hr_role));
112 
113 	/*
114 	 * If previous role was primary or secondary we have to kill process
115 	 * doing that work.
116 	 */
117 	if (res->hr_workerpid != 0) {
118 		if (kill(res->hr_workerpid, SIGTERM) == -1) {
119 			pjdlog_errno(LOG_WARNING,
120 			    "Unable to kill worker process %u",
121 			    (unsigned int)res->hr_workerpid);
122 		} else if (waitpid(res->hr_workerpid, NULL, 0) !=
123 		    res->hr_workerpid) {
124 			pjdlog_errno(LOG_WARNING,
125 			    "Error while waiting for worker process %u",
126 			    (unsigned int)res->hr_workerpid);
127 		} else {
128 			pjdlog_debug(1, "Worker process %u stopped.",
129 			    (unsigned int)res->hr_workerpid);
130 		}
131 		child_cleanup(res);
132 	}
133 
134 	/* Start worker process if we are changing to primary. */
135 	if (role == HAST_ROLE_PRIMARY)
136 		hastd_primary(res);
137 	pjdlog_prefix_set("%s", "");
138 	hook_exec(res->hr_exec, "role", res->hr_name, role2str(oldrole),
139 	    role2str(res->hr_role), NULL);
140 }
141 
142 void
143 control_set_role(struct hast_resource *res, uint8_t role)
144 {
145 
146 	control_set_role_common(NULL, NULL, role, res, NULL, 0);
147 }
148 
149 static void
150 control_status_worker(struct hast_resource *res, struct nv *nvout,
151     unsigned int no)
152 {
153 	struct nv *cnvin, *cnvout;
154 	const char *str;
155 	int error;
156 
157 	cnvin = NULL;
158 
159 	/*
160 	 * Prepare and send command to worker process.
161 	 */
162 	cnvout = nv_alloc();
163 	nv_add_uint8(cnvout, CONTROL_STATUS, "cmd");
164 	error = nv_error(cnvout);
165 	if (error != 0) {
166 		pjdlog_common(LOG_ERR, 0, error,
167 		    "Unable to prepare control header");
168 		goto end;
169 	}
170 	if (hast_proto_send(res, res->hr_ctrl, cnvout, NULL, 0) == -1) {
171 		error = errno;
172 		pjdlog_errno(LOG_ERR, "Unable to send control header");
173 		goto end;
174 	}
175 
176 	/*
177 	 * Receive response.
178 	 */
179 	if (hast_proto_recv_hdr(res->hr_ctrl, &cnvin) == -1) {
180 		error = errno;
181 		pjdlog_errno(LOG_ERR, "Unable to receive control header");
182 		goto end;
183 	}
184 
185 	error = nv_get_int16(cnvin, "error");
186 	if (error != 0)
187 		goto end;
188 
189 	if ((str = nv_get_string(cnvin, "status")) == NULL) {
190 		error = ENOENT;
191 		pjdlog_errno(LOG_ERR, "Field 'status' is missing.");
192 		goto end;
193 	}
194 	nv_add_string(nvout, str, "status%u", no);
195 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "dirty"), "dirty%u", no);
196 	nv_add_uint32(nvout, nv_get_uint32(cnvin, "extentsize"),
197 	    "extentsize%u", no);
198 	nv_add_uint32(nvout, nv_get_uint32(cnvin, "keepdirty"),
199 	    "keepdirty%u", no);
200 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_read"),
201 	    "stat_read%u", no);
202 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_write"),
203 	    "stat_write%u", no);
204 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_delete"),
205 	    "stat_delete%u", no);
206 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_flush"),
207 	    "stat_flush%u", no);
208 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_activemap_update"),
209 	    "stat_activemap_update%u", no);
210 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_read_error"),
211 	    "stat_read_error%u", no);
212 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_write_error"),
213 	    "stat_write_error%u", no);
214 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_delete_error"),
215 	    "stat_delete_error%u", no);
216 	nv_add_uint64(nvout, nv_get_uint64(cnvin, "stat_flush_error"),
217 	    "stat_flush_error%u", no);
218 end:
219 	if (cnvin != NULL)
220 		nv_free(cnvin);
221 	if (cnvout != NULL)
222 		nv_free(cnvout);
223 	if (error != 0)
224 		nv_add_int16(nvout, error, "error");
225 }
226 
227 static void
228 control_status(struct hastd_config *cfg, struct nv *nvout,
229     struct hast_resource *res, const char *name, unsigned int no)
230 {
231 
232 	PJDLOG_ASSERT(cfg != NULL);
233 	PJDLOG_ASSERT(nvout != NULL);
234 	PJDLOG_ASSERT(name != NULL);
235 
236 	/* Name is always needed. */
237 	nv_add_string(nvout, name, "resource%u", no);
238 
239 	if (res == NULL) {
240 		TAILQ_FOREACH(res, &cfg->hc_resources, hr_next) {
241 			if (strcmp(res->hr_name, name) == 0)
242 				break;
243 		}
244 		if (res == NULL) {
245 			nv_add_int16(nvout, EHAST_NOENTRY, "error%u", no);
246 			return;
247 		}
248 	}
249 	PJDLOG_ASSERT(res != NULL);
250 	nv_add_string(nvout, res->hr_provname, "provname%u", no);
251 	nv_add_string(nvout, res->hr_localpath, "localpath%u", no);
252 	nv_add_string(nvout, res->hr_remoteaddr, "remoteaddr%u", no);
253 	if (res->hr_sourceaddr[0] != '\0')
254 		nv_add_string(nvout, res->hr_sourceaddr, "sourceaddr%u", no);
255 	switch (res->hr_replication) {
256 	case HAST_REPLICATION_FULLSYNC:
257 		nv_add_string(nvout, "fullsync", "replication%u", no);
258 		break;
259 	case HAST_REPLICATION_MEMSYNC:
260 		nv_add_string(nvout, "memsync", "replication%u", no);
261 		break;
262 	case HAST_REPLICATION_ASYNC:
263 		nv_add_string(nvout, "async", "replication%u", no);
264 		break;
265 	default:
266 		nv_add_string(nvout, "unknown", "replication%u", no);
267 		break;
268 	}
269 	nv_add_string(nvout, checksum_name(res->hr_checksum),
270 	    "checksum%u", no);
271 	nv_add_string(nvout, compression_name(res->hr_compression),
272 	    "compression%u", no);
273 	nv_add_string(nvout, role2str(res->hr_role), "role%u", no);
274 	nv_add_int32(nvout, res->hr_workerpid, "workerpid%u", no);
275 
276 	switch (res->hr_role) {
277 	case HAST_ROLE_PRIMARY:
278 		PJDLOG_ASSERT(res->hr_workerpid != 0);
279 		/* FALLTHROUGH */
280 	case HAST_ROLE_SECONDARY:
281 		if (res->hr_workerpid != 0)
282 			break;
283 		/* FALLTHROUGH */
284 	default:
285 		return;
286 	}
287 
288 	/*
289 	 * If we are here, it means that we have a worker process, which we
290 	 * want to ask some questions.
291 	 */
292 	control_status_worker(res, nvout, no);
293 }
294 
295 void
296 control_handle(struct hastd_config *cfg)
297 {
298 	struct proto_conn *conn;
299 	struct nv *nvin, *nvout;
300 	unsigned int ii;
301 	const char *str;
302 	uint8_t cmd, role;
303 	int error;
304 
305 	if (proto_accept(cfg->hc_controlconn, &conn) == -1) {
306 		pjdlog_errno(LOG_ERR, "Unable to accept control connection");
307 		return;
308 	}
309 
310 	cfg->hc_controlin = conn;
311 	nvin = nvout = NULL;
312 	role = HAST_ROLE_UNDEF;
313 
314 	if (hast_proto_recv_hdr(conn, &nvin) == -1) {
315 		pjdlog_errno(LOG_ERR, "Unable to receive control header");
316 		nvin = NULL;
317 		goto close;
318 	}
319 
320 	/* Obtain command code. 0 means that nv_get_uint8() failed. */
321 	cmd = nv_get_uint8(nvin, "cmd");
322 	if (cmd == 0) {
323 		pjdlog_error("Control header is missing 'cmd' field.");
324 		goto close;
325 	}
326 
327 	/* Allocate outgoing nv structure. */
328 	nvout = nv_alloc();
329 	if (nvout == NULL) {
330 		pjdlog_error("Unable to allocate header for control response.");
331 		goto close;
332 	}
333 
334 	error = 0;
335 
336 	str = nv_get_string(nvin, "resource0");
337 	if (str == NULL) {
338 		pjdlog_error("Control header is missing 'resource0' field.");
339 		error = EHAST_INVALID;
340 		goto fail;
341 	}
342 	if (cmd == HASTCTL_CMD_SETROLE) {
343 		role = nv_get_uint8(nvin, "role");
344 		switch (role) {
345 		case HAST_ROLE_INIT:
346 		case HAST_ROLE_PRIMARY:
347 		case HAST_ROLE_SECONDARY:
348 			break;
349 		default:
350 			pjdlog_error("Invalid role received (%hhu).", role);
351 			error = EHAST_INVALID;
352 			goto fail;
353 		}
354 	}
355 	if (strcmp(str, "all") == 0) {
356 		struct hast_resource *res;
357 
358 		/* All configured resources. */
359 
360 		ii = 0;
361 		TAILQ_FOREACH(res, &cfg->hc_resources, hr_next) {
362 			switch (cmd) {
363 			case HASTCTL_CMD_SETROLE:
364 				control_set_role_common(cfg, nvout, role, res,
365 				    res->hr_name, ii++);
366 				break;
367 			case HASTCTL_CMD_STATUS:
368 				control_status(cfg, nvout, res, res->hr_name,
369 				    ii++);
370 				break;
371 			default:
372 				pjdlog_error("Invalid command received (%hhu).",
373 				    cmd);
374 				error = EHAST_UNIMPLEMENTED;
375 				goto fail;
376 			}
377 		}
378 	} else {
379 		/* Only selected resources. */
380 
381 		for (ii = 0; ; ii++) {
382 			str = nv_get_string(nvin, "resource%u", ii);
383 			if (str == NULL)
384 				break;
385 			switch (cmd) {
386 			case HASTCTL_CMD_SETROLE:
387 				control_set_role_common(cfg, nvout, role, NULL,
388 				    str, ii);
389 				break;
390 			case HASTCTL_CMD_STATUS:
391 				control_status(cfg, nvout, NULL, str, ii);
392 				break;
393 			default:
394 				pjdlog_error("Invalid command received (%hhu).",
395 				    cmd);
396 				error = EHAST_UNIMPLEMENTED;
397 				goto fail;
398 			}
399 		}
400 	}
401 	if (nv_error(nvout) != 0)
402 		goto close;
403 fail:
404 	if (error != 0)
405 		nv_add_int16(nvout, error, "error");
406 
407 	if (hast_proto_send(NULL, conn, nvout, NULL, 0) == -1)
408 		pjdlog_errno(LOG_ERR, "Unable to send control response");
409 close:
410 	if (nvin != NULL)
411 		nv_free(nvin);
412 	if (nvout != NULL)
413 		nv_free(nvout);
414 	proto_close(conn);
415 	cfg->hc_controlin = NULL;
416 }
417 
418 /*
419  * Thread handles control requests from the parent.
420  */
421 void *
422 ctrl_thread(void *arg)
423 {
424 	struct hast_resource *res = arg;
425 	struct nv *nvin, *nvout;
426 	uint8_t cmd;
427 
428 	for (;;) {
429 		if (hast_proto_recv_hdr(res->hr_ctrl, &nvin) == -1) {
430 			if (sigexit_received)
431 				pthread_exit(NULL);
432 			pjdlog_errno(LOG_ERR,
433 			    "Unable to receive control message");
434 			kill(getpid(), SIGTERM);
435 			pthread_exit(NULL);
436 		}
437 		cmd = nv_get_uint8(nvin, "cmd");
438 		if (cmd == 0) {
439 			pjdlog_error("Control message is missing 'cmd' field.");
440 			nv_free(nvin);
441 			continue;
442 		}
443 		nvout = nv_alloc();
444 		switch (cmd) {
445 		case CONTROL_STATUS:
446 			if (res->hr_remotein != NULL &&
447 			    res->hr_remoteout != NULL) {
448 				nv_add_string(nvout, "complete", "status");
449 			} else {
450 				nv_add_string(nvout, "degraded", "status");
451 			}
452 			nv_add_uint32(nvout, (uint32_t)res->hr_extentsize,
453 			    "extentsize");
454 			if (res->hr_role == HAST_ROLE_PRIMARY) {
455 				nv_add_uint32(nvout,
456 				    (uint32_t)res->hr_keepdirty, "keepdirty");
457 				nv_add_uint64(nvout,
458 				    (uint64_t)(activemap_ndirty(res->hr_amp) *
459 				    res->hr_extentsize), "dirty");
460 			} else {
461 				nv_add_uint32(nvout, (uint32_t)0, "keepdirty");
462 				nv_add_uint64(nvout, (uint64_t)0, "dirty");
463 			}
464 			nv_add_uint64(nvout, res->hr_stat_read, "stat_read");
465 			nv_add_uint64(nvout, res->hr_stat_write, "stat_write");
466 			nv_add_uint64(nvout, res->hr_stat_delete,
467 			    "stat_delete");
468 			nv_add_uint64(nvout, res->hr_stat_flush, "stat_flush");
469 			nv_add_uint64(nvout, res->hr_stat_activemap_update,
470 			    "stat_activemap_update");
471 			nv_add_uint64(nvout, res->hr_stat_read_error,
472 			    "stat_read_error");
473 			nv_add_uint64(nvout, res->hr_stat_write_error +
474 			    res->hr_stat_activemap_write_error,
475 			    "stat_write_error");
476 			nv_add_uint64(nvout, res->hr_stat_delete_error,
477 			    "stat_delete_error");
478 			nv_add_uint64(nvout, res->hr_stat_flush_error +
479 			    res->hr_stat_activemap_flush_error,
480 			    "stat_flush_error");
481 			nv_add_int16(nvout, 0, "error");
482 			break;
483 		case CONTROL_RELOAD:
484 			/*
485 			 * When parent receives SIGHUP and discovers that
486 			 * something related to us has changes, it sends reload
487 			 * message to us.
488 			 */
489 			PJDLOG_ASSERT(res->hr_role == HAST_ROLE_PRIMARY);
490 			primary_config_reload(res, nvin);
491 			nv_add_int16(nvout, 0, "error");
492 			break;
493 		default:
494 			nv_add_int16(nvout, EINVAL, "error");
495 			break;
496 		}
497 		nv_free(nvin);
498 		if (nv_error(nvout) != 0) {
499 			pjdlog_error("Unable to create answer on control message.");
500 			nv_free(nvout);
501 			continue;
502 		}
503 		if (hast_proto_send(NULL, res->hr_ctrl, nvout, NULL, 0) == -1) {
504 			pjdlog_errno(LOG_ERR,
505 			    "Unable to send reply to control message");
506 		}
507 		nv_free(nvout);
508 	}
509 	/* NOTREACHED */
510 	return (NULL);
511 }
512