901e5e2a6301384af83fefd0f6075d59953d4173
[metze/samba/wip.git] / ctdb / common / ctdb_util.c
1 /* 
2    ctdb utility code
3
4    Copyright (C) Andrew Tridgell  2006
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "replace.h"
21 #include "system/network.h"
22 #include "system/filesys.h"
23 #include "system/wait.h"
24
25 #include <tdb.h>
26
27 #include "lib/util/debug.h"
28 #include "lib/util/samba_util.h"
29
30 #include "ctdb_private.h"
31
32 #include "protocol/protocol_util.h"
33
34 #include "common/reqid.h"
35 #include "common/system.h"
36 #include "common/common.h"
37 #include "common/logging.h"
38
39 /*
40   return error string for last error
41 */
42 const char *ctdb_errstr(struct ctdb_context *ctdb)
43 {
44         return ctdb->err_msg;
45 }
46
47
48 /*
49   remember an error message
50 */
51 void ctdb_set_error(struct ctdb_context *ctdb, const char *fmt, ...)
52 {
53         va_list ap;
54         talloc_free(ctdb->err_msg);
55         va_start(ap, fmt);
56         ctdb->err_msg = talloc_vasprintf(ctdb, fmt, ap);
57         DEBUG(DEBUG_ERR,("ctdb error: %s\n", ctdb->err_msg));
58         va_end(ap);
59 }
60
61 /*
62   a fatal internal error occurred - no hope for recovery
63 */
64 void ctdb_fatal(struct ctdb_context *ctdb, const char *msg)
65 {
66         DEBUG(DEBUG_ALERT,("ctdb fatal error: %s\n", msg));
67         abort();
68 }
69
70 /*
71   like ctdb_fatal() but a core/backtrace would not be useful
72 */
73 void ctdb_die(struct ctdb_context *ctdb, const char *msg)
74 {
75         DEBUG(DEBUG_ALERT,("ctdb exiting with error: %s\n", msg));
76         exit(1);
77 }
78
79 /* Set the path of a helper program from envvar, falling back to
80  * dir/file if envvar unset. type is a string to print in log
81  * messages.  helper is assumed to point to a statically allocated
82  * array of size bytes, initialised to "".  If file is NULL don't fall
83  * back if envvar is unset.  If dir is NULL and envvar is unset (but
84  * file is not NULL) then this is an error.  Returns true if helper is
85  * set, either previously or this time. */
86 bool ctdb_set_helper(const char *type, char *helper, size_t size,
87                      const char *envvar,
88                      const char *dir, const char *file)
89 {
90         const char *t;
91         struct stat st;
92
93         if (helper[0] != '\0') {
94                 /* Already set */
95                 return true;
96         }
97
98         t = getenv(envvar);
99         if (t != NULL) {
100                 if (strlen(t) >= size) {
101                         DEBUG(DEBUG_ERR,
102                               ("Unable to set %s - path too long\n", type));
103                         return false;
104                 }
105
106                 strncpy(helper, t, size);
107         } else if (file == NULL) {
108                 return false;
109         } else if (dir == NULL) {
110                         DEBUG(DEBUG_ERR,
111                               ("Unable to set %s - dir is NULL\n", type));
112                 return false;
113         } else {
114                 if (snprintf(helper, size, "%s/%s", dir, file) >= size) {
115                         DEBUG(DEBUG_ERR,
116                               ("Unable to set %s - path too long\n", type));
117                         return false;
118                 }
119         }
120
121         if (stat(helper, &st) != 0) {
122                 DEBUG(DEBUG_ERR,
123                       ("Unable to set %s \"%s\" - %s\n",
124                        type, helper, strerror(errno)));
125                 return false;
126         }
127         if (!(st.st_mode & S_IXUSR)) {
128                 DEBUG(DEBUG_ERR,
129                       ("Unable to set %s \"%s\" - not executable\n",
130                        type, helper));
131                 return false;
132         }
133
134         DEBUG(DEBUG_NOTICE,
135               ("Set %s to \"%s\"\n", type, helper));
136         return true;
137 }
138
139 /* Invoke an external program to do some sort of tracing on the CTDB
140  * process.  This might block for a little while.  The external
141  * program is specified by the environment variable
142  * CTDB_EXTERNAL_TRACE.  This program should take one argument: the
143  * pid of the process to trace.  Commonly, the program would be a
144  * wrapper script around gcore.
145  */
146 void ctdb_external_trace(void)
147 {
148         int ret;
149         static char external_trace[PATH_MAX+1] = "";
150         char * cmd;
151
152         if (!ctdb_set_helper("external trace handler",
153                              external_trace, sizeof(external_trace),
154                              "CTDB_EXTERNAL_TRACE", NULL, NULL)) {
155                 return;
156         }
157
158         cmd = talloc_asprintf(NULL, "%s %lu", external_trace, (unsigned long) getpid());
159         DEBUG(DEBUG_WARNING,("begin external trace: %s\n", cmd));
160         ret = system(cmd);
161         if (ret == -1) {
162                 DEBUG(DEBUG_ERR,
163                       ("external trace command \"%s\" failed\n", cmd));
164         }
165         DEBUG(DEBUG_WARNING,("end external trace: %s\n", cmd));
166         talloc_free(cmd);
167 }
168
169 /*
170   parse a IP:port pair
171 */
172 int ctdb_parse_address(TALLOC_CTX *mem_ctx, const char *str,
173                        ctdb_sock_addr *address)
174 {
175         struct servent *se;
176         int port;
177         int ret;
178
179         setservent(0);
180         se = getservbyname("ctdb", "tcp");
181         endservent();
182
183         if (se == NULL) {
184                 port = CTDB_PORT;
185         } else {
186                 port = ntohs(se->s_port);
187         }
188
189         ret = ctdb_sock_addr_from_string(str, address, false);
190         if (ret != 0) {
191                 return -1;
192         }
193         ctdb_sock_addr_set_port(address, port);
194
195         return 0;
196 }
197
198
199 /*
200   check if two addresses are the same
201 */
202 bool ctdb_same_address(ctdb_sock_addr *a1, ctdb_sock_addr *a2)
203 {
204         return ctdb_same_ip(a1, a2) &&
205                 ctdb_addr_to_port(a1) == ctdb_addr_to_port(a2);
206 }
207
208
209 /*
210   hash function for mapping data to a VNN - taken from tdb
211 */
212 uint32_t ctdb_hash(const TDB_DATA *key)
213 {
214         return tdb_jenkins_hash(discard_const(key));
215 }
216
217
218 static uint32_t ctdb_marshall_record_size(TDB_DATA key,
219                                           struct ctdb_ltdb_header *header,
220                                           TDB_DATA data)
221 {
222         return offsetof(struct ctdb_rec_data_old, data) + key.dsize +
223                data.dsize + (header ? sizeof(*header) : 0);
224 }
225
226 static void ctdb_marshall_record_copy(struct ctdb_rec_data_old *rec,
227                                       uint32_t reqid,
228                                       TDB_DATA key,
229                                       struct ctdb_ltdb_header *header,
230                                       TDB_DATA data,
231                                       uint32_t length)
232 {
233         uint32_t offset;
234
235         rec->length = length;
236         rec->reqid = reqid;
237         rec->keylen = key.dsize;
238         memcpy(&rec->data[0], key.dptr, key.dsize);
239         offset = key.dsize;
240
241         if (header) {
242                 rec->datalen = data.dsize + sizeof(*header);
243                 memcpy(&rec->data[offset], header, sizeof(*header));
244                 offset += sizeof(*header);
245         } else {
246                 rec->datalen = data.dsize;
247         }
248         memcpy(&rec->data[offset], data.dptr, data.dsize);
249 }
250
251 /*
252   form a ctdb_rec_data record from a key/data pair
253   
254   note that header may be NULL. If not NULL then it is included in the data portion
255   of the record
256  */
257 struct ctdb_rec_data_old *ctdb_marshall_record(TALLOC_CTX *mem_ctx,
258                                                uint32_t reqid,
259                                                TDB_DATA key,
260                                                struct ctdb_ltdb_header *header,
261                                                TDB_DATA data)
262 {
263         size_t length;
264         struct ctdb_rec_data_old *d;
265
266         length = ctdb_marshall_record_size(key, header, data);
267
268         d = (struct ctdb_rec_data_old *)talloc_size(mem_ctx, length);
269         if (d == NULL) {
270                 return NULL;
271         }
272
273         ctdb_marshall_record_copy(d, reqid, key, header, data, length);
274         return d;
275 }
276
277
278 /* helper function for marshalling multiple records */
279 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
280                                                struct ctdb_marshall_buffer *m,
281                                                uint32_t db_id,
282                                                uint32_t reqid,
283                                                TDB_DATA key,
284                                                struct ctdb_ltdb_header *header,
285                                                TDB_DATA data)
286 {
287         struct ctdb_rec_data_old *r;
288         struct ctdb_marshall_buffer *m2;
289         uint32_t length, offset;
290
291         length = ctdb_marshall_record_size(key, header, data);
292
293         if (m == NULL) {
294                 offset = offsetof(struct ctdb_marshall_buffer, data);
295                 m2 = talloc_zero_size(mem_ctx, offset + length);
296         } else {
297                 offset = talloc_get_size(m);
298                 m2 = talloc_realloc_size(mem_ctx, m, offset + length);
299         }
300         if (m2 == NULL) {
301                 TALLOC_FREE(m);
302                 return NULL;
303         }
304
305         if (m == NULL) {
306                 m2->db_id = db_id;
307         }
308
309         r = (struct ctdb_rec_data_old *)((uint8_t *)m2 + offset);
310         ctdb_marshall_record_copy(r, reqid, key, header, data, length);
311         m2->count++;
312
313         return m2;
314 }
315
316 /* we've finished marshalling, return a data blob with the marshalled records */
317 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m)
318 {
319         TDB_DATA data;
320         data.dptr = (uint8_t *)m;
321         data.dsize = talloc_get_size(m);
322         return data;
323 }
324
325 /* 
326    loop over a marshalling buffer 
327    
328      - pass r==NULL to start
329      - loop the number of times indicated by m->count
330 */
331 struct ctdb_rec_data_old *ctdb_marshall_loop_next(
332                                 struct ctdb_marshall_buffer *m,
333                                 struct ctdb_rec_data_old *r,
334                                 uint32_t *reqid,
335                                 struct ctdb_ltdb_header *header,
336                                 TDB_DATA *key, TDB_DATA *data)
337 {
338         if (r == NULL) {
339                 r = (struct ctdb_rec_data_old *)&m->data[0];
340         } else {
341                 r = (struct ctdb_rec_data_old *)(r->length + (uint8_t *)r);
342         }
343
344         if (reqid != NULL) {
345                 *reqid = r->reqid;
346         }
347         
348         if (key != NULL) {
349                 key->dptr   = &r->data[0];
350                 key->dsize  = r->keylen;
351         }
352         if (data != NULL) {
353                 data->dptr  = &r->data[r->keylen];
354                 data->dsize = r->datalen;
355                 if (header != NULL) {
356                         data->dptr += sizeof(*header);
357                         data->dsize -= sizeof(*header);
358                 }
359         }
360
361         if (header != NULL) {
362                 if (r->datalen < sizeof(*header)) {
363                         return NULL;
364                 }
365                 memcpy(header, &r->data[r->keylen], sizeof(*header));
366         }
367
368         return r;
369 }
370
371 /*
372    This is used to canonicalize a ctdb_sock_addr structure.
373 */
374 void ctdb_canonicalize_ip(const ctdb_sock_addr *ip, ctdb_sock_addr *cip)
375 {
376         char prefix[12] = { 0,0,0,0,0,0,0,0,0,0,0xff,0xff };
377
378         memcpy(cip, ip, sizeof (*cip));
379
380         if ( (ip->sa.sa_family == AF_INET6)
381         && !memcmp(&ip->ip6.sin6_addr, prefix, 12)) {
382                 memset(cip, 0, sizeof(*cip));
383 #ifdef HAVE_SOCK_SIN_LEN
384                 cip->ip.sin_len = sizeof(*cip);
385 #endif
386                 cip->ip.sin_family = AF_INET;
387                 cip->ip.sin_port   = ip->ip6.sin6_port;
388                 memcpy(&cip->ip.sin_addr, &ip->ip6.sin6_addr.s6_addr[12], 4);
389         }
390 }
391
392 bool ctdb_same_ip(const ctdb_sock_addr *tip1, const ctdb_sock_addr *tip2)
393 {
394         ctdb_sock_addr ip1, ip2;
395
396         ctdb_canonicalize_ip(tip1, &ip1);
397         ctdb_canonicalize_ip(tip2, &ip2);
398         
399         if (ip1.sa.sa_family != ip2.sa.sa_family) {
400                 return false;
401         }
402
403         switch (ip1.sa.sa_family) {
404         case AF_INET:
405                 return ip1.ip.sin_addr.s_addr == ip2.ip.sin_addr.s_addr;
406         case AF_INET6:
407                 return !memcmp(&ip1.ip6.sin6_addr.s6_addr[0],
408                                 &ip2.ip6.sin6_addr.s6_addr[0],
409                                 16);
410         default:
411                 DEBUG(DEBUG_ERR, (__location__ " CRITICAL Can not compare sockaddr structures of type %u\n", ip1.sa.sa_family));
412                 return false;
413         }
414
415         return true;
416 }
417
418 /*
419   compare two ctdb_sock_addr structures
420  */
421 bool ctdb_same_sockaddr(const ctdb_sock_addr *ip1, const ctdb_sock_addr *ip2)
422 {
423         return ctdb_same_ip(ip1, ip2) && ip1->ip.sin_port == ip2->ip.sin_port;
424 }
425
426 char *ctdb_addr_to_str(ctdb_sock_addr *addr)
427 {
428         static char cip[128] = "";
429
430         switch (addr->sa.sa_family) {
431         case AF_INET:
432                 inet_ntop(addr->ip.sin_family, &addr->ip.sin_addr, cip, sizeof(cip));
433                 break;
434         case AF_INET6:
435                 inet_ntop(addr->ip6.sin6_family, &addr->ip6.sin6_addr, cip, sizeof(cip));
436                 break;
437         default:
438                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
439                 ctdb_external_trace();
440         }
441
442         return cip;
443 }
444
445 unsigned ctdb_addr_to_port(ctdb_sock_addr *addr)
446 {
447         switch (addr->sa.sa_family) {
448         case AF_INET:
449                 return ntohs(addr->ip.sin_port);
450                 break;
451         case AF_INET6:
452                 return ntohs(addr->ip6.sin6_port);
453                 break;
454         default:
455                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
456         }
457
458         return 0;
459 }
460
461 /* Add a node to a node map with given address and flags */
462 static bool node_map_add(TALLOC_CTX *mem_ctx,
463                          const char *nstr, uint32_t flags,
464                          struct ctdb_node_map_old **node_map)
465 {
466         ctdb_sock_addr addr;
467         uint32_t num;
468         size_t s;
469         struct ctdb_node_and_flags *n;
470
471         /* Might as well do this before trying to allocate memory */
472         if (ctdb_parse_address(mem_ctx, nstr, &addr) == -1) {
473                 return false;
474         }
475
476         num = (*node_map)->num + 1;
477         s = offsetof(struct ctdb_node_map_old, nodes) +
478                 num * sizeof(struct ctdb_node_and_flags);
479         *node_map = talloc_realloc_size(mem_ctx, *node_map, s);
480         if (*node_map == NULL) {
481                 DEBUG(DEBUG_ERR, (__location__ " Out of memory\n"));
482                 return false;
483         }
484
485         n = &(*node_map)->nodes[(*node_map)->num];
486         n->addr = addr;
487         n->pnn = (*node_map)->num;
488         n->flags = flags;
489
490         (*node_map)->num++;
491
492         return true;
493 }
494
495 /* Read a nodes file into a node map */
496 struct ctdb_node_map_old *ctdb_read_nodes_file(TALLOC_CTX *mem_ctx,
497                                            const char *nlist)
498 {
499         char **lines;
500         int nlines;
501         int i;
502         struct ctdb_node_map_old *ret;
503
504         /* Allocate node map header */
505         ret = talloc_zero_size(mem_ctx, offsetof(struct ctdb_node_map_old, nodes));
506         if (ret == NULL) {
507                 DEBUG(DEBUG_ERR, (__location__ " Out of memory\n"));
508                 return false;
509         }
510
511         lines = file_lines_load(nlist, &nlines, 0, mem_ctx);
512         if (lines == NULL) {
513                 DEBUG(DEBUG_ERR, ("Failed to read nodes file \"%s\"\n", nlist));
514                 return false;
515         }
516         while (nlines > 0 && strcmp(lines[nlines-1], "") == 0) {
517                 nlines--;
518         }
519
520         for (i=0; i < nlines; i++) {
521                 char *node;
522                 uint32_t flags;
523                 size_t len;
524
525                 node = lines[i];
526                 /* strip leading spaces */
527                 while((*node == ' ') || (*node == '\t')) {
528                         node++;
529                 }
530
531                 len = strlen(node);
532
533                 while ((len > 1) &&
534                        ((node[len-1] == ' ') || (node[len-1] == '\t')))
535                 {
536                         node[len-1] = '\0';
537                         len--;
538                 }
539
540                 if (len == 0) {
541                         continue;
542                 }
543                 if (*node == '#') {
544                         /* A "deleted" node is a node that is
545                            commented out in the nodes file.  This is
546                            used instead of removing a line, which
547                            would cause subsequent nodes to change
548                            their PNN. */
549                         flags = NODE_FLAGS_DELETED;
550                         node = discard_const("0.0.0.0");
551                 } else {
552                         flags = 0;
553                 }
554                 if (!node_map_add(mem_ctx, node, flags, &ret)) {
555                         talloc_free(lines);
556                         TALLOC_FREE(ret);
557                         return NULL;
558                 }
559         }
560
561         talloc_free(lines);
562         return ret;
563 }
564
565 struct ctdb_node_map_old *
566 ctdb_node_list_to_map(struct ctdb_node **nodes, uint32_t num_nodes,
567                       TALLOC_CTX *mem_ctx)
568 {
569         uint32_t i;
570         size_t size;
571         struct ctdb_node_map_old *node_map;
572
573         size = offsetof(struct ctdb_node_map_old, nodes) +
574                 num_nodes * sizeof(struct ctdb_node_and_flags);
575         node_map  = (struct ctdb_node_map_old *)talloc_zero_size(mem_ctx, size);
576         if (node_map == NULL) {
577                 DEBUG(DEBUG_ERR,
578                       (__location__ " Failed to allocate nodemap array\n"));
579                 return NULL;
580         }
581
582         node_map->num = num_nodes;
583         for (i=0; i<num_nodes; i++) {
584                 node_map->nodes[i].addr  = nodes[i]->address;
585                 node_map->nodes[i].pnn   = nodes[i]->pnn;
586                 node_map->nodes[i].flags = nodes[i]->flags;
587         }
588
589         return node_map;
590 }
591
592 const char *ctdb_eventscript_call_names[] = {
593         "init",
594         "setup",
595         "startup",
596         "startrecovery",
597         "recovered",
598         "takeip",
599         "releaseip",
600         "stopped",
601         "monitor",
602         "status",
603         "shutdown",
604         "reload",
605         "updateip",
606         "ipreallocated"
607 };
608
609 /* Runstate handling */
610 static struct {
611         enum ctdb_runstate runstate;
612         const char * label;
613 } runstate_map[] = {
614         { CTDB_RUNSTATE_UNKNOWN, "UNKNOWN" },
615         { CTDB_RUNSTATE_INIT, "INIT" },
616         { CTDB_RUNSTATE_SETUP, "SETUP" },
617         { CTDB_RUNSTATE_FIRST_RECOVERY, "FIRST_RECOVERY" },
618         { CTDB_RUNSTATE_STARTUP, "STARTUP" },
619         { CTDB_RUNSTATE_RUNNING, "RUNNING" },
620         { CTDB_RUNSTATE_SHUTDOWN, "SHUTDOWN" },
621         { -1, NULL },
622 };
623
624 const char *runstate_to_string(enum ctdb_runstate runstate)
625 {
626         int i;
627         for (i=0; runstate_map[i].label != NULL ; i++) {
628                 if (runstate_map[i].runstate == runstate) {
629                         return runstate_map[i].label;
630                 }
631         }
632
633         return runstate_map[0].label;
634 }
635
636 enum ctdb_runstate runstate_from_string(const char *label)
637 {
638         int i;
639         for (i=0; runstate_map[i].label != NULL; i++) {
640                 if (strcasecmp(runstate_map[i].label, label) == 0) {
641                         return runstate_map[i].runstate;
642                 }
643         }
644
645         return CTDB_RUNSTATE_UNKNOWN;
646 }
647
648 void ctdb_set_runstate(struct ctdb_context *ctdb, enum ctdb_runstate runstate)
649 {
650         DEBUG(DEBUG_NOTICE,("Set runstate to %s (%d)\n",
651                             runstate_to_string(runstate), runstate));
652
653         if (runstate <= ctdb->runstate) {
654                 ctdb_fatal(ctdb, "runstate must always increase");
655         }
656
657         ctdb->runstate = runstate;
658 }
659
660 /* Convert arbitrary data to 4-byte boundary padded uint32 array */
661 uint32_t *ctdb_key_to_idkey(TALLOC_CTX *mem_ctx, TDB_DATA key)
662 {
663         uint32_t idkey_size, *k;
664
665         idkey_size = 1 + (key.dsize + sizeof(uint32_t)-1) / sizeof(uint32_t);
666
667         k = talloc_zero_array(mem_ctx, uint32_t, idkey_size);
668         if (k == NULL) {
669                 return NULL;
670         }
671
672         k[0] = idkey_size;
673         memcpy(&k[1], key.dptr, key.dsize);
674
675         return k;
676 }