nfsdcld: add routines for a sqlite backend database
authorJeff Layton <jlayton@redhat.com>
Thu, 26 Apr 2012 15:43:30 +0000 (11:43 -0400)
committerSteve Dickson <steved@redhat.com>
Thu, 26 Apr 2012 17:25:04 +0000 (13:25 -0400)
Rather than roll our own "storage engine", use sqlite instead. It fits
the bill nicely as it does:

- durable on-disk storage
- the ability to constrain record uniqueness
- a facility for collating and searching the host records

...it does add a build dependency to nfs-utils, but almost all modern
distros provide those packages.

The current incarnation of this code dynamically links against a
provided sqlite library, but we could also consider including their
single-file "amalgamation" to reduce dependencies (though with all
the caveats that that entails).

Signed-off-by: Jeff Layton <jlayton@redhat.com>
Signed-off-by: Steve Dickson <steved@redhat.com>
utils/nfsdcld/Makefile.am
utils/nfsdcld/nfsdcld.c
utils/nfsdcld/sqlite.c [new file with mode: 0644]
utils/nfsdcld/sqlite.h [new file with mode: 0644]

index ed7ed42..8e4f2ab 100644 (file)
@@ -6,9 +6,9 @@
 AM_CFLAGS      += -D_LARGEFILE64_SOURCE
 sbin_PROGRAMS  = nfsdcld
 
-nfsdcld_SOURCES = nfsdcld.c
+nfsdcld_SOURCES = nfsdcld.c sqlite.c
 
-nfsdcld_LDADD = ../../support/nfs/libnfs.a $(LIBEVENT)
+nfsdcld_LDADD = ../../support/nfs/libnfs.a $(LIBEVENT) $(LIBSQLITE)
 
 MAINTAINERCLEANFILES = Makefile.in
 
index 9fab2c3..c58801c 100644 (file)
@@ -61,6 +61,7 @@ static struct option longopts[] =
        { "foreground", 0, NULL, 'F' },
        { "debug", 0, NULL, 'd' },
        { "pipe", 1, NULL, 'p' },
+       { "storagedir", 1, NULL, 's' },
        { NULL, 0, 0, 0 },
 };
 
@@ -70,7 +71,7 @@ static void cldcb(int UNUSED(fd), short which, void *data);
 static void
 usage(char *progname)
 {
-       printf("Usage: %s [ -hFd ] [ -p pipe ]\n", progname);
+       printf("%s [ -hFd ] [ -p pipe ] [ -s dir ]\n", progname);
 }
 
 static int
@@ -144,15 +145,16 @@ cld_create(struct cld_client *clnt)
        ssize_t bsize, wsize;
        struct cld_msg *cmsg = &clnt->cl_msg;
 
-       xlog(D_GENERAL, "%s: create client record", __func__);
+       xlog(D_GENERAL, "%s: create client record.", __func__);
 
-       /* FIXME: create client record on storage here */
+       ret = sqlite_insert_client(cmsg->cm_u.cm_name.cn_id,
+                                  cmsg->cm_u.cm_name.cn_len);
 
-       /* set up reply */
-       cmsg->cm_status = 0;
+       cmsg->cm_status = ret ? -EREMOTEIO : ret;
 
        bsize = sizeof(*cmsg);
 
