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 "includes.h"
  21 #include "tdb.h"
  22 #include "system/network.h"
  23 #include "system/filesys.h"
  24 #include "system/wait.h"
  25 #include "../include/ctdb_private.h"
  26
  27 /*
  28   return error string for last error
  29 */
  30 const char *ctdb_errstr(struct ctdb_context *ctdb)
  31 {
  32         return ctdb->err_msg;
  33 }
  34
  35
  36 /*
  37   remember an error message
  38 */
  39 void ctdb_set_error(struct ctdb_context *ctdb, const char *fmt, ...)
  40 {
  41         va_list ap;
  42         talloc_free(ctdb->err_msg);
  43         va_start(ap, fmt);
  44         ctdb->err_msg = talloc_vasprintf(ctdb, fmt, ap);
  45         DEBUG(DEBUG_ERR,("ctdb error: %s\n", ctdb->err_msg));
  46         va_end(ap);
  47 }
  48
  49 /*
  50   a fatal internal error occurred - no hope for recovery
  51 */
  52 void ctdb_fatal(struct ctdb_context *ctdb, const char *msg)
  53 {
  54         DEBUG(DEBUG_ALERT,("ctdb fatal error: %s\n", msg));
  55         abort();
  56 }
  57
  58 /*
  59   like ctdb_fatal() but a core/backtrace would not be useful
  60 */
  61 void ctdb_die(struct ctdb_context *ctdb, const char *msg)
  62 {
  63         DEBUG(DEBUG_ALERT,("ctdb exiting with error: %s\n", msg));
  64         exit(1);
  65 }
  66
  67 /* Invoke an external program to do some sort of tracing on the CTDB
  68  * process.  This might block for a little while.  The external
  69  * program is specified by the environment variable
  70  * CTDB_EXTERNAL_TRACE.  This program should take one argument: the
  71  * pid of the process to trace.  Commonly, the program would be a
  72  * wrapper script around gcore.
  73  */
  74 void ctdb_external_trace(void)
  75 {
  76
  77         const char * t = getenv("CTDB_EXTERNAL_TRACE");
  78         char * cmd;
  79
  80         if (t == NULL) {
  81                 return;
  82         }
  83
  84         cmd = talloc_asprintf(NULL, "%s %lu", t, (unsigned long) getpid());
  85         DEBUG(DEBUG_WARNING,("begin external trace: %s\n", cmd));
  86         system(cmd);
  87         DEBUG(DEBUG_WARNING,("end external trace: %s\n", cmd));
  88         talloc_free(cmd);
  89 }
  90
  91 /*
  92   parse a IP:port pair
  93 */
  94 int ctdb_parse_address(struct ctdb_context *ctdb,
  95                        TALLOC_CTX *mem_ctx, const char *str,
  96                        struct ctdb_address *address)
  97 {
  98         struct servent *se;
  99
 100         setservent(0);
 101         se = getservbyname("ctdb", "tcp");
 102         endservent();
 103
 104         address->address = talloc_strdup(mem_ctx, str);
 105         CTDB_NO_MEMORY(ctdb, address->address);
 106
 107         if (se == NULL) {
 108                 address->port = CTDB_PORT;
 109         } else {
 110                 address->port = ntohs(se->s_port);
 111         }
 112         return 0;
 113 }
 114
 115
 116 /*
 117   check if two addresses are the same
 118 */
 119 bool ctdb_same_address(struct ctdb_address *a1, struct ctdb_address *a2)
 120 {
 121         return strcmp(a1->address, a2->address) == 0 && a1->port == a2->port;
 122 }
 123
 124
 125 /*
 126   hash function for mapping data to a VNN - taken from tdb
 127 */
 128 uint32_t ctdb_hash(const TDB_DATA *key)
 129 {
 130         return tdb_jenkins_hash(discard_const(key));
 131 }
 132
 133 /*
 134   a type checking varient of idr_find
 135  */
 136 static void *_idr_find_type(struct idr_context *idp, int id, const char *type, const char *location)
 137 {
 138         void *p = idr_find(idp, id);
 139         if (p && talloc_check_name(p, type) == NULL) {
 140                 DEBUG(DEBUG_ERR,("%s idr_find_type expected type %s  but got %s\n",
 141                          location, type, talloc_get_name(p)));
 142                 return NULL;
 143         }
 144         return p;
 145 }
 146
 147 uint32_t ctdb_reqid_new(struct ctdb_context *ctdb, void *state)
 148 {
 149         int id = idr_get_new_above(ctdb->idr, state, ctdb->lastid+1, INT_MAX);
 150         if (id < 0) {
 151                 DEBUG(DEBUG_DEBUG, ("Reqid wrap!\n"));
 152                 id = idr_get_new(ctdb->idr, state, INT_MAX);
 153         }
 154         ctdb->lastid = id;
 155         return id;
 156 }
 157
 158 void *_ctdb_reqid_find(struct ctdb_context *ctdb, uint32_t reqid, const char *type, const char *location)
 159 {
 160         void *p;
 161
 162         p = _idr_find_type(ctdb->idr, reqid, type, location);
 163         if (p == NULL) {
 164                 DEBUG(DEBUG_WARNING, ("Could not find idr:%u\n",reqid));
 165         }
 166
 167         return p;
 168 }
 169
 170
 171 void ctdb_reqid_remove(struct ctdb_context *ctdb, uint32_t reqid)
 172 {
 173         int ret;
 174
 175         ret = idr_remove(ctdb->idr, reqid);
 176         if (ret != 0) {
 177                 DEBUG(DEBUG_ERR, ("Removing idr that does not exist\n"));
 178         }
 179 }
 180
 181
 182 /*
 183   form a ctdb_rec_data record from a key/data pair
 184
 185   note that header may be NULL. If not NULL then it is included in the data portion
 186   of the record
 187  */
 188 struct ctdb_rec_data *ctdb_marshall_record(TALLOC_CTX *mem_ctx, uint32_t reqid,
 189                                            TDB_DATA key,
 190                                            struct ctdb_ltdb_header *header,
 191                                            TDB_DATA data)
 192 {
 193         size_t length;
 194         struct ctdb_rec_data *d;
 195
 196         length = offsetof(struct ctdb_rec_data, data) + key.dsize +
 197                 data.dsize + (header?sizeof(*header):0);
 198         d = (struct ctdb_rec_data *)talloc_size(mem_ctx, length);
 199         if (d == NULL) {
 200                 return NULL;
 201         }
 202         d->length = length;
 203         d->reqid = reqid;
 204         d->keylen = key.dsize;
 205         memcpy(&d->data[0], key.dptr, key.dsize);
 206         if (header) {
 207                 d->datalen = data.dsize + sizeof(*header);
 208                 memcpy(&d->data[key.dsize], header, sizeof(*header));
 209                 memcpy(&d->data[key.dsize+sizeof(*header)], data.dptr, data.dsize);
 210         } else {
 211                 d->datalen = data.dsize;
 212                 memcpy(&d->data[key.dsize], data.dptr, data.dsize);
 213         }
 214         return d;
 215 }
 216
 217
 218 /* helper function for marshalling multiple records */
 219 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
 220                                                struct ctdb_marshall_buffer *m,
 221                                                uint64_t db_id,
 222                                                uint32_t reqid,
 223                                                TDB_DATA key,
 224                                                struct ctdb_ltdb_header *header,
 225                                                TDB_DATA data)
 226 {
 227         struct ctdb_rec_data *r;
 228         size_t m_size, r_size;
 229         struct ctdb_marshall_buffer *m2;
 230
 231         r = ctdb_marshall_record(mem_ctx, reqid, key, header, data);
 232         if (r == NULL) {
 233                 talloc_free(m);
 234                 return NULL;
 235         }
 236
 237         if (m == NULL) {
 238                 m = talloc_zero_size(mem_ctx, offsetof(struct ctdb_marshall_buffer, data));
 239                 if (m == NULL) {
 240                         return NULL;
 241                 }
 242                 m->db_id = db_id;
 243         }
 244
 245         m_size = talloc_get_size(m);
 246         r_size = talloc_get_size(r);
 247
 248         m2 = talloc_realloc_size(mem_ctx, m,  m_size + r_size);
 249         if (m2 == NULL) {
 250                 talloc_free(m);
 251                 return NULL;
 252         }
 253
 254         memcpy(m_size + (uint8_t *)m2, r, r_size);
 255
 256         talloc_free(r);
 257
 258         m2->count++;
 259
 260         return m2;
 261 }
 262
 263 /* we've finished marshalling, return a data blob with the marshalled records */
 264 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m)
 265 {
 266         TDB_DATA data;
 267         data.dptr = (uint8_t *)m;
 268         data.dsize = talloc_get_size(m);
 269         return data;
 270 }
 271
 272 /*
 273    loop over a marshalling buffer
 274
 275      - pass r==NULL to start
 276      - loop the number of times indicated by m->count
 277 */
 278 struct ctdb_rec_data *ctdb_marshall_loop_next(struct ctdb_marshall_buffer *m, struct ctdb_rec_data *r,
 279                                               uint32_t *reqid,
 280                                               struct ctdb_ltdb_header *header,
 281                                               TDB_DATA *key, TDB_DATA *data)
 282 {
 283         if (r == NULL) {
 284                 r = (struct ctdb_rec_data *)&m->data[0];
 285         } else {
 286                 r = (struct ctdb_rec_data *)(r->length + (uint8_t *)r);
 287         }
 288
 289         if (reqid != NULL) {
 290                 *reqid = r->reqid;
 291         }
 292
 293         if (key != NULL) {
 294                 key->dptr   = &r->data[0];
 295                 key->dsize  = r->keylen;
 296         }
 297         if (data != NULL) {
 298                 data->dptr  = &r->data[r->keylen];
 299                 data->dsize = r->datalen;
 300                 if (header != NULL) {
 301                         data->dptr += sizeof(*header);
 302                         data->dsize -= sizeof(*header);
 303                 }
 304         }
 305
 306         if (header != NULL) {
 307                 if (r->datalen < sizeof(*header)) {
 308                         return NULL;
 309                 }
 310                 *header = *(struct ctdb_ltdb_header *)&r->data[r->keylen];
 311         }
 312
 313         return r;
 314 }
 315
 316 /*
 317    This is used to canonicalize a ctdb_sock_addr structure.
 318 */
 319 void ctdb_canonicalize_ip(const ctdb_sock_addr *ip, ctdb_sock_addr *cip)
 320 {
 321         char prefix[12] = { 0,0,0,0,0,0,0,0,0,0,0xff,0xff };
 322
 323         memcpy(cip, ip, sizeof (*cip));
 324
 325         if ( (ip->sa.sa_family == AF_INET6)
 326         && !memcmp(&ip->ip6.sin6_addr, prefix, 12)) {
 327                 memset(cip, 0, sizeof(*cip));
 328 #ifdef HAVE_SOCK_SIN_LEN
 329                 cip->ip.sin_len = sizeof(*cip);
 330 #endif
 331                 cip->ip.sin_family = AF_INET;
 332                 cip->ip.sin_port   = ip->ip6.sin6_port;
 333                 memcpy(&cip->ip.sin_addr, &ip->ip6.sin6_addr.s6_addr[12], 4);
 334         }
 335 }
 336
 337 bool ctdb_same_ip(const ctdb_sock_addr *tip1, const ctdb_sock_addr *tip2)
 338 {
 339         ctdb_sock_addr ip1, ip2;
 340
 341         ctdb_canonicalize_ip(tip1, &ip1);
 342         ctdb_canonicalize_ip(tip2, &ip2);
 343
 344         if (ip1.sa.sa_family != ip2.sa.sa_family) {
 345                 return false;
 346         }
 347
 348         switch (ip1.sa.sa_family) {
 349         case AF_INET:
 350                 return ip1.ip.sin_addr.s_addr == ip2.ip.sin_addr.s_addr;
 351         case AF_INET6:
 352                 return !memcmp(&ip1.ip6.sin6_addr.s6_addr[0],
 353                                 &ip2.ip6.sin6_addr.s6_addr[0],
 354                                 16);
 355         default:
 356                 DEBUG(DEBUG_ERR, (__location__ " CRITICAL Can not compare sockaddr structures of type %u\n", ip1.sa.sa_family));
 357                 return false;
 358         }
 359
 360         return true;
 361 }
 362
 363 /*
 364   compare two ctdb_sock_addr structures
 365  */
 366 bool ctdb_same_sockaddr(const ctdb_sock_addr *ip1, const ctdb_sock_addr *ip2)
 367 {
 368         return ctdb_same_ip(ip1, ip2) && ip1->ip.sin_port == ip2->ip.sin_port;
 369 }
 370
 371 char *ctdb_addr_to_str(ctdb_sock_addr *addr)
 372 {
 373         static char cip[128] = "";
 374
 375         switch (addr->sa.sa_family) {
 376         case AF_INET:
 377                 inet_ntop(addr->ip.sin_family, &addr->ip.sin_addr, cip, sizeof(cip));
 378                 break;
 379         case AF_INET6:
 380                 inet_ntop(addr->ip6.sin6_family, &addr->ip6.sin6_addr, cip, sizeof(cip));
 381                 break;
 382         default:
 383                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 384                 ctdb_external_trace();
 385         }
 386
 387         return cip;
 388 }
 389
 390 unsigned ctdb_addr_to_port(ctdb_sock_addr *addr)
 391 {
 392         switch (addr->sa.sa_family) {
 393         case AF_INET:
 394                 return ntohs(addr->ip.sin_port);
 395                 break;
 396         case AF_INET6:
 397                 return ntohs(addr->ip6.sin6_port);
 398                 break;
 399         default:
 400                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 401         }
 402
 403         return 0;
 404 }
 405
 406
 407 const char *ctdb_eventscript_call_names[] = {
 408         "init",
 409         "setup",
 410         "startup",
 411         "startrecovery",
 412         "recovered",
 413         "takeip",
 414         "releaseip",
 415         "stopped",
 416         "monitor",
 417         "status",
 418         "shutdown",
 419         "reload",
 420         "updateip",
 421         "ipreallocated"
 422 };
 423
 424 /* Runstate handling */
 425 static struct {
 426         enum ctdb_runstate runstate;
 427         const char * label;
 428 } runstate_map[] = {
 429         { CTDB_RUNSTATE_UNKNOWN, "UNKNOWN" },
 430         { CTDB_RUNSTATE_INIT, "INIT" },
 431         { CTDB_RUNSTATE_SETUP, "SETUP" },
 432         { CTDB_RUNSTATE_FIRST_RECOVERY, "FIRST_RECOVERY" },
 433         { CTDB_RUNSTATE_STARTUP, "STARTUP" },
 434         { CTDB_RUNSTATE_RUNNING, "RUNNING" },
 435         { CTDB_RUNSTATE_SHUTDOWN, "SHUTDOWN" },
 436         { -1, NULL },
 437 };
 438
 439 const char *runstate_to_string(enum ctdb_runstate runstate)
 440 {
 441         int i;
 442         for (i=0; runstate_map[i].label != NULL ; i++) {
 443                 if (runstate_map[i].runstate == runstate) {
 444                         return runstate_map[i].label;
 445                 }
 446         }
 447
 448         return runstate_map[0].label;
 449 }
 450
 451 enum ctdb_runstate runstate_from_string(const char *label)
 452 {
 453         int i;
 454         for (i=0; runstate_map[i].label != NULL; i++) {
 455                 if (strcasecmp(runstate_map[i].label, label) == 0) {
 456                         return runstate_map[i].runstate;
 457                 }
 458         }
 459
 460         return CTDB_RUNSTATE_UNKNOWN;
 461 }
 462
 463 void ctdb_set_runstate(struct ctdb_context *ctdb, enum ctdb_runstate runstate)
 464 {
 465         if (runstate <= ctdb->runstate) {
 466                 ctdb_fatal(ctdb, "runstate must always increase");
 467         }
 468
 469         DEBUG(DEBUG_NOTICE,("Set runstate to %s (%d)\n",
 470                             runstate_to_string(runstate), runstate));
 471         ctdb->runstate = runstate;
 472 }
 473
 474 void ctdb_mkdir_p_or_die(struct ctdb_context *ctdb, const char *dir, int mode)
 475 {
 476         int ret;
 477
 478         ret = mkdir_p(dir, mode);
 479         if (ret != 0) {
 480                 DEBUG(DEBUG_ALERT,
 481                       ("ctdb exiting with error: "
 482                        "failed to create directory \"%s\" (%s)\n",
 483                        dir, strerror(errno)));
 484                 exit(1);
 485         }
 486 }