/**
* RRDTool - src/rrd_daemon.c
- * Copyright (C) 2008 Florian octo Forster
- * Copyright (C) 2008 Kevin Brintnall
+ * Copyright (C) 2008,2009 Florian octo Forster
+ * Copyright (C) 2008,2009 Kevin Brintnall
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
#include <stdlib.h>
#ifndef WIN32
-#include <stdint.h>
+#ifdef HAVE_STDINT_H
+# include <stdint.h>
+#endif
#include <unistd.h>
#include <strings.h>
#include <inttypes.h>
-# include <sys/socket.h>
+#include <sys/socket.h>
#else
#include <sys/types.h>
#include <sys/stat.h>
+#include <dirent.h>
#include <fcntl.h>
#include <signal.h>
#include <sys/un.h>
/*
* Types
*/
-typedef enum
-{
- PRIV_LOW,
- PRIV_HIGH
-} socket_privilege;
-
typedef enum { RESP_ERR = -1, RESP_OK = 0 } response_code;
struct listen_socket_s
int fd;
char addr[PATH_MAX + 1];
int family;
- socket_privilege privilege;
/* state for BATCH processing */
time_t batch_start;
char *wbuf;
ssize_t wbuf_len;
+
+ uint32_t permissions;
};
typedef struct listen_socket_s listen_socket_t;
-struct command;
+struct command_s;
+typedef struct command_s command_t;
/* note: guard against "unused" warnings in the handlers */
#define DISPATCH_PROTO listen_socket_t *sock __attribute__((unused)),\
time_t now __attribute__((unused)),\
char *buffer __attribute__((unused)),\
size_t buffer_size __attribute__((unused))
-#define HANDLER_PROTO struct command *cmd __attribute__((unused)),\
+#define HANDLER_PROTO command_t *cmd __attribute__((unused)),\
DISPATCH_PROTO
-struct command {
+struct command_s {
char *cmd;
int (*handler)(HANDLER_PROTO);
- socket_privilege min_priv;
char context; /* where we expect to see it */
#define CMD_CONTEXT_CLIENT (1<<0)
};
typedef enum queue_side_e queue_side_t;
+/* describe a set of journal files */
+typedef struct {
+ char **files;
+ size_t files_num;
+} journal_set;
+
/* max length of socket command or response */
#define CMD_MAX 4096
#define RBUF_SIZE (CMD_MAX*2)
static pthread_mutex_t stats_lock = PTHREAD_MUTEX_INITIALIZER;
/* Journaled updates */
-static char *journal_cur = NULL;
-static char *journal_old = NULL;
-static FILE *journal_fh = NULL;
+#define JOURNAL_BASE "rrd.journal"
+static journal_set *journal_cur = NULL;
+static journal_set *journal_old = NULL;
+static char *journal_dir = NULL;
+static FILE *journal_fh = NULL; /* current journal file handle */
+static long journal_size = 0; /* current journal size */
+#define JOURNAL_MAX (1 * 1024 * 1024 * 1024)
static pthread_mutex_t journal_lock = PTHREAD_MUTEX_INITIALIZER;
static int journal_write(char *cmd, char *args);
static void journal_done(void);
/* NOTREACHED */
assert(1==0);
-}
+} /* }}} char *next_cmd */
/* add the characters directly to the write buffer */
static int add_to_wbuf(listen_socket_t *sock, char *str, size_t len) /* {{{ */
*filename = tmp;
} /* }}} static int get_abs_path */
-/* returns 1 if we have the required privilege level,
- * otherwise issue an error to the user on sock */
-static int has_privilege (listen_socket_t *sock, /* {{{ */
- socket_privilege priv)
-{
- if (sock == NULL) /* journal replay */
- return 1;
-
- if (sock->privilege >= priv)
- return 1;
-
- return send_response(sock, RESP_ERR, "%s\n", rrd_strerror(EACCES));
-} /* }}} static int has_privilege */
-
static int flush_file (const char *filename) /* {{{ */
{
cache_item_t *ci;
return (0);
} /* }}} int flush_file */
-static int syntax_error(listen_socket_t *sock, struct command *cmd) /* {{{ */
+static int syntax_error(listen_socket_t *sock, command_t *cmd) /* {{{ */
{
char *err = "Syntax error.\n";
return -1;
} /* }}} static int handle_request_quit */
-struct command COMMANDS[] = {
+static command_t list_of_commands[] = { /* {{{ */
{
"UPDATE",
handle_request_update,
- PRIV_HIGH,
CMD_CONTEXT_ANY,
"UPDATE <filename> <values> [<values> ...]\n"
,
{
"WROTE",
handle_request_wrote,
- PRIV_HIGH,
CMD_CONTEXT_JOURNAL,
NULL,
NULL
{
"FLUSH",
handle_request_flush,
- PRIV_LOW,
CMD_CONTEXT_CLIENT | CMD_CONTEXT_BATCH,
"FLUSH <filename>\n"
,
{
"FLUSHALL",
handle_request_flushall,
- PRIV_HIGH,
CMD_CONTEXT_CLIENT,
"FLUSHALL\n"
,
{
"PENDING",
handle_request_pending,
- PRIV_HIGH,
CMD_CONTEXT_CLIENT,
"PENDING <filename>\n"
,
{
"FORGET",
handle_request_forget,
- PRIV_HIGH,
CMD_CONTEXT_ANY,
"FORGET <filename>\n"
,
{
"QUEUE",
handle_request_queue,
- PRIV_LOW,
CMD_CONTEXT_CLIENT,
"QUEUE\n"
,
{
"STATS",
handle_request_stats,
- PRIV_LOW,
CMD_CONTEXT_CLIENT,
"STATS\n"
,
{
"HELP",
handle_request_help,
- PRIV_LOW,
CMD_CONTEXT_CLIENT,
"HELP [<command>]\n",
NULL, /* special! */
{
"BATCH",
batch_start,
- PRIV_LOW,
CMD_CONTEXT_CLIENT,
"BATCH\n"
,
{
".", /* BATCH terminator */
batch_done,
- PRIV_LOW,
CMD_CONTEXT_BATCH,
NULL,
NULL
{
"QUIT",
handle_request_quit,
- PRIV_LOW,
CMD_CONTEXT_CLIENT | CMD_CONTEXT_BATCH,
"QUIT\n"
,
"Disconnect from rrdcached.\n"
- },
- {NULL,NULL,0,0,NULL,NULL} /* LAST ENTRY */
-};
+ }
+}; /* }}} command_t list_of_commands[] */
+static size_t list_of_commands_len = sizeof (list_of_commands)
+ / sizeof (list_of_commands[0]);
-static struct command *find_command(char *cmd)
+static command_t *find_command(char *cmd)
{
- struct command *c = COMMANDS;
-
- while (c->cmd != NULL)
- {
- if (strcasecmp(cmd, c->cmd) == 0)
- break;
- c++;
- }
+ size_t i;
- if (c->cmd == NULL)
- return NULL;
- else
- return c;
+ for (i = 0; i < list_of_commands_len; i++)
+ if (strcasecmp(cmd, list_of_commands[i].cmd) == 0)
+ return (&list_of_commands[i]);
+ return NULL;
}
+/* We currently use the index in the `list_of_commands' array as a bit position
+ * in `listen_socket_t.permissions'. This member schould NEVER be accessed from
+ * outside these functions so that switching to a more elegant storage method
+ * is easily possible. */
+static ssize_t find_command_index (const char *cmd) /* {{{ */
+{
+ size_t i;
+
+ for (i = 0; i < list_of_commands_len; i++)
+ if (strcasecmp(cmd, list_of_commands[i].cmd) == 0)
+ return ((ssize_t) i);
+ return (-1);
+} /* }}} ssize_t find_command_index */
+
+static int socket_permission_check (listen_socket_t *sock, /* {{{ */
+ const char *cmd)
+{
+ ssize_t i;
+
+ if (cmd == NULL)
+ return (-1);
+
+ if ((strcasecmp ("QUIT", cmd) == 0)
+ || (strcasecmp ("HELP", cmd) == 0))
+ return (1);
+ else if (strcmp (".", cmd) == 0)
+ cmd = "BATCH";
+
+ i = find_command_index (cmd);
+ if (i < 0)
+ return (-1);
+ assert (i < 32);
+
+ if ((sock->permissions & (1 << i)) != 0)
+ return (1);
+ return (0);
+} /* }}} int socket_permission_check */
+
+static int socket_permission_add (listen_socket_t *sock, /* {{{ */
+ const char *cmd)
+{
+ ssize_t i;
+
+ i = find_command_index (cmd);
+ if (i < 0)
+ return (-1);
+ assert (i < 32);
+
+ sock->permissions |= (1 << i);
+ return (0);
+} /* }}} int socket_permission_add */
+
/* check whether commands are received in the expected context */
-static int command_check_context(listen_socket_t *sock, struct command *cmd)
+static int command_check_context(listen_socket_t *sock, command_t *cmd)
{
if (sock == NULL)
return (cmd->context & CMD_CONTEXT_JOURNAL);
int status;
char *cmd_str;
char *resp_txt;
- struct command *help = NULL;
+ command_t *help = NULL;
status = buffer_get_field (&buffer, &buffer_size, &cmd_str);
if (status == 0)
}
else
{
- help = COMMANDS;
+ size_t i;
+
resp_txt = "Command overview\n";
- while (help->cmd)
+ for (i = 0; i < list_of_commands_len; i++)
{
- if (help->syntax)
- add_response_info(sock, "%s", help->syntax);
- help++;
+ if (list_of_commands[i].syntax == NULL)
+ continue;
+ add_response_info (sock, "%s", list_of_commands[i].syntax);
}
}
{
char *buffer_ptr = buffer;
char *cmd_str = NULL;
- struct command *cmd = NULL;
+ command_t *cmd = NULL;
int status;
assert (buffer[buffer_size - 1] == '\0');
if (!cmd)
return send_response(sock, RESP_ERR, "Unknown command: %s\n", cmd_str);
- status = has_privilege(sock, cmd->min_priv);
- if (status <= 0)
- return status;
+ if (!socket_permission_check (sock, cmd->cmd))
+ return send_response(sock, RESP_ERR, "Permission denied.\n");
if (!command_check_context(sock, cmd))
return send_response(sock, RESP_ERR, "Can't use '%s' here.\n", cmd_str);
return cmd->handler(cmd, sock, now, buffer_ptr, buffer_size);
} /* }}} int handle_request */
-/* MUST NOT hold journal_lock before calling this */
-static void journal_rotate(void) /* {{{ */
+static void journal_set_free (journal_set *js) /* {{{ */
{
- FILE *old_fh = NULL;
- int new_fd;
-
- if (journal_cur == NULL || journal_old == NULL)
+ if (js == NULL)
return;
- pthread_mutex_lock(&journal_lock);
+ rrd_free_ptrs((void ***) &js->files, &js->files_num);
- /* we rotate this way (rename before close) so that the we can release
- * the journal lock as fast as possible. Journal writes to the new
- * journal can proceed immediately after the new file is opened. The
- * fclose can then block without affecting new updates.
- */
- if (journal_fh != NULL)
+ free(js);
+} /* }}} journal_set_free */
+
+static void journal_set_remove (journal_set *js) /* {{{ */
+{
+ if (js == NULL)
+ return;
+
+ for (uint i=0; i < js->files_num; i++)
{
- old_fh = journal_fh;
- journal_fh = NULL;
- rename(journal_cur, journal_old);
- ++stats_journal_rotate;
+ RRDD_LOG(LOG_DEBUG, "removing old journal %s", js->files[i]);
+ unlink(js->files[i]);
}
+} /* }}} journal_set_remove */
- new_fd = open(journal_cur, O_WRONLY|O_CREAT|O_APPEND,
- S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
- if (new_fd >= 0)
+/* close current journal file handle.
+ * MUST hold journal_lock before calling */
+static void journal_close(void) /* {{{ */
+{
+ if (journal_fh != NULL)
{
- journal_fh = fdopen(new_fd, "a");
- if (journal_fh == NULL)
- close(new_fd);
+ if (fclose(journal_fh) != 0)
+ RRDD_LOG(LOG_ERR, "cannot close journal: %s", rrd_strerror(errno));
}
- pthread_mutex_unlock(&journal_lock);
+ journal_fh = NULL;
+ journal_size = 0;
+} /* }}} journal_close */
+
+/* MUST hold journal_lock before calling */
+static void journal_new_file(void) /* {{{ */
+{
+ struct timeval now;
+ int new_fd;
+ char new_file[PATH_MAX + 1];
+
+ assert(journal_dir != NULL);
+ assert(journal_cur != NULL);
+
+ journal_close();
+
+ gettimeofday(&now, NULL);
+ /* this format assures that the files sort in strcmp() order */
+ snprintf(new_file, PATH_MAX, "%s/%s.%010d.%06d",
+ journal_dir, JOURNAL_BASE, (int)now.tv_sec, (int)now.tv_usec);
- if (old_fh != NULL)
- fclose(old_fh);
+ new_fd = open(new_file, O_WRONLY|O_CREAT|O_APPEND,
+ S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
+ if (new_fd < 0)
+ goto error;
+ journal_fh = fdopen(new_fd, "a");
if (journal_fh == NULL)
- {
- RRDD_LOG(LOG_CRIT,
- "JOURNALING DISABLED: Cannot open journal file '%s' : (%s)",
- journal_cur, rrd_strerror(errno));
+ goto error;
- RRDD_LOG(LOG_ERR,
- "JOURNALING DISABLED: All values will be flushed at shutdown");
- config_flush_at_shutdown = 1;
- }
+ journal_size = ftell(journal_fh);
+ RRDD_LOG(LOG_DEBUG, "started new journal %s", new_file);
+
+ /* record the file in the journal set */
+ rrd_add_strdup(&journal_cur->files, &journal_cur->files_num, new_file);
+
+ return;
+
+error:
+ RRDD_LOG(LOG_CRIT,
+ "JOURNALING DISABLED: Error while trying to create %s : %s",
+ new_file, rrd_strerror(errno));
+ RRDD_LOG(LOG_CRIT,
+ "JOURNALING DISABLED: All values will be flushed at shutdown");
+
+ close(new_fd);
+ config_flush_at_shutdown = 1;
+
+} /* }}} journal_new_file */
+
+/* MUST NOT hold journal_lock before calling this */
+static void journal_rotate(void) /* {{{ */
+{
+ journal_set *old_js = NULL;
+
+ if (journal_dir == NULL)
+ return;
+
+ RRDD_LOG(LOG_DEBUG, "rotating journals");
+
+ pthread_mutex_lock(&stats_lock);
+ ++stats_journal_rotate;
+ pthread_mutex_unlock(&stats_lock);
+
+ pthread_mutex_lock(&journal_lock);
+
+ journal_close();
+
+ /* rotate the journal sets */
+ old_js = journal_old;
+ journal_old = journal_cur;
+ journal_cur = calloc(1, sizeof(journal_set));
+
+ if (journal_cur != NULL)
+ journal_new_file();
+ else
+ RRDD_LOG(LOG_CRIT, "journal_rotate: malloc(journal_set) failed\n");
+
+ pthread_mutex_unlock(&journal_lock);
+
+ journal_set_remove(old_js);
+ journal_set_free (old_js);
} /* }}} static void journal_rotate */
+/* MUST hold journal_lock when calling */
static void journal_done(void) /* {{{ */
{
if (journal_cur == NULL)
return;
- pthread_mutex_lock(&journal_lock);
- if (journal_fh != NULL)
- {
- fclose(journal_fh);
- journal_fh = NULL;
- }
+ journal_close();
if (config_flush_at_shutdown)
{
RRDD_LOG(LOG_INFO, "removing journals");
- unlink(journal_old);
- unlink(journal_cur);
+ journal_set_remove(journal_old);
+ journal_set_remove(journal_cur);
}
else
{
"journals will be used at next startup");
}
- pthread_mutex_unlock(&journal_lock);
+ journal_set_free(journal_cur);
+ journal_set_free(journal_old);
+ free(journal_dir);
} /* }}} static void journal_done */
pthread_mutex_lock(&journal_lock);
chars = fprintf(journal_fh, "%s %s\n", cmd, args);
+ journal_size += chars;
+
+ if (journal_size > JOURNAL_MAX)
+ journal_new_file();
+
pthread_mutex_unlock(&journal_lock);
if (chars > 0)
memset(&statbuf, 0, sizeof(statbuf));
if (stat(file, &statbuf) != 0)
{
- if (errno == ENOENT)
- return 0;
-
reason = "stat error";
status = errno;
}
return entry_cnt > 0 ? 1 : 0;
} /* }}} static int journal_replay */
+static int journal_sort(const void *v1, const void *v2)
+{
+ char **jn1 = (char **) v1;
+ char **jn2 = (char **) v2;
+
+ return strcmp(*jn1,*jn2);
+}
+
static void journal_init(void) /* {{{ */
{
int had_journal = 0;
+ DIR *dir;
+ struct dirent *dent;
+ char path[PATH_MAX+1];
- if (journal_cur == NULL) return;
+ if (journal_dir == NULL) return;
pthread_mutex_lock(&journal_lock);
+ journal_cur = calloc(1, sizeof(journal_set));
+ if (journal_cur == NULL)
+ {
+ RRDD_LOG(LOG_CRIT, "journal_rotate: malloc(journal_set) failed\n");
+ return;
+ }
+
RRDD_LOG(LOG_INFO, "checking for journal files");
- had_journal += journal_replay(journal_old);
- had_journal += journal_replay(journal_cur);
+ /* Handle old journal files during transition. This gives them the
+ * correct sort order. TODO: remove after first release
+ */
+ {
+ char old_path[PATH_MAX+1];
+ snprintf(old_path, PATH_MAX, "%s/%s", journal_dir, JOURNAL_BASE ".old" );
+ snprintf(path, PATH_MAX, "%s/%s", journal_dir, JOURNAL_BASE ".0000");
+ rename(old_path, path);
+
+ snprintf(old_path, PATH_MAX, "%s/%s", journal_dir, JOURNAL_BASE );
+ snprintf(path, PATH_MAX, "%s/%s", journal_dir, JOURNAL_BASE ".0001");
+ rename(old_path, path);
+ }
+
+ dir = opendir(journal_dir);
+ while ((dent = readdir(dir)) != NULL)
+ {
+ /* looks like a journal file? */
+ if (strncmp(dent->d_name, JOURNAL_BASE, strlen(JOURNAL_BASE)))
+ continue;
+
+ snprintf(path, PATH_MAX, "%s/%s", journal_dir, dent->d_name);
+
+ if (!rrd_add_strdup(&journal_cur->files, &journal_cur->files_num, path))
+ {
+ RRDD_LOG(LOG_CRIT, "journal_init: cannot add journal file %s!",
+ dent->d_name);
+ break;
+ }
+ }
+ closedir(dir);
+
+ qsort(journal_cur->files, journal_cur->files_num,
+ sizeof(journal_cur->files[0]), journal_sort);
+
+ for (uint i=0; i < journal_cur->files_num; i++)
+ had_journal += journal_replay(journal_cur->files[i]);
+
+ journal_new_file();
/* it must have been a crash. start a flush */
if (had_journal && config_flush_at_shutdown)
flush_old_values(-1);
pthread_mutex_unlock(&journal_lock);
- journal_rotate();
RRDD_LOG(LOG_INFO, "journal processing complete");
RRDD_LOG(LOG_INFO, "clean shutdown; all RRDs flushed");
}
- journal_done();
-
free(queue_threads);
free(config_base_dir);
- free(config_pid_file);
- free(journal_cur);
- free(journal_old);
pthread_mutex_lock(&cache_lock);
g_tree_destroy(cache_tree);
+ pthread_mutex_lock(&journal_lock);
+ journal_done();
+
RRDD_LOG(LOG_INFO, "goodbye");
closelog ();
remove_pidfile ();
+ free(config_pid_file);
return (0);
} /* }}} int cleanup */
int option;
int status = 0;
- while ((option = getopt(argc, argv, "gl:L:f:w:z:t:Bb:p:Fj:h?")) != -1)
+ char **permissions = NULL;
+ size_t permissions_len = 0;
+
+ while ((option = getopt(argc, argv, "gl:P:f:w:z:t:Bb:p:Fj:h?")) != -1)
{
switch (option)
{
stay_foreground=1;
break;
- case 'L':
case 'l':
{
listen_socket_t *new;
memset(new, 0, sizeof(listen_socket_t));
strncpy(new->addr, optarg, sizeof(new->addr)-1);
- new->privilege = (option == 'l') ? PRIV_HIGH : PRIV_LOW;
+
+ /* Add permissions to the socket {{{ */
+ if (permissions_len != 0)
+ {
+ size_t i;
+ for (i = 0; i < permissions_len; i++)
+ {
+ status = socket_permission_add (new, permissions[i]);
+ if (status != 0)
+ {
+ fprintf (stderr, "read_options: Adding permission \"%s\" to "
+ "socket failed. Most likely, this permission doesn't "
+ "exist. Check your command line.\n", permissions[i]);
+ status = 4;
+ }
+ }
+ }
+ else /* if (permissions_len == 0) */
+ {
+ /* Add permission for ALL commands to the socket. */
+ size_t i;
+ for (i = 0; i < list_of_commands_len; i++)
+ {
+ status = socket_permission_add (new, list_of_commands[i].cmd);
+ if (status != 0)
+ {
+ fprintf (stderr, "read_options: Adding permission \"%s\" to "
+ "socket failed. This should never happen, ever! Sorry.\n",
+ permissions[i]);
+ status = 4;
+ }
+ }
+ }
+ /* }}} Done adding permissions. */
if (!rrd_add_ptr((void ***)&config_listen_address_list,
&config_listen_address_list_len, new))
}
break;
+ case 'P':
+ {
+ char *optcopy;
+ char *saveptr;
+ char *dummy;
+ char *ptr;
+
+ rrd_free_ptrs ((void *) &permissions, &permissions_len);
+
+ optcopy = strdup (optarg);
+ dummy = optcopy;
+ saveptr = NULL;
+ while ((ptr = strtok_r (dummy, ", ", &saveptr)) != NULL)
+ {
+ dummy = NULL;
+ rrd_add_strdup ((void *) &permissions, &permissions_len, ptr);
+ }
+
+ free (optcopy);
+ }
+ break;
+
case 'f':
{
int temp;
case 'j':
{
- struct stat statbuf;
- const char *dir = optarg;
+ const char *dir = journal_dir = strdup(optarg);
- status = stat(dir, &statbuf);
+ status = rrd_mkdir_p(dir, 0777);
if (status != 0)
{
- fprintf(stderr, "Cannot stat '%s' : %s\n", dir, rrd_strerror(errno));
+ fprintf(stderr, "Failed to create journal directory '%s': %s\n",
+ dir, rrd_strerror(errno));
return 6;
}
- if (!S_ISDIR(statbuf.st_mode)
- || access(dir, R_OK|W_OK|X_OK) != 0)
+ if (access(dir, R_OK|W_OK|X_OK) != 0)
{
fprintf(stderr, "Must specify a writable directory with -j! (%s)\n",
errno ? rrd_strerror(errno) : "");
return 6;
}
-
- journal_cur = malloc(PATH_MAX + 1);
- journal_old = malloc(PATH_MAX + 1);
- if (journal_cur == NULL || journal_old == NULL)
- {
- fprintf(stderr, "malloc failure for journal files\n");
- return 6;
- }
- else
- {
- snprintf(journal_cur, PATH_MAX, "%s/rrd.journal", dir);
- snprintf(journal_old, PATH_MAX, "%s/rrd.journal.old", dir);
- }
}
break;
case 'h':
case '?':
- printf ("RRDCacheD %s Copyright (C) 2008 Florian octo Forster\n"
+ printf ("RRDCacheD %s\n"
+ "Copyright (C) 2008,2009 Florian octo Forster and Kevin Brintnall\n"
"\n"
"Usage: rrdcached [options]\n"
"\n"
"Valid options are:\n"
" -l <address> Socket address to listen to.\n"
- " -L <address> Socket address to listen to ('FLUSH' only).\n"
+ " -P <perms> Sets the permissions to assign to all following "
+ "sockets\n"
" -w <seconds> Interval in which to write data.\n"
" -z <delay> Delay writes up to <delay> seconds to spread load\n"
" -t <threads> Number of write threads.\n"
fprintf(stderr, "WARNING: -B does not make sense without -b!\n"
" Consult the rrdcached documentation\n");
- if (journal_cur == NULL)
+ if (journal_dir == NULL)
config_flush_at_shutdown = 1;
+ rrd_free_ptrs ((void *) &permissions, &permissions_len);
+
return (status);
} /* }}} int read_options */
projects / rrdtool.git / blobdiff