+       xlog(D_GENERAL, "Doing downcall with status %d", cmsg->cm_status);
        wsize = atomicio((void *)write, clnt->cl_fd, cmsg, bsize);
        if (wsize != bsize) {
                xlog(L_ERROR, "%s: problem writing to cld pipe (%ld): %m",
@@ -210,6 +212,7 @@ main(int argc, char **argv)
        int rc = 0;
        bool foreground = false;
        char *progname;
+       char *storagedir = NULL;
        struct cld_client clnt;
 
        memset(&clnt, 0, sizeof(clnt));
@@ -225,7 +228,7 @@ main(int argc, char **argv)
        xlog_stderr(1);
 
        /* process command-line options */
-       while ((arg = getopt_long(argc, argv, "hdFp:", longopts,
+       while ((arg = getopt_long(argc, argv, "hdFp:s:", longopts,
                                  NULL)) != EOF) {
                switch (arg) {
                case 'd':
@@ -237,6 +240,9 @@ main(int argc, char **argv)
                case 'p':
                        pipepath = optarg;
                        break;
+               case 's':
+                       storagedir = optarg;
+                       break;
                default:
                        usage(progname);
                        return 0;
@@ -256,6 +262,11 @@ main(int argc, char **argv)
        }
 
        /* set up storage db */
+       rc = sqlite_maindb_init(storagedir);
+       if (rc) {
+               xlog(L_ERROR, "Failed to open main database: %d", rc);
+               goto out;
+       }
 
        /* set up event handler */
        rc = cld_pipe_init(&clnt);
diff --git a/utils/nfsdcld/sqlite.c b/utils/nfsdcld/sqlite.c
new file mode 100644 (file)
index 0000000..f70568e
--- /dev/null
@@ -0,0 +1,253 @@
+/*
+ * Copyright (C) 2011  Red Hat, Jeff Layton <jlayton@redhat.com>
+ *
+ * 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 Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+/*
+ * Explanation:
+ *
+ * This file contains the code to manage the sqlite backend database for the
+ * clstated upcall daemon.
+ *
+ * The main database is called main.sqlite and contains the following tables:
+ *
+ * parameters: simple key/value pairs for storing database info
+ *
+ * clients: one column containing a BLOB with the as sent by the client
+ *         and a timestamp (in epoch seconds) of when the record was
+ *         established
+ *
+ * FIXME: should we also record the fsid being accessed?
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif /* HAVE_CONFIG_H */
+
+#include <errno.h>
+#include <event.h>
+#include <stdbool.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <sqlite3.h>
+#include <linux/limits.h>
+
+#include "xlog.h"
+
+#define CLD_SQLITE_SCHEMA_VERSION 1
+
+#ifndef CLD_SQLITE_TOPDIR
+#define CLD_SQLITE_TOPDIR NFS_STATEDIR "/nfsdcld"
+#endif
+
+/* in milliseconds */
+#define CLD_SQLITE_BUSY_TIMEOUT 10000
+
+/* private data structures */
+
+/* global variables */
+
+/* top level DB directory */
+static char *sqlite_topdir;
+
+/* reusable pathname and sql command buffer */
+static char buf[PATH_MAX];
+
+/* global database handle */
+static sqlite3 *dbh;
+
+/* forward declarations */
+
+/* make a directory, ignoring EEXIST errors unless it's not a directory */
+static int
+mkdir_if_not_exist(char *dirname)
+{
+       int ret;
+       struct stat statbuf;
+
+       ret = mkdir(dirname, S_IRWXU);
+       if (ret && errno != EEXIST)
+               return -errno;
+
+       ret = stat(dirname, &statbuf);
+       if (ret)
+               return -errno;
+
+       if (!S_ISDIR(statbuf.st_mode))
+               ret = -ENOTDIR;
+
+       return ret;
+}
+
+/*
+ * Open the "main" database, and attempt to initialize it by creating the
+ * parameters table and inserting the schema version into it. Ignore any errors
+ * from that, and then attempt to select the version out of it again. If the
+ * version appears wrong, then assume that the DB is corrupt or has been
+ * upgraded, and return an error. If all of that works, then attempt to create
+ * the "clients" table.
+ */
+int
+sqlite_maindb_init(char *topdir)
+{
+       int ret;
+       char *err = NULL;
+       sqlite3_stmt *stmt = NULL;
+
+       sqlite_topdir = topdir ? topdir : CLD_SQLITE_TOPDIR;
+
+       ret = mkdir_if_not_exist(sqlite_topdir);
+       if (ret)
+               return ret;
+
+       ret = snprintf(buf, PATH_MAX - 1, "%s/main.sqlite", sqlite_topdir);
+       if (ret < 0)
+               return ret;
+
+       buf[PATH_MAX - 1] = '\0';
+
+       ret = sqlite3_open(buf, &dbh);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "Unable to open main database: %d", ret);
+               return ret;
+       }
+
+       ret = sqlite3_busy_timeout(dbh, CLD_SQLITE_BUSY_TIMEOUT);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "Unable to set sqlite busy timeout: %d", ret);
+               goto out_err;
+       }
+
+       /* Try to create table */
+       ret = sqlite3_exec(dbh, "CREATE TABLE IF NOT EXISTS parameters "
+                               "(key TEXT PRIMARY KEY, value TEXT);",
+                               NULL, NULL, &err);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "Unable to create parameter table: %d", ret);
+               goto out_err;
+       }
+
+       /* insert version into table -- ignore error if it fails */
+       ret = snprintf(buf, sizeof(buf),
+                      "INSERT OR IGNORE INTO parameters values (\"version\", "
+                      "\"%d\");", CLD_SQLITE_SCHEMA_VERSION);
+       if (ret < 0) {
+               goto out_err;
+       } else if ((size_t)ret >= sizeof(buf)) {
+               ret = -EINVAL;
+               goto out_err;
+       }
+
+       ret = sqlite3_exec(dbh, (const char *)buf, NULL, NULL, &err);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "Unable to insert into parameter table: %d",
+                               ret);
+               goto out_err;
+       }
+
+       ret = sqlite3_prepare_v2(dbh,
+               "SELECT value FROM parameters WHERE key == \"version\";",
+                -1, &stmt, NULL);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "Unable to prepare select statement: %d", ret);
+               goto out_err;
+       }
+
+       /* check schema version */
+       ret = sqlite3_step(stmt);
+       if (ret != SQLITE_ROW) {
+               xlog(L_ERROR, "Select statement execution failed: %s",
+                               sqlite3_errmsg(dbh));
+               goto out_err;
+       }
+
+       /* process SELECT result */
+       ret = sqlite3_column_int(stmt, 0);
+       if (ret != CLD_SQLITE_SCHEMA_VERSION) {
+               xlog(L_ERROR, "Unsupported database schema version! "
+                       "Expected %d, got %d.",
+                       CLD_SQLITE_SCHEMA_VERSION, ret);
+               ret = -EINVAL;
+               goto out_err;
+       }
+
+       /* now create the "clients" table */
+       ret = sqlite3_exec(dbh, "CREATE TABLE IF NOT EXISTS clients "
+                               "(id BLOB PRIMARY KEY, time INTEGER);",
+                               NULL, NULL, &err);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "Unable to create clients table: %s", err);
+               goto out_err;
+       }
+
+       sqlite3_free(err);
+       sqlite3_finalize(stmt);
+       return 0;
+
+out_err:
+       if (err) {
+               xlog(L_ERROR, "sqlite error: %s", err);
+               sqlite3_free(err);
+       }
+       sqlite3_finalize(stmt);
+       sqlite3_close(dbh);
+       return ret;
+}
+
+/*
+ * Create a client record
+ *
+ * Returns a non-zero sqlite error code, or SQLITE_OK (aka 0)
+ */
+int
+sqlite_insert_client(const unsigned char *clname, const size_t namelen)
+{
+       int ret;
+       sqlite3_stmt *stmt = NULL;
+
+       ret = sqlite3_prepare_v2(dbh, "INSERT OR REPLACE INTO clients VALUES "
+                                     "(?, strftime('%s', 'now'));", -1,
+                                       &stmt, NULL);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "%s: insert statement prepare failed: %s",
+                       __func__, sqlite3_errmsg(dbh));
+               return ret;
+       }
+
+       ret = sqlite3_bind_blob(stmt, 1, (const void *)clname, namelen,
+                               SQLITE_STATIC);
+       if (ret != SQLITE_OK) {
+               xlog(L_ERROR, "%s: bind blob failed: %s", __func__,
+                               sqlite3_errmsg(dbh));
+               goto out_err;
+       }
+
+       ret = sqlite3_step(stmt);
+       if (ret == SQLITE_DONE)
+               ret = SQLITE_OK;
+       else
+               xlog(L_ERROR, "%s: unexpected return code from insert: %s",
+                               __func__, sqlite3_errmsg(dbh));
+
+out_err:
+       xlog(D_GENERAL, "%s: returning %d", __func__, ret);
+       sqlite3_finalize(stmt);
+       return ret;
+}
diff --git a/utils/nfsdcld/sqlite.h b/utils/nfsdcld/sqlite.h
new file mode 100644 (file)
index 0000000..ba4c213
--- /dev/null
@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2011  Red Hat, Jeff Layton <jlayton@redhat.com>
+ *
+ * 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 Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef _SQLITE_H_
+#define _SQLITE_H_
+
+int sqlite_maindb_init(char *topdir);
+int sqlite_insert_client(const unsigned char *clname, const size_t namelen);
+
+#endif /* _SQLITE_H */