server/ctdb_logging.c

   1 /*
   2    ctdb logging code
   3
   4    Copyright (C) Andrew Tridgell  2008
   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 "lib/events/events.h"
  22 #include "../include/ctdb.h"
  23 #include "../include/ctdb_private.h"
  24 #include "system/syslog.h"
  25 #include "system/time.h"
  26 #include "system/filesys.h"
  27
  28 struct syslog_message {
  29         uint32_t level;
  30         uint32_t len;
  31         char message[1];
  32 };
  33
  34
  35 struct ctdb_syslog_state {
  36         int syslog_fd;
  37         int fd[2];
  38 };
  39
  40 static int syslogd_is_started = 0;
  41
  42
  43 /* called when child is finished
  44  * this is for the syslog daemon, we can not use DEBUG here
  45  */
  46 static void ctdb_syslog_handler(struct event_context *ev, struct fd_event *fde,
  47                                       uint16_t flags, void *p)
  48 {
  49         struct ctdb_syslog_state *state = talloc_get_type(p, struct ctdb_syslog_state);
  50
  51         int count;
  52         char str[65536];
  53         struct syslog_message *msg;
  54
  55         if (state == NULL) {
  56                 return;
  57         }
  58
  59         count = recv(state->syslog_fd, str, sizeof(str), 0);
  60         if (count < sizeof(struct syslog_message)) {
  61                 return;
  62         }
  63         msg = (struct syslog_message *)str;
  64
  65         syslog(msg->level, "%s", msg->message);
  66 }
  67
  68
  69 /* called when the pipd from the main daemon has closed
  70  * this is for the syslog daemon, we can not use DEBUG here
  71  */
  72 static void ctdb_syslog_terminate_handler(struct event_context *ev, struct fd_event *fde,
  73                                       uint16_t flags, void *p)
  74 {
  75         syslog(LOG_ERR, "Shutting down SYSLOG daemon with pid:%d", (int)getpid());
  76         _exit(0);
  77 }
  78
  79
  80
  81 /*
  82  * this is for the syslog daemon, we can not use DEBUG here
  83  */
  84 int start_syslog_daemon(struct ctdb_context *ctdb)
  85 {
  86         struct sockaddr_in syslog_sin;
  87         struct ctdb_syslog_state *state;
  88
  89         state = talloc(ctdb, struct ctdb_syslog_state);
  90         CTDB_NO_MEMORY(ctdb, state);
  91
  92         if (pipe(state->fd) != 0) {
  93                 printf("Failed to create syslog pipe\n");
  94                 talloc_free(state);
  95                 return -1;
  96         }
  97
  98         ctdb->syslogd_pid = fork();
  99         if (ctdb->syslogd_pid == (pid_t)-1) {
 100                 printf("Failed to create syslog child process\n");
 101                 close(state->fd[0]);
 102                 close(state->fd[1]);
 103                 talloc_free(state);
 104                 return -1;
 105         }
 106
 107         syslogd_is_started = 1;
 108
 109         if (ctdb->syslogd_pid != 0) {
 110                 DEBUG(DEBUG_ERR,("Starting SYSLOG child process with pid:%d\n", (int)ctdb->syslogd_pid));
 111
 112                 close(state->fd[1]);
 113                 set_close_on_exec(state->fd[0]);
 114
 115                 return 0;
 116         }
 117
 118         debug_extra = talloc_asprintf(NULL, "syslogd:");
 119         talloc_free(ctdb->ev);
 120         ctdb->ev = event_context_init(NULL);
 121
 122         syslog(LOG_ERR, "Starting SYSLOG daemon with pid:%d", (int)getpid());
 123
 124         close(state->fd[0]);
 125         set_close_on_exec(state->fd[1]);
 126         event_add_fd(ctdb->ev, state, state->fd[1], EVENT_FD_READ|EVENT_FD_AUTOCLOSE,
 127                      ctdb_syslog_terminate_handler, state);
 128
 129         state->syslog_fd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
 130         if (state->syslog_fd == -1) {
 131                 printf("Failed to create syslog socket\n");
 132                 return -1;
 133         }
 134
 135         set_close_on_exec(state->syslog_fd);
 136
 137         syslog_sin.sin_family = AF_INET;
 138         syslog_sin.sin_port   = htons(CTDB_PORT);
 139         syslog_sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 140
 141         if (bind(state->syslog_fd, &syslog_sin, sizeof(syslog_sin)) == -1) {
 142                 if (errno == EADDRINUSE) {
 143                         /* this is ok, we already have a syslog daemon */
 144                         _exit(0);
 145                 }
 146                 printf("syslog daemon failed to bind to socket. errno:%d(%s)\n", errno, strerror(errno));
 147                 _exit(10);
 148         }
 149
 150
 151         event_add_fd(ctdb->ev, state, state->syslog_fd, EVENT_FD_READ|EVENT_FD_AUTOCLOSE,
 152                      ctdb_syslog_handler, state);
 153
 154         event_loop_wait(ctdb->ev);
 155
 156         /* this should not happen */
 157         _exit(10);
 158 }
 159
 160 struct ctdb_log_state {
 161         struct ctdb_context *ctdb;
 162         int fd, pfd;
 163         char buf[1024];
 164         uint16_t buf_used;
 165         bool use_syslog;
 166         void (*logfn)(const char *, uint16_t, void *);
 167         void *logfn_private;
 168 };
 169
 170 /* we need this global to keep the DEBUG() syntax */
 171 static struct ctdb_log_state *log_state;
 172
 173 /*
 174   syslog logging function
 175  */
 176 static void ctdb_syslog_log(const char *format, va_list ap)
 177 {
 178         struct syslog_message *msg;
 179         int level = LOG_DEBUG;
 180         char *s = NULL;
 181         int len, ret;
 182         int syslog_fd;
 183         struct sockaddr_in syslog_sin;
 184
 185         ret = vasprintf(&s, format, ap);
 186         if (ret == -1) {
 187                 return;
 188         }
 189
 190         switch (this_log_level) {
 191         case DEBUG_EMERG:
 192                 level = LOG_EMERG;
 193                 break;
 194         case DEBUG_ALERT:
 195                 level = LOG_ALERT;
 196                 break;
 197         case DEBUG_CRIT:
 198                 level = LOG_CRIT;
 199                 break;
 200         case DEBUG_ERR:
 201                 level = LOG_ERR;
 202                 break;
 203         case DEBUG_WARNING:
 204                 level = LOG_WARNING;
 205                 break;
 206         case DEBUG_NOTICE:
 207                 level = LOG_NOTICE;
 208                 break;
 209         case DEBUG_INFO:
 210                 level = LOG_INFO;
 211                 break;
 212         default:
 213                 level = LOG_DEBUG;
 214                 break;
 215         }
 216
 217         len = offsetof(struct syslog_message, message) + strlen(debug_extra) + strlen(s) + 1;
 218         msg = malloc(len);
 219         if (msg == NULL) {
 220                 free(s);
 221                 return;
 222         }
 223         msg->level = level;
 224         msg->len   = strlen(debug_extra) + strlen(s);
 225         strcpy(msg->message, debug_extra);
 226         strcat(msg->message, s);
 227
 228         if (syslogd_is_started == 0) {
 229                 syslog(msg->level, "%s", msg->message);
 230         } else {
 231                 syslog_fd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
 232                 if (syslog_fd == -1) {
 233                         printf("Failed to create syslog socket\n");
 234                         free(s);
 235                         free(msg);
 236                         return;
 237                 }
 238
 239                 syslog_sin.sin_family = AF_INET;
 240                 syslog_sin.sin_port   = htons(CTDB_PORT);
 241                 syslog_sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 242
 243
 244                 ret = sendto(syslog_fd, msg, len, 0, &syslog_sin, sizeof(syslog_sin));
 245                 /* no point in checking here since we cant log an error */
 246
 247                 close(syslog_fd);
 248         }
 249
 250         free(s);
 251         free(msg);
 252 }
 253
 254
 255 /*
 256   log file logging function
 257  */
 258 static void ctdb_logfile_log(const char *format, va_list ap)
 259 {
 260         struct timeval t;
 261         char *s = NULL;
 262         struct tm *tm;
 263         char tbuf[100];
 264         char *s2 = NULL;
 265         int ret;
 266
 267         ret = vasprintf(&s, format, ap);
 268         if (ret == -1) {
 269                 const char *errstr = "vasprintf failed\n";
 270
 271                 write(log_state->fd, errstr, strlen(errstr));
 272                 return;
 273         }
 274
 275         t = timeval_current();
 276         tm = localtime(&t.tv_sec);
 277
 278         strftime(tbuf,sizeof(tbuf)-1,"%Y/%m/%d %H:%M:%S", tm);
 279
 280         ret = asprintf(&s2, "%s.%06u [%s%5u]: %s",
 281                        tbuf, (unsigned)t.tv_usec,
 282                        debug_extra, (unsigned)getpid(), s);
 283         free(s);
 284         if (ret == -1) {
 285                 const char *errstr = "asprintf failed\n";
 286                 write(log_state->fd, errstr, strlen(errstr));
 287                 return;
 288         }
 289         if (s2) {
 290                 write(log_state->fd, s2, strlen(s2));
 291                 free(s2);
 292         }
 293 }
 294
 295 static void ctdb_logfile_log_add(const char *format, va_list ap)
 296 {
 297         char *s = NULL;
 298         int ret;
 299
 300         ret = vasprintf(&s, format, ap);
 301         if (ret == -1) {
 302                 const char *errstr = "vasprintf failed\n";
 303
 304                 write(log_state->fd, errstr, strlen(errstr));
 305                 return;
 306         }
 307
 308         if (s) {
 309                 write(log_state->fd, s, strlen(s));
 310                 free(s);
 311         }
 312 }
 313
 314
 315
 316 /*
 317   choose the logfile location
 318 */
 319 int ctdb_set_logfile(struct ctdb_context *ctdb, const char *logfile, bool use_syslog)
 320 {
 321         int ret;
 322
 323         ctdb->log = talloc_zero(ctdb, struct ctdb_log_state);
 324         if (ctdb->log == NULL) {
 325                 printf("talloc_zero failed\n");
 326                 abort();
 327         }
 328
 329         ctdb->log->ctdb = ctdb;
 330         log_state = ctdb->log;
 331
 332         if (use_syslog) {
 333                 do_debug_v = ctdb_syslog_log;
 334                 do_debug_add_v = ctdb_syslog_log;
 335                 ctdb->log->use_syslog = true;
 336         } else if (logfile == NULL || strcmp(logfile, "-") == 0) {
 337                 do_debug_v = ctdb_logfile_log;
 338                 do_debug_add_v = ctdb_logfile_log_add;
 339                 ctdb->log->fd = 1;
 340                 /* also catch stderr of subcommands to stdout */
 341                 ret = dup2(1, 2);
 342                 if (ret == -1) {
 343                         printf("dup2 failed: %s\n", strerror(errno));
 344                         abort();
 345                 }
 346         } else {
 347                 do_debug_v = ctdb_logfile_log;
 348                 do_debug_add_v = ctdb_logfile_log_add;
 349
 350                 ctdb->log->fd = open(logfile, O_WRONLY|O_APPEND|O_CREAT, 0666);
 351                 if (ctdb->log->fd == -1) {
 352                         printf("Failed to open logfile %s\n", logfile);
 353                         abort();
 354                 }
 355         }
 356
 357         return 0;
 358 }
 359
 360 /* Note that do_debug always uses the global log state. */
 361 static void write_to_log(struct ctdb_log_state *log,
 362                          const char *buf, unsigned int len)
 363 {
 364         if (script_log_level <= LogLevel) {
 365                 do_debug("%*.*s\n", len, len, buf);
 366                 /* log it in the eventsystem as well */
 367                 if (log->logfn)
 368                         log->logfn(log->buf, len, log->logfn_private);
 369         }
 370 }
 371
 372 /*
 373   called when log data comes in from a child process
 374  */
 375 static void ctdb_log_handler(struct event_context *ev, struct fd_event *fde,
 376                              uint16_t flags, void *private)
 377 {
 378         struct ctdb_log_state *log = talloc_get_type(private, struct ctdb_log_state);
 379         char *p;
 380         int n;
 381
 382         if (!(flags & EVENT_FD_READ)) {
 383                 return;
 384         }
 385
 386         n = read(log->pfd, &log->buf[log->buf_used],
 387                  sizeof(log->buf) - log->buf_used);
 388         if (n > 0) {
 389                 log->buf_used += n;
 390         } else if (n == 0) {
 391                 if (log != log_state) {
 392                         talloc_free(log);
 393                 }
 394                 return;
 395         }
 396
 397         this_log_level = script_log_level;
 398
 399         while (log->buf_used > 0 &&
 400                (p = memchr(log->buf, '\n', log->buf_used)) != NULL) {
 401                 int n1 = (p - log->buf)+1;
 402                 int n2 = n1 - 1;
 403                 /* swallow \r from child processes */
 404                 if (n2 > 0 && log->buf[n2-1] == '\r') {
 405                         n2--;
 406                 }
 407                 write_to_log(log, log->buf, n2);
 408                 memmove(log->buf, p+1, sizeof(log->buf) - n1);
 409                 log->buf_used -= n1;
 410         }
 411
 412         /* the buffer could have completely filled - unfortunately we have
 413            no choice but to dump it out straight away */
 414         if (log->buf_used == sizeof(log->buf)) {
 415                 write_to_log(log, log->buf, log->buf_used);
 416                 log->buf_used = 0;
 417         }
 418 }
 419
 420 static int log_context_destructor(struct ctdb_log_state *log)
 421 {
 422         /* Flush buffer in case it wasn't \n-terminated. */
 423         if (log->buf_used > 0) {
 424                 this_log_level = script_log_level;
 425                 write_to_log(log, log->buf, log->buf_used);
 426         }
 427         return 0;
 428 }
 429
 430 /*
 431    fork(), redirecting child output to logging and specified callback.
 432 */
 433 struct ctdb_log_state *ctdb_fork_with_logging(TALLOC_CTX *mem_ctx,
 434                                               struct ctdb_context *ctdb,
 435                                               void (*logfn)(const char *, uint16_t, void *),
 436                                               void *logfn_private, pid_t *pid)
 437 {
 438         int p[2];
 439         struct ctdb_log_state *log;
 440
 441         log = talloc_zero(mem_ctx, struct ctdb_log_state);
 442         CTDB_NO_MEMORY_NULL(ctdb, log);
 443         log->ctdb = ctdb;
 444         log->logfn = logfn;
 445         log->logfn_private = (void *)logfn_private;
 446
 447         if (pipe(p) != 0) {
 448                 DEBUG(DEBUG_ERR,(__location__ " Failed to setup for child logging pipe\n"));
 449                 goto free_log;
 450         }
 451
 452         *pid = fork();
 453
 454         /* Child? */
 455         if (*pid == 0) {
 456                 close(STDOUT_FILENO);
 457                 close(STDERR_FILENO);
 458                 dup2(p[1], STDOUT_FILENO);
 459                 dup2(p[1], STDERR_FILENO);
 460                 close(p[0]);
 461                 close(p[1]);
 462                 return log;
 463         }
 464         close(p[1]);
 465
 466         /* We failed? */
 467         if (*pid < 0) {
 468                 DEBUG(DEBUG_ERR, (__location__ " fork failed for child process\n"));
 469                 close(p[0]);
 470                 goto free_log;
 471         }
 472
 473         log->pfd = p[0];
 474         set_close_on_exec(log->pfd);
 475         talloc_set_destructor(log, log_context_destructor);
 476         event_add_fd(ctdb->ev, log, log->pfd,
 477                      EVENT_FD_READ | EVENT_FD_AUTOCLOSE,
 478                      ctdb_log_handler, log);
 479         return log;
 480
 481 free_log:
 482         talloc_free(log);
 483         return NULL;
 484 }
 485
 486 /*
 487   setup for logging of child process stdout
 488 */
 489 int ctdb_set_child_logging(struct ctdb_context *ctdb)
 490 {
 491         int p[2];
 492         int old_stdout, old_stderr;
 493
 494         if (ctdb->log->fd == STDOUT_FILENO) {
 495                 /* not needed for stdout logging */
 496                 return 0;
 497         }
 498
 499         /* setup a pipe to catch IO from subprocesses */
 500         if (pipe(p) != 0) {
 501                 DEBUG(DEBUG_ERR,(__location__ " Failed to setup for child logging pipe\n"));
 502                 return -1;
 503         }
 504
 505         /* We'll fail if stderr/stdout not already open; it's simpler. */
 506         old_stdout = dup(STDOUT_FILENO);
 507         old_stderr = dup(STDERR_FILENO);
 508         if (dup2(p[1], STDOUT_FILENO) < 0 || dup2(p[1], STDERR_FILENO) < 0) {
 509                 int saved_errno = errno;
 510                 dup2(old_stdout, STDOUT_FILENO);
 511                 dup2(old_stderr, STDERR_FILENO);
 512                 close(old_stdout);
 513                 close(old_stderr);
 514                 close(p[0]);
 515                 close(p[1]);
 516                 errno = saved_errno;
 517
 518                 printf(__location__ " dup2 failed: %s\n",
 519                         strerror(errno));
 520                 return -1;
 521         }
 522         close(p[1]);
 523         close(old_stdout);
 524         close(old_stderr);
 525
 526         /* Is this correct for STDOUT and STDERR ? */
 527         set_close_on_exec(STDOUT_FILENO);
 528         set_close_on_exec(STDERR_FILENO);
 529         set_close_on_exec(p[0]);
 530
 531         event_add_fd(ctdb->ev, ctdb->log, p[0],
 532                      EVENT_FD_READ | EVENT_FD_AUTOCLOSE,
 533                      ctdb_log_handler, ctdb->log);
 534         ctdb->log->pfd = p[0];
 535
 536         DEBUG(DEBUG_DEBUG, (__location__ " Created PIPE FD:%d for logging\n", p[0]));
 537
 538         return 0;
 539 }
 540
 541
 542
 543
 544