2 $Id: cmd_dbd.c,v 1.13 2009-10-14 01:38:28 didg Exp $
4 Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
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 2 of the License, or
9 (at your option) any later version.
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.
18 dbd specs and implementation progress
19 =====================================
28 OK If -f is requested, ensure -e is too.
29 Check if volumes is using AFPVOL_CACHE, then wipe db from disk. Rebuild from ad-files.
36 OK F/D Make sure ad file exists
37 OK D Make sure .AppleDouble dir exist, create if missing. Error creating
38 it is fatal as that shouldn't happen as root.
39 OK F/D Delete orphaned ad-files, log dirs in ad-dir
40 OK F/D Check name encoding by roundtripping, log on error
41 OK F/D try: read CNID from ad file (if cnid caching is on)
42 try: fetch CNID from database
43 -> on mismatch: use CNID from file, update database (deleting both found CNIDs first)
44 -> if no CNID in ad file: write CNID from database to ad file
45 -> if no CNID in database: add CNID from ad file to database
46 -> on no CNID at all: create one and store in both places
47 OK F/D Add found CNID, DID, filename, dev/inode, stamp to rebuild database
48 OK F/D Check/update stamp (implicitly done while checking CNIDs)
51 2nd pass: Delete unused CNIDs
52 -----------------------------
56 OK Step through dbd (the one on disk) and rebuild-db from pass 1 and delete any CNID from
57 dbd not in rebuild db. This in only done in exclusive mode.
62 #endif /* HAVE_CONFIG_H */
65 #include <sys/types.h>
74 #include <atalk/logger.h>
75 #include <atalk/cnid_dbd_private.h>
76 #include <atalk/volinfo.h>
82 #define LOCKFILENAME "lock"
83 #define DBOPTIONS (DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL | DB_INIT_TXN)
85 int nocniddb = 0; /* Dont open CNID database, only scan filesystem */
86 volatile sig_atomic_t alarmed;
89 static int verbose; /* Logging flag */
90 static int exclusive; /* Exclusive volume access */
91 static struct db_param db_param = {
92 NULL, /* Volume dirpath */
93 1, /* bdb logfile autoremove */
94 16384, /* bdb cachesize */
95 -1, /* not used ... */
102 static char dbpath[PATH_MAX]; /* Path to the dbd database */
107 void dbd_log(enum logtype lt, char *fmt, ...)
110 static char logbuffer[1024];
113 if ( (lt == LOGSTD) || (verbose == 1)) {
115 len = vsnprintf(logbuffer, 1023, fmt, args);
119 printf("%s\n", logbuffer);
125 catch SIGINT and SIGTERM which cause clean exit. Ignore anything else.
128 static void sig_handler(int signo)
134 static void set_signal(void)
138 sv.sa_handler = sig_handler;
139 sv.sa_flags = SA_RESTART;
140 sigemptyset(&sv.sa_mask);
141 if (sigaction(SIGTERM, &sv, NULL) < 0) {
142 dbd_log( LOGSTD, "error in sigaction(SIGTERM): %s", strerror(errno));
145 if (sigaction(SIGINT, &sv, NULL) < 0) {
146 dbd_log( LOGSTD, "error in sigaction(SIGINT): %s", strerror(errno));
150 memset(&sv, 0, sizeof(struct sigaction));
151 sv.sa_handler = SIG_IGN;
152 sigemptyset(&sv.sa_mask);
154 if (sigaction(SIGABRT, &sv, NULL) < 0) {
155 dbd_log( LOGSTD, "error in sigaction(SIGABRT): %s", strerror(errno));
158 if (sigaction(SIGHUP, &sv, NULL) < 0) {
159 dbd_log( LOGSTD, "error in sigaction(SIGHUP): %s", strerror(errno));
162 if (sigaction(SIGQUIT, &sv, NULL) < 0) {
163 dbd_log( LOGSTD, "error in sigaction(SIGQUIT): %s", strerror(errno));
168 static int get_lock(const char *dbpath)
171 char lockpath[PATH_MAX];
175 if ( (strlen(dbpath) + strlen(LOCKFILENAME+1)) > (PATH_MAX - 1) ) {
176 dbd_log( LOGSTD, ".AppleDB pathname too long");
179 strncpy(lockpath, dbpath, PATH_MAX - 1);
180 strcat(lockpath, "/");
181 strcat(lockpath, LOCKFILENAME);
183 if ((lockfd = open(lockpath, O_RDWR | O_CREAT, 0644)) < 0) {
184 dbd_log( LOGSTD, "Error opening lockfile: %s", strerror(errno));
188 if ((stat(dbpath, &st)) != 0) {
189 dbd_log( LOGSTD, "Error statting lockfile: %s", strerror(errno));
193 if ((chown(lockpath, st.st_uid, st.st_gid)) != 0) {
194 dbd_log( LOGSTD, "Error inheriting lockfile permissions: %s", strerror(errno));
199 lock.l_whence = SEEK_SET;
201 lock.l_type = F_WRLCK;
203 if (fcntl(lockfd, F_SETLK, &lock) < 0) {
204 if (errno == EACCES || errno == EAGAIN) {
206 dbd_log( LOGSTD, "Database is in use and exlusive was requested", strerror(errno));
210 dbd_log( LOGSTD, "Error getting fcntl F_WRLCK on lockfile: %s", strerror(errno));
218 static void free_lock(int lockfd)
223 lock.l_whence = SEEK_SET;
225 lock.l_type = F_UNLCK;
226 fcntl(lockfd, F_SETLK, &lock);
230 static void usage (void)
232 printf("Usage: dbd [-e|-v|-x] -d [-i] | -s [-n]| -r [-f] | -u <path to netatalk volume>\n"
233 "dbd can dump, scan, reindex and rebuild Netatalk dbd CNID databases.\n"
234 "dbd must be run with appropiate permissions i.e. as root.\n\n"
235 "Main commands are:\n"
236 " -d Dump CNID database\n"
237 " Option: -i dump indexes too\n"
239 " 1. Compare CNIDs in database with volume\n"
240 " 2. Check if .AppleDouble dirs exist\n"
241 " 3. Check if AppleDouble file exist\n"
242 " 4. Report orphaned AppleDouble files\n"
243 " 5. Check for directories inside AppleDouble directories\n"
244 " 6. Check name encoding by roundtripping, log on error\n"
245 " 7. Check for orphaned CNIDs in database (requires -e)\n"
246 " 8. Open and close adouble files\n"
247 " Option: -n Don't open CNID database, skip CNID checks\n"
248 " -r Rebuild volume:\n"
249 " 1. Sync CNIDSs in database with volume\n"
250 " 2. Make sure .AppleDouble dir exist, create if missing\n"
251 " 3. Make sure AppleDouble file exists, create if missing\n"
252 " 4. Delete orphaned AppleDouble files\n"
253 " 5. Check for directories inside AppleDouble directories\n"
254 " 6. Check name encoding by roundtripping, log on error\n"
255 " 7. Check for orphaned CNIDs in database (requires -e)\n"
256 " 8. Open and close adouble files\n"
257 " Option: -f wipe database and rebuild from IDs stored in AppleDouble files,\n"
258 " only available for volumes without 'nocnidcache' option. Implies -e.\n"
259 " -u Prepare upgrade:\n"
260 " Before installing an upgraded version of Netatalk that is linked against\n"
261 " a newer BerkeleyDB lib, run `dbd -u ...` from the OLD Netatalk pior to\n"
262 " upgrading on all volumes. This removes the BerkleyDB environment.\n"
263 " On exit cnid_dbd does this automatically, so normally calling dbd -u should not be necessary.\n\n"
265 " -e only work on inactive volumes and lock them (exclusive)\n"
266 " -x rebuild indexes (just for completeness, mostly useless!)\n"
269 "If you want/need to run an -r -f rebuild after adding 'cachecnid' to a volume configuration,\n"
270 "you must run a rebuild with -r alone at first in order to sync all existing CNIDs from the db\n"
271 "to the AppleDouble files!\n"
275 int main(int argc, char **argv)
277 int c, lockfd, ret = -1;
278 int dump=0, scan=0, rebuild=0, prep_upgrade=0, rebuildindexes=0, dumpindexes=0, force=0;
279 dbd_flags_t flags = 0;
281 struct volinfo volinfo;
284 if (geteuid() != 0) {
289 while ((c = getopt(argc, argv, ":dsnruvxife")) != -1) {
299 flags |= DBD_FLAGS_SCAN;
315 flags |= DBD_FLAGS_EXCL;
323 flags |= DBD_FLAGS_FORCE | DBD_FLAGS_EXCL;
333 if ((dump + scan + rebuild + prep_upgrade) != 1) {
338 if ( (optind + 1) != argc ) {
342 volpath = argv[optind];
345 if ((cdir = open(".", O_RDONLY)) < 0) {
346 dbd_log( LOGSTD, "Can't open dir: %s", strerror(errno));
350 /* Setup signal handling */
353 /* Setup logging. Should be portable among *NIXes */
355 setuplog("default log_info /dev/tty");
357 setuplog("default log_debug /dev/tty");
359 /* Load .volinfo file */
360 if (loadvolinfo(volpath, &volinfo) == -1) {
361 dbd_log( LOGSTD, "Not a Netatalk volume at '%s', no .volinfo file at '%s/.AppleDesktop/.volinfo' or unknown volume options", volpath, volpath);
364 if (vol_load_charsets(&volinfo) == -1) {
365 dbd_log( LOGSTD, "Error loading charsets!");
369 /* Put "/.AppleDB" at end of volpath, get path from volinfo file */
370 if ( (strlen(volinfo.v_dbpath) + strlen("/.AppleDB")) > (PATH_MAX - 1) ) {
371 dbd_log( LOGSTD, "Volume pathname too long");
374 strncpy(dbpath, volinfo.v_dbpath, PATH_MAX - 9 - 1);
375 strcat(dbpath, "/.AppleDB");
378 Before we do anything else, check if there is an instance of cnid_dbd
379 running already and silently exit if yes.
381 lockfd = get_lock(dbpath);
383 /* Prepare upgrade ? */
385 if (dbif_prep_upgrade(dbpath))
390 /* Check if -f is requested and wipe db if yes */
391 if ((flags & DBD_FLAGS_FORCE) && rebuild && (volinfo.v_flags & AFPVOL_CACHE)) {
392 char cmd[8 + MAXPATHLEN];
393 snprintf(cmd, 8 + MAXPATHLEN, "rm -f %s/*", dbpath);
394 dbd_log( LOGDEBUG, "Removing old database of volume: '%s'", volpath);
396 dbd_log( LOGDEBUG, "Removed old database.");
400 Lets start with the BerkeleyDB stuff
403 if ((dbd = dbif_init(dbpath, "cnid2.db")) == NULL)
406 if (dbif_env_open(dbd, &db_param, exclusive ? (DBOPTIONS | DB_RECOVER) : DBOPTIONS) < 0) {
407 dbd_log( LOGSTD, "error opening database!");
412 dbd_log( LOGDEBUG, "Finished recovery.");
414 if (dbif_open(dbd, &db_param, rebuildindexes) < 0) {
419 if (dbd_stamp(dbd) < 0) {
425 /* Now execute given command scan|rebuild|dump */
426 if (dump && ! nocniddb) {
427 if (dbif_dump(dbd, dumpindexes) < 0) {
428 dbd_log( LOGSTD, "Error dumping database");
430 } else if ((rebuild && ! nocniddb) || (scan && nocniddb)) {
431 if (cmd_dbd_scanvol(dbd, &volinfo, flags) < 0) {
432 dbd_log( LOGSTD, "Error repairing database.");
437 if (! nocniddb && dbif_close(dbd) < 0) {
438 dbd_log( LOGSTD, "Error closing database");
448 if ((fchdir(cdir)) < 0)
449 dbd_log(LOGSTD, "fchdir: %s", strerror(errno));