man/man8/cnid_dbd.8.tmpl

   1 '\" t
   2 .\"     Title: cnid_dbd
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 21 Mar 2009
   6 .\"    Manual: Netatalk 2.1
   7 .\"    Source: Netatalk 2.1
   8 .\"  Language: English
   9 .\"
  10 .TH "CNID_DBD" "8" "21 Mar 2009" "Netatalk 2.1" "Netatalk 2.1"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 cnid_dbd \- implement access to CNID databases through a dedicated daemon process
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR\ 'u
  25 \fBcnid_dbd\fR\fB\fR\fB\fR\fB\fR \fIdbdir\fR \fIctrlfd\fR \fIclntfd\fR \fIlogconfig_string\fR
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fBcnid_dbd\fR
  29 provides an interface for storage and retrieval of catalog node IDs (CNIDs) and related information to the
  30 \fBafpd\fR
  31 daemon\&. CNIDs are a component of Macintosh based file systems with semantics that map not easily onto Unix file systems\&. This makes separate storage in a database necessary\&.
  32 \fBcnid_dbd\fR
  33 is part of the
  34 \fBCNID backend\fR
  35 framework of
  36 \fBafpd\fR
  37 and implements the
  38 \fBdbd\fR
  39 backend\&.
  40 .PP
  41 \fBcnid_dbd\fR
  42 is never started via the command line or system startup scripts but only by the
  43 \fBcnid_metad\fR
  44 daemon\&. There is at most one instance of
  45 \fBcnid_dbd\fR
  46 per netatalk volume\&.
  47 .PP
  48 \fBcnid_dbd\fR
  49 uses the
  50 \fBBerkleley DB\fR
  51 database library and uses transactionally protected updates\&. The
  52 \fBdbd\fR
  53 backend with transactions will avoid corruption of the CNID database even if the system crashes unexpectedly\&.
  54 .PP
  55 \fBcnid_dbd\fR
  56 uses the same on\-disk database format as the
  57 \fBcdb\fR
  58 backend\&. It is therefore possible to switch between the two backends as necessary\&.
  59 .PP
  60 \fBcnid_dbd\fR
  61 inherits the effective userid and groupid from
  62 \fBcnid_metad\fR
  63 on startup, which is normally caused by
  64 \fBafpd\fR
  65 serving a netatalk volume to a client\&. It changes to the
  66 \fBBerkleley DB\fR
  67 database home directory
  68 \fIdbdir\fR
  69 that is associated with the volume\&. If the userid inherited from
  70 \fBcnid_metad\fR
  71 is 0 (root),
  72 \fBcnid_dbd\fR
  73 will change userid and groupid to the owner and group of the database home directory\&. Otherwise, it will continue to use the inherited values\&.
  74 \fBcnid_dbd\fR
  75 will then attempt to open the database and start serving requests using filedescriptor
  76 \fIclntfd\fR\&. Subsequent instances of
  77 \fBafpd\fR
  78 that want to access the same volume are redirected to the running
  79 \fBcnid_dbd\fR
  80 process by
  81 \fBcnid_metad\fR
  82 via the filedescriptor
  83 \fIctrlfd\fR\&.
  84 .PP
  85 \fBcnid_dbd\fR
  86 uses
  87 \fBlogconfig_string\fR
  88 which is passed from
  89 \fBcnid_metad\fR
  90 to configure its logging output\&.
  91 .PP
  92 \fBcnid_dbd\fR
  93 can be configured to run forever or to exit after a period of inactivity\&. If
  94 \fBcnid_dbd\fR
  95 receives a TERM or an INT signal it will exit cleanly after flushing dirty database buffers to disk and closing
  96 \fBBerkleley DB\fR
  97 database environments\&. It is safe to terminate
  98 \fBcnid_dbd\fR
  99 this way, it will be restarted when necessary\&. Other signals are not handled and will cause an immediate exit, possibly leaving the CNID database in an inconsistent state (no transactions) or losing recent updates during recovery (transactions)\&.
 100 .PP
 101 The
 102 \fBBerkleley DB\fR
 103 database subsystem will create files named log\&.xxxxxxxxxx in the database home directory
 104 \fIdbdir\fR, where xxxxxxxxxx is a monotonically increasing integer\&. These files contain ithe transactional database changes\&. They will be removed regularily, unless the
 105 \fBlogfile_autoremove\fR
 106 option is specified in the
 107 \fIdb_param\fR
 108 configuration file (see below)\&.
 109 .PP
 110 Do not use
 111 \fBcnid_dbd\fR
 112 for databases on NFS mounted file systems\&. It makes the whole point of securing database changes properly moot\&. Use the dbdir: Option in the appropriate
 113 \fBAppleVolumes\fR
 114 configuration file to put the database onto a local disk\&.
 115 .SH "CONFIGURATION"
 116 .PP
 117 \fBcnid_dbd\fR
 118 reads configuration information from the file
 119 \fIdb_param\fR
 120 in the database directory
 121 \fIdbdir\fR
 122 on startup\&. If the file does not exist or a parameter is not listed, suitable default values are used\&. The format for a single parameter is the parameter name, followed by one or more spaces, followed by the parameter value, followed by a newline\&. The following parameters are currently recognized:
 123 .PP
 124 \fBlogfile_autoremove\fR
 125 .RS 4
 126 If set to 0, unused Berkeley DB transactional logfiles (log\&.xxxxxxxxxx in the database home directory) are not removed on startup of
 127 \fBcnid_dbd\fR
 128 and on a reqular basis\&. Default: 1\&.
 129 .RE
 130 .PP
 131 \fBcachesize\fR
 132 .RS 4
 133 Determines the size of the Berkeley DB cache in kilobytes\&. Default: 8192\&. Each
 134 \fBcnid_dbd\fR
 135 process grabs that much memory on top of its normal memory footprint\&. It can be used to tune database performance\&. The
 136 \fBdb_stat\fR
 137 utility with the
 138 \fB\-m\fR
 139 option that comes with Berkely DB can help you determine wether you need to change this value\&. The default is pretty conservative so that a large percentage of requests should be satisfied from the cache directly\&. If memory is not a bottleneck on your system you might want to leave it at that value\&. The
 140 \fBBerkeley DB Tutorial and Reference Guide\fR
 141 has a section
 142 \fBSelecting a cache size\fR
 143 that gives more detailed information\&.
 144 .RE
 145 .PP
 146 \fBflush_frequency\fR, \fBflush_interval\fR
 147 .RS 4
 148 \fIflush_frequency\fR
 149 (Default: 1000) and
 150 \fIflush_interval\fR
 151 (Default: 1800) control how often changes to the database are checkpointed\&. Both of these operations are performed if either i) more than
 152 \fIflush_frequency\fR
 153 requests have been received or ii) more than
 154 \fIflush_interval\fR
 155 seconds have elapsed since the last save/checkpoint\&. Be careful to check your harddisk configuration for on disk cache settings\&. Many IDE disks just cache writes as the default behaviour, so even flushing database files to disk will not have the desired effect\&.
 156 .RE
 157 .PP
 158 \fBfd_table_size\fR
 159 .RS 4
 160 is the maximum number of connections (filedescriptors) that can be open for
 161 \fBafpd\fR
 162 client processes in
 163 \fBcnid_dbd\&.\fR
 164 Default: 512\&. If this number is exceeded, one of the existing connections is closed and reused\&. The affected
 165 \fBafpd\fR
 166 process will transparently reconnect later, which causes slight overhead\&. On the other hand, setting this parameter too high could affect performance in
 167 \fBcnid_dbd\fR
 168 since all descriptors have to be checked in a
 169 \fBselect()\fR
 170 system call, or worse, you might exceed the per process limit of open file descriptors on your system\&. It is safe to set the value to 1 on volumes where only one
 171 \fBafpd\fR
 172 client process is expected to run, e\&.g\&. home directories\&.
 173 .RE
 174 .PP
 175 \fBidle_timeout\fR
 176 .RS 4
 177 is the number of seconds of inactivity before an idle
 178 \fBcnid_dbd\fR
 179 exits\&. Default: 600\&. Set this to 0 to disable the timeout\&.
 180 .RE
 181 .SH "UPDATING"
 182 .PP
 183 In order to update between Netatalk releases using different BerkeleyDB library versions, follow this steps:
 184 .sp
 185 .RS 4
 186 .ie n \{\
 187 \h'-04'\(bu\h'+03'\c
 188 .\}
 189 .el \{\
 190 .sp -1
 191 .IP \(bu 2.3
 192 .\}
 193 Stop the to be upgraded old version of Netatalk
 194 .RE
 195 .sp
 196 .RS 4
 197 .ie n \{\
 198 \h'-04'\(bu\h'+03'\c
 199 .\}
 200 .el \{\
 201 .sp -1
 202 .IP \(bu 2.3
 203 .\}
 204 Using the old BerkeleyDB utilities run
 205 \fBdb_recover \-h <path to \&.AppleDB>\fR
 206 .RE
 207 .sp
 208 .RS 4
 209 .ie n \{\
 210 \h'-04'\(bu\h'+03'\c
 211 .\}
 212 .el \{\
 213 .sp -1
 214 .IP \(bu 2.3
 215 .\}
 216 Using the new BerkeleyDB utilities run
 217 \fBdb_upgrade \-v \-h <path to \&.AppleDB> \-f cnid2\&.db\fR
 218 .RE
 219 .sp
 220 .RS 4
 221 .ie n \{\
 222 \h'-04'\(bu\h'+03'\c
 223 .\}
 224 .el \{\
 225 .sp -1
 226 .IP \(bu 2.3
 227 .\}
 228 Again using the new BerkeleyDB utilities run
 229 \fBdb_checkpoint \-1 \-h <path to \&.AppleDB>\fR
 230 .RE
 231 .sp
 232 .RS 4
 233 .ie n \{\
 234 \h'-04'\(bu\h'+03'\c
 235 .\}
 236 .el \{\
 237 .sp -1
 238 .IP \(bu 2.3
 239 .\}
 240 Start the the new version of Netatalk
 241 .RE
 242 .PP
 243 Note that the first version to appear
 244 \fIafter\fR
 245 Netatalk 2\&.1 ie Netatalk 2\&.1\&.1, will support BerkeleyDB updates on the fly without manual intervention\&. In other words Netatalk 2\&.1 does contain code to prepare the BerkeleyDB database for upgrades and to upgrade it in case it has been prepared before\&. That means it can\'t upgrade a 2\&.0\&.x version because that one didn\'t prepare the database\&.
 246 .SH "SEE ALSO"
 247 .PP
 248 \fBcnid_metad\fR(8),
 249 \fBafpd\fR(8),
 250 \fBdbd\fR(1)