tzsetup: Fix VERBOSE reporting when removing _PATH_LOCALTIME for UTC.
[dragonfly.git] / include / rpcsvc / ypxfrd.x
CommitLineData
984263bc
MD
1/*
2 * Copyright (c) 1995, 1996
3 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * $FreeBSD: src/include/rpcsvc/ypxfrd.x,v 1.7 1999/08/27 23:45:13 peter Exp $
1de703da 33 * $DragonFly: src/include/rpcsvc/ypxfrd.x,v 1.2 2003/06/17 04:25:58 dillon Exp $
984263bc
MD
34 */
35
36/*
37 * This protocol definition file describes a file transfer
38 * system used to very quickly move NIS maps from one host to
39 * another. This is similar to what Sun does with their ypxfrd
40 * protocol, but it must be stressed that this protocol is _NOT_
41 * compatible with Sun's. There are a couple of reasons for this:
42 *
43 * 1) Sun's protocol is proprietary. The protocol definition is
44 * not freely available in any of the SunRPC source distributions,
45 * even though the NIS v2 protocol is.
46 *
47 * 2) The idea here is to transfer entire raw files rather than
48 * sending just the records. Sun uses ndbm for its NIS map files,
49 * while FreeBSD uses Berkeley DB. Both are hash databases, but the
50 * formats are incompatible, making it impossible for them to
51 * use each others' files. Even if FreeBSD adopted ndbm for its
52 * database format, FreeBSD/i386 is a little-endian OS and
53 * SunOS/SPARC is big-endian; ndbm is byte-order sensitive and
54 * not very smart about it, which means an attempt to read a
55 * database on a little-endian box that was created on a big-endian
56 * box (or vice-versa) can cause the ndbm code to eat itself.
57 * Luckily, Berkeley DB is able to deal with this situation in
58 * a more graceful manner.
59 *
60 * While the protocol is incompatible, the idea is the same: we just open
61 * up a TCP pipe to the client and transfer the raw map database
62 * from the master server to the slave. This is many times faster than
63 * the standard yppush/ypxfr transfer method since it saves us from
64 * having to recreate the map databases via the DB library each time.
65 * For example: creating a passwd database with 30,000 entries with yp_mkdb
66 * can take a couple of minutes, but to just copy the file takes only a few
67 * seconds.
68 */
69
984263bc
MD
70/* XXX cribbed from yp.x */
71const _YPMAXRECORD = 1024;
72const _YPMAXDOMAIN = 64;
73const _YPMAXMAP = 64;
74const _YPMAXPEER = 64;
75
76/* Suggested default -- not necesarrily the one used. */
77const YPXFRBLOCK = 32767;
78
79/*
80 * Possible return codes from the remote server.
81 */
82enum xfrstat {
83 XFR_REQUEST_OK = 1, /* Transfer request granted */
84 XFR_DENIED = 2, /* Transfer request denied */
85 XFR_NOFILE = 3, /* Requested map file doesn't exist */
86 XFR_ACCESS = 4, /* File exists, but I couldn't access it */
87 XFR_BADDB = 5, /* File is not a hash database */
88 XFR_READ_OK = 6, /* Block read successfully */
89 XFR_READ_ERR = 7, /* Read error during transfer */
90 XFR_DONE = 8, /* Transfer completed */
91 XFR_DB_ENDIAN_MISMATCH = 9, /* Database byte order mismatch */
92 XFR_DB_TYPE_MISMATCH = 10 /* Database type mismatch */
93};
94
95/*
96 * Database type specifications. The client can use this to ask
97 * the server for a particular type of database or just take whatever
98 * the server has to offer.
99 */
100enum xfr_db_type {
101 XFR_DB_ASCII = 1, /* Flat ASCII text */
102 XFR_DB_BSD_HASH = 2, /* Berkeley DB, hash method */
103 XFR_DB_BSD_BTREE = 3, /* Berkeley DB, btree method */
104 XFR_DB_BSD_RECNO = 4, /* Berkeley DB, recno method */
105 XFR_DB_BSD_MPOOL = 5, /* Berkeley DB, mpool method */
106 XFR_DB_BSD_NDBM = 6, /* Berkeley DB, hash, ndbm compat */
107 XFR_DB_GNU_GDBM = 7, /* GNU GDBM */
108 XFR_DB_DBM = 8, /* Old, deprecated dbm format */
109 XFR_DB_NDBM = 9, /* ndbm format (used by Sun's NISv2) */
110 XFR_DB_OPAQUE = 10, /* Mystery format -- just pass along */
111 XFR_DB_ANY = 11, /* I'll take any format you've got */
112 XFR_DB_UNKNOWN = 12 /* Unknown format */
113};
114
115/*
116 * Machine byte order specification. This allows the client to check
117 * that it's copying a map database from a machine of similar byte sex.
118 * This is necessary for handling database libraries that are fatally
119 * byte order sensitive.
120 *
121 * The XFR_ENDIAN_ANY type is for use with the Berkeley DB database
122 * formats; Berkeley DB is smart enough to make up for byte order
123 * differences, so byte sex isn't important.
124 */
125enum xfr_byte_order {
126 XFR_ENDIAN_BIG = 1, /* We want big endian */
127 XFR_ENDIAN_LITTLE = 2, /* We want little endian */
128 XFR_ENDIAN_ANY = 3 /* We'll take whatever you got */
129};
130
131typedef string xfrdomain<_YPMAXDOMAIN>;
132typedef string xfrmap<_YPMAXMAP>;
133typedef string xfrmap_filename<_YPMAXMAP>; /* actual name of map file */
134
135/*
136 * Ask the remote ypxfrd for a map using this structure.
137 * Note: we supply both a map name and a map file name. These are not
138 * the same thing. In the case of ndbm, maps are stored in two files:
139 * map.bykey.pag and may.bykey.dir. We may also have to deal with
140 * file extensions (on the off chance that the remote server is supporting
141 * multiple DB formats). To handle this, we tell the remote server both
142 * what map we want and, in the case of ndbm, whether we want the .dir
143 * or the .pag part. This name should not be a fully qualified path:
144 * it's up to the remote server to decide which directories to look in.
145 */
146struct ypxfr_mapname {
147 xfrmap xfrmap;
148 xfrdomain xfrdomain;
149 xfrmap_filename xfrmap_filename;
150 xfr_db_type xfr_db_type;
151 xfr_byte_order xfr_byte_order;
152};
153
154/* Read response using this structure. */
155union xfr switch (bool ok) {
156case TRUE:
157 opaque xfrblock_buf<>;
158case FALSE:
159 xfrstat xfrstat;
160};
161
162program YPXFRD_FREEBSD_PROG {
163 version YPXFRD_FREEBSD_VERS {
164 union xfr
165 YPXFRD_GETMAP(ypxfr_mapname) = 1;
166 } = 1;
167} = 600100069; /* 100069 + 60000000 -- 100069 is the Sun ypxfrd prog number */