[BACK]Return to cdbw.3 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / lib / libc / cdb
File: [cvs.NetBSD.org] / src / lib / libc / cdb / cdbw.3 (download)

Revision 1.3.8.1, Sat Jun 23 22:54:58 2012 UTC (11 years, 9 months ago) by riz
Branch: netbsd-6
CVS Tags: netbsd-6-1-RELEASE, netbsd-6-1-RC4, netbsd-6-1-RC3, netbsd-6-1-RC2, netbsd-6-1-RC1, netbsd-6-1-5-RELEASE, netbsd-6-1-4-RELEASE, netbsd-6-1-3-RELEASE, netbsd-6-1-2-RELEASE, netbsd-6-1-1-RELEASE, netbsd-6-1, netbsd-6-0-RELEASE, netbsd-6-0-RC2, netbsd-6-0-RC1, netbsd-6-0-6-RELEASE, netbsd-6-0-5-RELEASE, netbsd-6-0-4-RELEASE, netbsd-6-0-3-RELEASE, netbsd-6-0-2-RELEASE, netbsd-6-0-1-RELEASE, netbsd-6-0, matt-nb6-plus-nbase, matt-nb6-plus-base, matt-nb6-plus
Changes since 1.3: +13 -3 lines 

Pull up following revision(s) (requested by joerg in ticket #328):
	lib/libc/gen/devname.c: revision 1.22
	distrib/sparc64/instfs/dot.profile: revision 1.7
	distrib/i386/cdroms/install.sh: revision 1.3
	tests/lib/libcurses/director/director.c: revision 1.10
	lib/libc/include/reentrant.h: revision 1.15
	distrib/amd64/cdroms/install.sh: revision 1.3
	tests/include/t_paths.c: revision 1.12
	share/man/man7/hier.7: revision 1.101
	etc/rc.d/sysdb: revision 1.24
	include/stdlib.h: revision 1.99
	tests/lib/libcurses/Makefile: revision 1.3
	distrib/sparc64/cdroms/installcd/install.sh: revision 1.3
	distrib/i386/cdroms/Makefile.cdrom: revision 1.27
	lib/libc/gen/ttyname.c: revision 1.25
	usr.bin/tic/Makefile: revision 1.2
	tools/compat/Makefile: revision 1.57
	lib/libterminfo/compile.c: revision 1.7
	lib/libc/gen/ttyname.c: revision 1.26
	lib/libterminfo/compile.c: revision 1.8
	tools/compat/Makefile: revision 1.59
	tools/compat/cdbw.h: revision 1.1
	distrib/i386/installimage/install.sh: revision 1.2
	lib/libc/include/namespace.h: revision 1.154
	usr.bin/tic/tic.c: revision 1.13
	usr.bin/tic/tic.c: revision 1.14
	usr.bin/tic/tic.c: revision 1.15
	distrib/sets/lists/base/mi: revision 1.996
	usr.bin/tic/tic.c: revision 1.16
	usr.sbin/dev_mkdb/dev_mkdb.8: revision 1.13
	usr.bin/tic/tic.c: revision 1.17
	usr.bin/tic/tic.c: revision 1.18
	tools/compat/cdbr.h: revision 1.1
	distrib/sparc64/instfs/list: revision 1.25
	usr.bin/tic/tic.c: revision 1.19
	lib/libc/cdb/cdbw.c: revision 1.4
	lib/libc/cdb/cdbw.3: revision 1.4
	lib/libc/cdb/cdbw.3: revision 1.5
	share/terminfo/Makefile: revision 1.3
	usr.sbin/dev_mkdb/dev_mkdb.c: revision 1.29
	usr.sbin/dev_mkdb/Makefile: revision 1.8
	lib/libc/gen/ttyname.3: revision 1.23
	lib/libc/gen/ttyname.3: revision 1.24
	lib/libc/cdb/cdbr.c: revision 1.3
	include/cdbw.h: revision 1.2
	distrib/sparc64/cdroms/installcd/Makefile: revision 1.15
	lib/libc/gen/devname.3: revision 1.12
	tools/compat/compat_defs.h: revision 1.85
	tools/compat/compat_defs.h: revision 1.86
	lib/libterminfo/term_private.h: revision 1.10
	lib/libterminfo/term.c: revision 1.14
	usr.bin/tic/tic.1: revision 1.10
	lib/libterminfo/term.c: revision 1.15
	lib/libterminfo/Makefile.hash: revision 1.5
	lib/libterminfo/term.c: revision 1.16
	distrib/amd64/installimage/install.sh: revision 1.2
	share/man/man5/rc.conf.5: revision 1.152
	distrib/sets/lists/tests/mi: revision 1.472
	distrib/amd64/cdroms/Makefile.cdrom: revision 1.7
	include/paths.h: revision 1.41
	bin/ps/ps.1: revision 1.101
	lib/libterminfo/terminfo.5.in: revision 1.16
	usr.bin/tic/tic.c: revision 1.20
	lib/libterminfo/terminfo.5.in: revision 1.17
Prefer __printflike.
Use queue(3)
Replace linear lookup with hash table, reducing runtime by 60%.
Use e* from util.h.
One more strdup -> estrdup.
Maintain nalias and nterm on the fly.
Add void for ttyslot prototype.
Use memcmp in place of strncmp, since length is known to no longer than
either of the arguments.
Fix a number of memory leaks. Keep final loop of the cleanup in tic(1)
under #ifdef __VALGRIND__ though.
Add __predict_true / __predict_false definitions.
Add a special seeder for cdbw_output that gives stable results.
Hook up cdbw(3) for the tool build.
Prototype for cdbw_stable_seeder.
Provide a usable thr_once for !_REENTRANT
Switch device database to cdb(5). Rework ttyname(3) and ttyname_r(3) to
depend on new devname_r(3) as heart. Add /dev/pts magic directly to
devname(3). While it can lead to returning non-existing paths, the
behavior is more consistent that way. Drop caching layer in devname(3),
it doesn't buy anything for the common case of having access to the
database. Teach devname(3) proper fallback behavior of scanning /dev.
Create both old-style and new-style database for now in /etc/rc.d/sysdb.
Switch terminfo(3) to cdb(5).
Fix typos.
Make Alan Barrett happy and add ().
Add cdbr(3) support to tools/compat.
Bump date for previous.
Relax consistency to make it possible to match valid entries.
Prefix devname's buffer with /dev/ as ttyname is supposed to return the
full path. Reported by Dave Huang.

.\"	$NetBSD: cdbw.3,v 1.3.8.1 2012/06/23 22:54:58 riz Exp $
.\"
.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Joerg Sonnenberger.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.Dd June 3, 2012
.Dt CDBW 3
.Os
.Sh NAME
.Nm cdbw_open ,
.Nm cdbw_put ,
.Nm cdbw_put_data ,
.Nm cdbw_put_key ,
.Nm cdbw_stable_seeder ,
.Nm cdbw_output ,
.Nm cdbw_close
.Nd create constant databases
.Sh SYNOPSIS
.In archive_entry.h
.Ft "struct cdbw *"
.Fn cdbw_open "void"
.Ft int
.Fo cdbw_put
.Fa "struct cdbw *cdbw"
.Fa "const void *key"
.Fa "size_t keylen"
.Fa "const void *data"
.Fa "size_t datalen"
.Fc
.Ft int
.Fo cdbw_put_data
.Fa "struct cdbw *cdbw"
.Fa "const void *data"
.Fa "size_t datalen"
.Fa "uint32_t *index"
.Fc
.Ft int
.Fo cdbw_put_key
.Fa "struct cdbw *cdbw"
.Fa "const void *key"
.Fa "size_t keylen"
.Fa "uint32_t index"
.Fc
.Ft uint32_t
.Fo cdbw_stable_seeder
.Fa "void"
.Fc
.Ft int
.Fo cdbw_output
.Fa "struct cdbw *cdbw"
.Fa "int output"
.Fa "const char descr[16]"
.Fa "uint32_t (*seedgen)(void)"
.Fc
.Ft void
.Fn cdbw_close "struct cdbw *cdbw"
.Sh DESCRIPTION
The
.Nm cdbw
functions are used to create a constant databases for use with
.Xr cdbr 3 .
Details about the file format, including overhead and limitations,
can be found in
.Xr cdb 5 .
.Pp
.Fn cdbw_open
prepares a new
.Nm cdb
writer.
The function returns a handle to pass to the other functions.
.Pp
.Fn cdbw_close
frees all resources associated with the handle.
.Pp
.Fn cdbw_put
adds the given (key,value) pair after checking for a duplicate key.
.Fn cdbw_put_data
adds the given value to the writer without adding a key reference.
The returned index can be used in subsequent calls to
.Fn cdbw_put_key
to add one or more keys pointing to this value.
.Fn cdbw_put_key
checks for duplicate keys and valid index arguments.
On success it adds the given key.
.Pp
.Fn cdbw_output
computes the database file and writes it to the given descriptor.
The function returns an error if the file cannot be written correctly.
The
.Fn descr
parameter provides a human readable description of the database content.
The
.Fn seedgen
parameter can be used to override the default PRNG.
The bitwise layout of the output depends on the chosen seed.
The function should return a different value for each invocation.
The
.Fn cdbw_stable_seeder
can be used to create reproducible output.
It may be slower than the default.
.Sh SEE ALSO
.Xr cdbr 3 ,
.Xr cdb 5
.Sh HISTORY
Support for the
.Nm cdb
format first appeared in
.Nx 6.0 .
.Sh AUTHORS
The
.Nm cdbr
and
.Nm cdbw
functions have been written by
.An Joerg Sonnenberger Aq joerg@NetBSD.org .