mandoc/mandocdb.c - diff

Return to mandocdb.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandocdb.c between version 1.220.2.12 and 1.256

version 1.220.2.12, 2017/02/17 14:50:13

version 1.256, 2017/08/26 20:38:14

Line 19

#include "config.h"

#include <sys/types.h>

#include <sys/mman.h>

#include <sys/stat.h>

#include <sys/wait.h>

#include <assert.h>

#include <ctype.h>

Line 38

#if HAVE_SANDBOX_INIT

#include <sandbox.h>

#endif

#include <stdarg.h>

#include <stddef.h>

#include <stdio.h>

#include <stdint.h>

Line 45

Line 46

#include <string.h>

#include <unistd.h>

#include <sqlite3.h>

#include "mandoc_aux.h"

#include "mandoc_ohash.h"

#include "mandoc.h"

Line 55

Line 54

#include "man.h"

#include "manconf.h"

#include "mansearch.h"

#include "dba_array.h"

#include "dba.h"

extern int mansearch_keymax;

extern const char *const mansearch_keynames[];

#define SQL_EXEC(_v) \

if (SQLITE_OK != sqlite3_exec(db, (_v), NULL, NULL, NULL)) \

say("", "%s: %s", (_v), sqlite3_errmsg(db))

#define SQL_BIND_TEXT(_s, _i, _v) \

if (SQLITE_OK != sqlite3_bind_text \

((_s), (_i)++, (_v), -1, SQLITE_STATIC)) \

say(mlink->file, "%s", sqlite3_errmsg(db))

#define SQL_BIND_INT(_s, _i, _v) \

if (SQLITE_OK != sqlite3_bind_int \

((_s), (_i)++, (_v))) \

say(mlink->file, "%s", sqlite3_errmsg(db))

#define SQL_BIND_INT64(_s, _i, _v) \

if (SQLITE_OK != sqlite3_bind_int64 \

((_s), (_i)++, (_v))) \

say(mlink->file, "%s", sqlite3_errmsg(db))

#define SQL_STEP(_s) \

if (SQLITE_DONE != sqlite3_step((_s))) \

say(mlink->file, "%s", sqlite3_errmsg(db))

enum op {

OP_DEFAULT = 0, /* new dbs from dir list or default config */

OP_CONFFILE, /* new databases from custom config file */

Line 99 struct inodev {

Line 80 struct inodev {

struct mpage {

struct inodev inodev; /* used for hashing routine */

int64_t pageid; /* pageid in mpages SQL table */

struct dba_array *dba;

char *sec; /* section from file content */

char *arch; /* architecture from file content */

char *title; /* title from file content */

char *desc; /* description from file content */

struct mpage *next; /* singly linked list */

struct mlink *mlinks; /* singly linked list */

int form; /* format from file content */

int name_head_done;

enum form form; /* format from file content */

};

struct mlink {

Line 118 struct mlink {

Line 99 struct mlink {

char *fsec; /* section from file name suffix */

struct mlink *next; /* singly linked list */

struct mpage *mpage; /* parent */

int dform; /* format from directory */

int fform; /* format from file name suffix */

int gzip; /* filename has a .gz suffix */

enum form dform; /* format from directory */

enum form fform; /* format from file name suffix */

};

enum stmt {

STMT_DELETE_PAGE = 0, /* delete mpage */

STMT_INSERT_PAGE, /* insert mpage */

STMT_INSERT_LINK, /* insert mlink */

STMT_INSERT_NAME, /* insert name */

STMT_SELECT_NAME, /* retrieve existing name flags */

STMT_INSERT_KEY, /* insert parsed key */

STMT__MAX

};

typedef int (*mdoc_fp)(struct mpage *, const struct roff_meta *,

const struct roff_node *);

Line 145 struct mdoc_handler {

Line 116 struct mdoc_handler {

int mandocdb(int, char *[]);

static void dbclose(int);

static void dbadd(struct dba *, struct mpage *);

static void dbadd(struct mpage *);

static void dbadd_mlink(const struct mlink *mlink);

static void dbadd_mlink_name(const struct mlink *mlink);

static void dbprune(struct dba *);

static int dbopen(int);

static void dbwrite(struct dba *);

static void dbprune(void);

static void filescan(const char *);

#if HAVE_FTS_COMPARE_CONST

static int fts_compare(const FTSENT *const *, const FTSENT *const *);

Line 162 static void mlink_check(struct mpage *, struct mlink

Line 131 static void mlink_check(struct mpage *, struct mlink

static void mlink_free(struct mlink *);

static void mlinks_undupe(struct mpage *);

static void mpages_free(void);

static void mpages_merge(struct mparse *);

static void mpages_merge(struct dba *, struct mparse *);

static void names_check(void);

static void parse_cat(struct mpage *, int);

static void parse_man(struct mpage *, const struct roff_meta *,

const struct roff_node *);

Line 199 static int set_basedir(const char *, int);

Line 167 static int set_basedir(const char *, int);

static int treescan(void);

static size_t utf8(unsigned int, char [7]);

static char tempfilename[32];

static int nodb; /* no database changes */

static int mparse_options; /* abort the parse early */

static int use_all; /* use all found files */

Line 214 static struct ohash mpages; /* table of distinct manu

Line 181 static struct ohash mpages; /* table of distinct manu

static struct ohash mlinks; /* table of directory entries */

static struct ohash names; /* table of all names */

static struct ohash strings; /* table of all strings */

static sqlite3 *db = NULL; /* current database */

static sqlite3_stmt *stmts[STMT__MAX]; /* current statements */

static uint64_t name_mask;

static const struct mdoc_handler mdocs[MDOC_MAX] = {

static const struct mdoc_handler __mdocs[MDOC_MAX - MDOC_Dd] = {

{ NULL, 0, 0 }, /* Ap */

{ NULL, 0, NODE_NOPRT }, /* Dd */

{ NULL, 0, NODE_NOPRT }, /* Dt */

{ NULL, 0, NODE_NOPRT }, /* Os */

Line 235 static const struct mdoc_handler mdocs[MDOC_MAX] = {

Line 199 static const struct mdoc_handler mdocs[MDOC_MAX] = {

{ NULL, 0, 0 }, /* It */

{ NULL, 0, 0 }, /* Ad */

{ NULL, TYPE_An, 0 }, /* An */

{ NULL, 0, 0 }, /* Ap */

{ NULL, TYPE_Ar, 0 }, /* Ar */

{ NULL, TYPE_Cd, 0 }, /* Cd */

{ NULL, TYPE_Cm, 0 }, /* Cm */

Line 337 static const struct mdoc_handler mdocs[MDOC_MAX] = {

Line 302 static const struct mdoc_handler mdocs[MDOC_MAX] = {

{ NULL, 0, 0 }, /* En */

{ NULL, TYPE_Dx, NODE_NOSRC }, /* Dx */

{ NULL, 0, 0 }, /* %Q */

{ NULL, 0, 0 }, /* br */

{ NULL, 0, 0 }, /* sp */

{ NULL, 0, 0 }, /* %U */

{ NULL, 0, 0 }, /* Ta */

{ NULL, 0, 0 }, /* ll */

};

static const struct mdoc_handler *const mdocs = __mdocs - MDOC_Dd;

int

Line 350 mandocdb(int argc, char *argv[])

Line 313 mandocdb(int argc, char *argv[])

{

struct manconf conf;

struct mparse *mp;

struct dba *dba;

const char *path_arg, *progname;

size_t j, sz;

int ch, i;

#if HAVE_PLEDGE

if (pledge("stdio rpath wpath cpath fattr flock proc exec", NULL) == -1) {

if (pledge("stdio rpath wpath cpath", NULL) == -1) {

warn("pledge");

return (int)MANDOCLEVEL_SYSERR;

}

Line 369 mandocdb(int argc, char *argv[])

Line 333 mandocdb(int argc, char *argv[])

#endif

memset(&conf, 0, sizeof(conf));

memset(stmts, 0, STMT__MAX * sizeof(sqlite3_stmt *));

* We accept a few different invocations.

Line 457 mandocdb(int argc, char *argv[])

Line 420 mandocdb(int argc, char *argv[])

exitcode = (int)MANDOCLEVEL_OK;

mchars_alloc();

mp = mparse_alloc(mparse_options, MANDOCLEVEL_BADARG, NULL, NULL);

mp = mparse_alloc(mparse_options, MANDOCERR_MAX, NULL,

MANDOC_OS_OTHER, NULL);

mandoc_ohash_init(&mpages, 6, offsetof(struct mpage, inodev));

mandoc_ohash_init(&mlinks, 6, offsetof(struct mlink, file));

Line 470 mandocdb(int argc, char *argv[])

Line 434 mandocdb(int argc, char *argv[])

if (OP_TEST != op && 0 == set_basedir(path_arg, 1))

goto out;

if (dbopen(1)) {

dba = nodb ? dba_new(128) : dba_read(MANDOC_DB);

if (dba != NULL) {

* The existing database is usable. Process

* all files specified on the command-line.

#if HAVE_PLEDGE

if (!nodb) {

if (pledge("stdio rpath wpath cpath fattr flock", NULL) == -1) {

warn("pledge");

exitcode = (int)MANDOCLEVEL_SYSERR;

goto out;

}

#endif

use_all = 1;

for (i = 0; i < argc; i++)

filescan(argv[i]);

if (OP_TEST != op)

if (nodb == 0)

dbprune();

dbprune(dba);

} else {

/* Database missing or corrupt. */

* Database missing or corrupt.

if (op != OP_UPDATE || errno != ENOENT)

* Recreate from scratch.

say(MANDOC_DB, "%s: Automatically recreating"

" from scratch", strerror(errno));

exitcode = (int)MANDOCLEVEL_OK;

op = OP_DEFAULT;

if (0 == treescan())

goto out;

if (0 == dbopen(0))

dba = dba_new(128);

goto out;

}

if (OP_DELETE != op)

mpages_merge(mp);

mpages_merge(dba, mp);

dbclose(OP_DEFAULT == op ? 0 : 1);

if (nodb == 0)

dbwrite(dba);

dba_free(dba);

} else {

* If we have arguments, use them as our manpaths.

* If we don't, grok from manpath(1) or however else

* If we don't, use man.conf(5).

* manconf_parse() wants to do it.

if (argc > 0) {

conf.manpath.paths = mandoc_reallocarray(NULL,

Line 548 mandocdb(int argc, char *argv[])

Line 504 mandocdb(int argc, char *argv[])

continue;

if (0 == treescan())

continue;

if (0 == dbopen(0))

dba = dba_new(128);

continue;

mpages_merge(dba, mp);

if (nodb == 0)

dbwrite(dba);

dba_free(dba);

mpages_merge(mp);

if (warnings && !nodb &&

! (MPARSE_QUICK & mparse_options))

names_check();

dbclose(0);

if (j + 1 < conf.manpath.sz) {

mpages_free();

ohash_delete(&mpages);

Line 619 treescan(void)

Line 572 treescan(void)

FTS *f;

FTSENT *ff;

struct mlink *mlink;

int dform, gzip;

int gzip;

enum form dform;

char *dsec, *arch, *fsec, *cp;

const char *path;

const char *argv[2];

Line 1007 mlink_add(struct mlink *mlink, const struct stat *st)

Line 961 mlink_add(struct mlink *mlink, const struct stat *st)

mpage = mandoc_calloc(1, sizeof(struct mpage));

mpage->inodev.st_ino = inodev.st_ino;

mpage->inodev.st_dev = inodev.st_dev;

mpage->form = FORM_NONE;

mpage->next = mpage_head;

mpage_head = mpage;

ohash_insert(&mpages, slot, mpage);

Line 1120 mlink_check(struct mpage *mpage, struct mlink *mlink)

Line 1075 mlink_check(struct mpage *mpage, struct mlink *mlink)

* architectures.

* A few manuals are even shared across completely

* different architectures, for example fdformat(1)

* on amd64, i386, sparc, and sparc64.

* on amd64, i386, and sparc64.

if (strcasecmp(mpage->arch, mlink->arch))

Line 1155 mlink_check(struct mpage *mpage, struct mlink *mlink)

Line 1110 mlink_check(struct mpage *mpage, struct mlink *mlink)

* and filename to determine whether the file is parsable or not.

static void

mpages_merge(struct mparse *mp)

mpages_merge(struct dba *dba, struct mparse *mp)

{

char any[] = "any";

struct mpage *mpage, *mpage_dest;

struct mlink *mlink, *mlink_dest;

struct roff_man *man;

Line 1165 mpages_merge(struct mparse *mp)

Line 1119 mpages_merge(struct mparse *mp)

char *cp;

int fd;

if ( ! nodb)

SQL_EXEC("BEGIN TRANSACTION");

for (mpage = mpage_head; mpage != NULL; mpage = mpage->next) {

mlinks_undupe(mpage);

if ((mlink = mpage->mlinks) == NULL)

Line 1222 mpages_merge(struct mparse *mp)

Line 1173 mpages_merge(struct mparse *mp)

* to the target.

if (mpage_dest->pageid)

if (mpage_dest->dba != NULL)

dbadd_mlink_name(mlink);

dbadd_mlink(mlink);

if (mlink->next == NULL)

break;

Line 1250 mpages_merge(struct mparse *mp)

Line 1201 mpages_merge(struct mparse *mp)

} else if (man != NULL && man->macroset == MACROSET_MAN) {

man_validate(man);

if (*man->meta.msec != '\0' ||

*man->meta.msec != '\0') {

*man->meta.title != '\0') {

mpage->form = FORM_SRC;

mpage->sec = mandoc_strdup(man->meta.msec);

mpage->arch = mandoc_strdup(mlink->arch);

Line 1277 mpages_merge(struct mparse *mp)

Line 1228 mpages_merge(struct mparse *mp)

"using filename \"%s\"", mlink->name);

}

putkey(mpage, mpage->sec, TYPE_sec);

for (mlink = mpage->mlinks;

if (*mpage->arch != '\0')

mlink != NULL;

putkey(mpage, mpage->arch, TYPE_arch);

mlink = mlink->next) {

for ( ; mlink != NULL; mlink = mlink->next) {

if ('\0' != *mlink->dsec)

putkey(mpage, mlink->dsec, TYPE_sec);

if ('\0' != *mlink->fsec)

putkey(mpage, mlink->fsec, TYPE_sec);

putkey(mpage, '\0' == *mlink->arch ?

any : mlink->arch, TYPE_arch);

putkey(mpage, mlink->name, NAME_FILE);

if (warnings && !use_all)

mlink_check(mpage, mlink);

}

if (warnings && !use_all)

dbadd(dba, mpage);

for (mlink = mpage->mlinks; mlink;

mlink = mlink->next)

mlink_check(mpage, mlink);

dbadd(mpage);

ohash_delete(&strings);

ohash_delete(&names);

}

if (0 == nodb)

SQL_EXEC("END TRANSACTION");

}

static void

names_check(void)

{

sqlite3_stmt *stmt;

const char *name, *sec, *arch, *key;

sqlite3_prepare_v2(db,

"SELECT name, sec, arch, key FROM ("

"SELECT name AS key, pageid FROM names "

"WHERE bits & ? AND NOT EXISTS ("

"SELECT pageid FROM mlinks "

"WHERE mlinks.pageid == names.pageid "

"AND mlinks.name == names.name"

")"

") JOIN ("

"SELECT sec, arch, name, pageid FROM mlinks "

"GROUP BY pageid"

") USING (pageid);",

-1, &stmt, NULL);

if (sqlite3_bind_int64(stmt, 1, NAME_TITLE) != SQLITE_OK)

say("", "%s", sqlite3_errmsg(db));

while (sqlite3_step(stmt) == SQLITE_ROW) {

name = (const char *)sqlite3_column_text(stmt, 0);

sec = (const char *)sqlite3_column_text(stmt, 1);

arch = (const char *)sqlite3_column_text(stmt, 2);

key = (const char *)sqlite3_column_text(stmt, 3);

say("", "%s(%s%s%s) lacks mlink \"%s\"", name, sec,

'\0' == *arch ? "" : "/",

'\0' == *arch ? "" : arch, key);

}

sqlite3_finalize(stmt);

}

static void

parse_cat(struct mpage *mpage, int fd)

{

FILE *stream;

Line 1482 parse_cat(struct mpage *mpage, int fd)

Line 1384 parse_cat(struct mpage *mpage, int fd)

static void

putkey(const struct mpage *mpage, char *value, uint64_t type)

{

char *cp;

assert(NULL != value);

if (TYPE_arch == type)

for (cp = value; *cp; cp++)

if (isupper((unsigned char)*cp))

*cp = _tolower((unsigned char)*cp);

putkeys(mpage, value, strlen(value), type);

}

Line 1640 parse_mdoc(struct mpage *mpage, const struct roff_meta

Line 1535 parse_mdoc(struct mpage *mpage, const struct roff_meta

const struct roff_node *n)

{

assert(NULL != n);

for (n = n->child; n != NULL; n = n->next) {

for (n = n->child; NULL != n; n = n->next) {

if (n->tok == TOKEN_NONE ||

if (n->flags & mdocs[n->tok].taboo)

n->tok < ROFF_MAX ||

n->flags & mdocs[n->tok].taboo)

continue;

assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);

switch (n->type) {

case ROFFT_ELEM:

case ROFFT_BLOCK:

case ROFFT_HEAD:

case ROFFT_BODY:

case ROFFT_TAIL:

if (NULL != mdocs[n->tok].fp)

if (mdocs[n->tok].fp != NULL &&

if (0 == (*mdocs[n->tok].fp)(mpage, meta, n))

(*mdocs[n->tok].fp)(mpage, meta, n) == 0)

break;

if (mdocs[n->tok].mask)

putmdockey(mpage, n->child,

mdocs[n->tok].mask, mdocs[n->tok].taboo);

break;

default:

assert(n->type != ROFFT_ROOT);

continue;

}

if (NULL != n->child)

Line 1886 putkeys(const struct mpage *mpage, char *cp, size_t sz

Line 1782 putkeys(const struct mpage *mpage, char *cp, size_t sz

} else {

htab = &strings;

if (debug > 1)

for (i = 0; i < mansearch_keymax; i++)

for (i = 0; i < KEY_MAX; i++)

if ((uint64_t)1 << i & v)

say(mpage->mlinks->file,

"Adding key %s=%*s",

Line 2092 render_string(char **public, size_t *psz)

Line 1988 render_string(char **public, size_t *psz)

static void

dbadd_mlink(const struct mlink *mlink)

{

size_t i;

dba_page_alias(mlink->mpage->dba, mlink->name, NAME_FILE);

dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->dsec);

i = 1;

dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->fsec);

SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->dsec);

dba_page_add(mlink->mpage->dba, DBP_ARCH, mlink->arch);

SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->arch);

dba_page_add(mlink->mpage->dba, DBP_FILE, mlink->file);

SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->name);

SQL_BIND_INT64(stmts[STMT_INSERT_LINK], i, mlink->mpage->pageid);

SQL_STEP(stmts[STMT_INSERT_LINK]);

sqlite3_reset(stmts[STMT_INSERT_LINK]);

}

static void

dbadd_mlink_name(const struct mlink *mlink)

{

uint64_t bits;

size_t i;

dbadd_mlink(mlink);

i = 1;

SQL_BIND_INT64(stmts[STMT_SELECT_NAME], i, mlink->mpage->pageid);

bits = NAME_FILE & NAME_MASK;

if (sqlite3_step(stmts[STMT_SELECT_NAME]) == SQLITE_ROW) {

bits |= sqlite3_column_int64(stmts[STMT_SELECT_NAME], 0);

sqlite3_reset(stmts[STMT_SELECT_NAME]);

}

i = 1;

SQL_BIND_INT64(stmts[STMT_INSERT_NAME], i, bits);

SQL_BIND_TEXT(stmts[STMT_INSERT_NAME], i, mlink->name);

SQL_BIND_INT64(stmts[STMT_INSERT_NAME], i, mlink->mpage->pageid);

SQL_STEP(stmts[STMT_INSERT_NAME]);

sqlite3_reset(stmts[STMT_INSERT_NAME]);

}

* Flush the current page's terms (and their bits) into the database.

* Wrap the entire set of additions in a transaction to make sqlite be a

* little faster.

* Also, handle escape sequences at the last possible moment.

static void

dbadd(struct mpage *mpage)

dbadd(struct dba *dba, struct mpage *mpage)

{

struct mlink *mlink;

struct str *key;

char *cp;

uint64_t mask;

size_t i;

unsigned int slot;

int mustfree;

Line 2183 dbadd(struct mpage *mpage)

Line 2050 dbadd(struct mpage *mpage)

cp = mpage->desc;

i = strlen(cp);

mustfree = render_string(&cp, &i);

i = 1;

mpage->dba = dba_page_new(dba->pages,

SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, cp);

*mpage->arch == '\0' ? mlink->arch : mpage->arch,

SQL_BIND_INT(stmts[STMT_INSERT_PAGE], i, mpage->form);

cp, mlink->file, mpage->form);

SQL_STEP(stmts[STMT_INSERT_PAGE]);

mpage->pageid = sqlite3_last_insert_rowid(db);

sqlite3_reset(stmts[STMT_INSERT_PAGE]);

if (mustfree)

free(cp);

dba_page_add(mpage->dba, DBP_SECT, mpage->sec);

while (NULL != mlink) {

while (mlink != NULL) {

dbadd_mlink(mlink);

mlink = mlink->next;

}

mlink = mpage->mlinks;

for (key = ohash_first(&names, &slot); NULL != key;

key = ohash_next(&names, &slot)) {

assert(key->mpage == mpage);

i = 1;

dba_page_alias(mpage->dba, key->key, key->mask);

SQL_BIND_INT64(stmts[STMT_INSERT_NAME], i, key->mask);

SQL_BIND_TEXT(stmts[STMT_INSERT_NAME], i, key->key);

SQL_BIND_INT64(stmts[STMT_INSERT_NAME], i, mpage->pageid);

SQL_STEP(stmts[STMT_INSERT_NAME]);

sqlite3_reset(stmts[STMT_INSERT_NAME]);

free(key);

}

for (key = ohash_first(&strings, &slot); NULL != key;

key = ohash_next(&strings, &slot)) {

assert(key->mpage == mpage);

i = 1;

i = 0;

SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, key->mask);

for (mask = TYPE_Xr; mask <= TYPE_Lb; mask *= 2) {

SQL_BIND_TEXT(stmts[STMT_INSERT_KEY], i, key->key);

if (key->mask & mask)

SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, mpage->pageid);

dba_macro_add(dba->macros, i,

SQL_STEP(stmts[STMT_INSERT_KEY]);

key->key, mpage->dba);

sqlite3_reset(stmts[STMT_INSERT_KEY]);

i++;

}

free(key);

}

static void

dbprune(void)

dbprune(struct dba *dba)

{

struct mpage *mpage;

struct dba_array *page, *files;

struct mlink *mlink;

char *file;

size_t i;

unsigned int slot;

if (0 == nodb)

dba_array_FOREACH(dba->pages, page) {

SQL_EXEC("BEGIN TRANSACTION");

files = dba_array_get(page, DBP_FILE);

dba_array_FOREACH(files, file) {

for (mpage = ohash_first(&mpages, &slot); NULL != mpage;

if (*file < ' ')

mpage = ohash_next(&mpages, &slot)) {

file++;

mlink = mpage->mlinks;

if (ohash_find(&mlinks, ohash_qlookup(&mlinks,

if (debug)

file)) != NULL) {

say(mlink->file, "Deleting from database");

if (debug)

if (nodb)

say(file, "Deleting from database");

continue;

dba_array_del(dba->pages);

for ( ; NULL != mlink; mlink = mlink->next) {

break;

i = 1;

}

SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE],

i, mlink->dsec);

SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE],

i, mlink->arch);

SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE],

i, mlink->name);

SQL_STEP(stmts[STMT_DELETE_PAGE]);

sqlite3_reset(stmts[STMT_DELETE_PAGE]);

}

if (0 == nodb)

SQL_EXEC("END TRANSACTION");

}

* Close an existing database and its prepared statements.

* Write the database from memory to disk.

* If "real" is not set, rename the temporary file into the real one.

static void

dbclose(int real)

dbwrite(struct dba *dba)

{

size_t i;

struct stat sb1, sb2;

int status;

char tfn[33], *cp1, *cp2;

pid_t child;

off_t i;

int fd1, fd2;

if (nodb)

return;

* Do not write empty databases, and delete existing ones

* when makewhatis -u causes them to become empty.

for (i = 0; i < STMT__MAX; i++) {

dba_array_start(dba->pages);

sqlite3_finalize(stmts[i]);

if (dba_array_next(dba->pages) == NULL) {

stmts[i] = NULL;

if (unlink(MANDOC_DB) == -1 && errno != ENOENT)

say(MANDOC_DB, "&unlink");

return;

}

sqlite3_close(db);

db = NULL;

* Build the database in a temporary file,

* then atomically move it into place.

if (real)

if (dba_write(MANDOC_DB "~", dba) != -1) {

return;

if (rename(MANDOC_DB "~", MANDOC_DB) == -1) {

if ('\0' == *tempfilename) {

if (-1 == rename(MANDOC_DB "~", MANDOC_DB)) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say(MANDOC_DB, "&rename");

unlink(MANDOC_DB "~");

}

return;

}

switch (child = fork()) {

case -1:

* We lack write permission and cannot replace the database

exitcode = (int)MANDOCLEVEL_SYSERR;

* file, but let's at least check whether the data changed.

say("", "&fork cmp");

return;

case 0:

execlp("cmp", "cmp", "-s",

tempfilename, MANDOC_DB, (char *)NULL);

say("", "&exec cmp");

exit(0);

default:

break;

}

if (-1 == waitpid(child, &status, 0)) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say("", "&wait cmp");

} else if (WIFSIGNALED(status)) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say("", "cmp died from signal %d", WTERMSIG(status));

} else if (WEXITSTATUS(status)) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say(MANDOC_DB,

"Data changed, but cannot replace database");

}

*strrchr(tempfilename, '/') = '\0';

(void)strlcpy(tfn, "/tmp/mandocdb.XXXXXXXX", sizeof(tfn));

switch (child = fork()) {

if (mkdtemp(tfn) == NULL) {

case -1:

exitcode = (int)MANDOCLEVEL_SYSERR;

say("", "&fork rm");

say("", "&%s", tfn);

return;

case 0:

execlp("rm", "rm", "-rf", tempfilename, (char *)NULL);

say("", "&exec rm");

exit((int)MANDOCLEVEL_SYSERR);

default:

break;

}

if (-1 == waitpid(child, &status, 0)) {

cp1 = cp2 = MAP_FAILED;

exitcode = (int)MANDOCLEVEL_SYSERR;

fd1 = fd2 = -1;

say("", "&wait rm");

(void)strlcat(tfn, "/" MANDOC_DB, sizeof(tfn));

} else if (WIFSIGNALED(status) || WEXITSTATUS(status)) {

if (dba_write(tfn, dba) == -1) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say(tfn, "&dba_write");

say("", "%s: Cannot remove temporary directory",

goto err;

tempfilename);

}

if ((fd1 = open(MANDOC_DB, O_RDONLY, 0)) == -1) {

say(MANDOC_DB, "&open");

goto err;

* This is straightforward stuff.

* Open a database connection to a "temporary" database, then open a set

* of prepared statements we'll use over and over again.

* If "real" is set, we use the existing database; if not, we truncate a

* temporary one.

* Must be matched by dbclose().

static int

dbopen(int real)

{

const char *sql;

int rc, ofl;

if (nodb)

return 1;

*tempfilename = '\0';

ofl = SQLITE_OPEN_READWRITE;

if (real) {

rc = sqlite3_open_v2(MANDOC_DB, &db, ofl, NULL);

if (SQLITE_OK != rc) {

exitcode = (int)MANDOCLEVEL_SYSERR;

if (SQLITE_CANTOPEN != rc)

say(MANDOC_DB, "%s", sqlite3_errstr(rc));

return 0;

}

goto prepare_statements;

}

if ((fd2 = open(tfn, O_RDONLY, 0)) == -1) {

ofl |= SQLITE_OPEN_CREATE | SQLITE_OPEN_EXCLUSIVE;

say(tfn, "&open");

goto err;

remove(MANDOC_DB "~");

rc = sqlite3_open_v2(MANDOC_DB "~", &db, ofl, NULL);

if (SQLITE_OK == rc)

goto create_tables;

if (MPARSE_QUICK & mparse_options) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say(MANDOC_DB "~", "%s", sqlite3_errstr(rc));

return 0;

}

if (fstat(fd1, &sb1) == -1) {

(void)strlcpy(tempfilename, "/tmp/mandocdb.XXXXXX",

say(MANDOC_DB, "&fstat");

sizeof(tempfilename));

goto err;

if (NULL == mkdtemp(tempfilename)) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say("", "&%s", tempfilename);

return 0;

}

(void)strlcat(tempfilename, "/" MANDOC_DB,

if (fstat(fd2, &sb2) == -1) {

sizeof(tempfilename));

say(tfn, "&fstat");

rc = sqlite3_open_v2(tempfilename, &db, ofl, NULL);

goto err;

if (SQLITE_OK != rc) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say("", "%s: %s", tempfilename, sqlite3_errstr(rc));

return 0;

}

if (sb1.st_size != sb2.st_size)

create_tables:

goto err;

sql = "CREATE TABLE \"mpages\" (\n"

if ((cp1 = mmap(NULL, sb1.st_size, PROT_READ, MAP_PRIVATE,

" \"desc\" TEXT NOT NULL,\n"

fd1, 0)) == MAP_FAILED) {

" \"form\" INTEGER NOT NULL,\n"

say(MANDOC_DB, "&mmap");

" \"pageid\" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL\n"

goto err;

");\n"

"\n"

"CREATE TABLE \"mlinks\" (\n"

" \"sec\" TEXT NOT NULL,\n"

" \"arch\" TEXT NOT NULL,\n"

" \"name\" TEXT NOT NULL,\n"

" \"pageid\" INTEGER NOT NULL REFERENCES mpages(pageid) "

"ON DELETE CASCADE\n"

");\n"

"CREATE INDEX mlinks_pageid_idx ON mlinks (pageid);\n"

"\n"

"CREATE TABLE \"names\" (\n"

" \"bits\" INTEGER NOT NULL,\n"

" \"name\" TEXT NOT NULL,\n"

" \"pageid\" INTEGER NOT NULL REFERENCES mpages(pageid) "

"ON DELETE CASCADE,\n"

" UNIQUE (\"name\", \"pageid\") ON CONFLICT REPLACE\n"

");\n"

"\n"

"CREATE TABLE \"keys\" (\n"

" \"bits\" INTEGER NOT NULL,\n"

" \"key\" TEXT NOT NULL,\n"

" \"pageid\" INTEGER NOT NULL REFERENCES mpages(pageid) "

"ON DELETE CASCADE\n"

");\n"

"CREATE INDEX keys_pageid_idx ON keys (pageid);\n";

if (SQLITE_OK != sqlite3_exec(db, sql, NULL, NULL, NULL)) {

exitcode = (int)MANDOCLEVEL_SYSERR;

say(MANDOC_DB, "%s", sqlite3_errmsg(db));

sqlite3_close(db);

return 0;

}

if ((cp2 = mmap(NULL, sb2.st_size, PROT_READ, MAP_PRIVATE,

prepare_statements:

fd2, 0)) == MAP_FAILED) {

if (SQLITE_OK != sqlite3_exec(db,

say(tfn, "&mmap");

"PRAGMA foreign_keys = ON", NULL, NULL, NULL)) {

goto err;

exitcode = (int)MANDOCLEVEL_SYSERR;

say(MANDOC_DB, "PRAGMA foreign_keys: %s",

sqlite3_errmsg(db));

sqlite3_close(db);

return 0;

}

for (i = 0; i < sb1.st_size; i++)

if (cp1[i] != cp2[i])

goto err;

goto out;

sql = "DELETE FROM mpages WHERE pageid IN "

err:

"(SELECT pageid FROM mlinks WHERE "

exitcode = (int)MANDOCLEVEL_SYSERR;

"sec=? AND arch=? AND name=?)";

say(MANDOC_DB, "Data changed, but cannot replace database");

sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_DELETE_PAGE], NULL);

sql = "INSERT INTO mpages "

"(desc,form) VALUES (?,?)";

sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_PAGE], NULL);

sql = "INSERT INTO mlinks "

"(sec,arch,name,pageid) VALUES (?,?,?,?)";

sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_LINK], NULL);

sql = "SELECT bits FROM names where pageid = ?";

sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_SELECT_NAME], NULL);

sql = "INSERT INTO names "

"(bits,name,pageid) VALUES (?,?,?)";

sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_NAME], NULL);

sql = "INSERT INTO keys "

"(bits,key,pageid) VALUES (?,?,?)";

sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_KEY], NULL);

#ifndef __APPLE__

out:

if (cp1 != MAP_FAILED)

* When opening a new database, we can turn off

munmap(cp1, sb1.st_size);

* synchronous mode for much better performance.

if (cp2 != MAP_FAILED)

munmap(cp2, sb2.st_size);

if (fd1 != -1)

if (real && SQLITE_OK != sqlite3_exec(db,

close(fd1);

"PRAGMA synchronous = OFF", NULL, NULL, NULL)) {

if (fd2 != -1)

exitcode = (int)MANDOCLEVEL_SYSERR;

close(fd2);

say(MANDOC_DB, "PRAGMA synchronous: %s",

unlink(tfn);

sqlite3_errmsg(db));

*strrchr(tfn, '/') = '\0';

sqlite3_close(db);

rmdir(tfn);

return 0;

}

#endif

return 1;

}

static int

CVSweb