ypxfrd.x revision 16119 
168673Sobrien/*
268673Sobrien * Copyright (c) 1995, 1996
368673Sobrien *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
468673Sobrien *
568673Sobrien * Redistribution and use in source and binary forms, with or without
668673Sobrien * modification, are permitted provided that the following conditions
768673Sobrien * are met:
868673Sobrien * 1. Redistributions of source code must retain the above copyright
968673Sobrien *    notice, this list of conditions and the following disclaimer.
1068673Sobrien * 2. Redistributions in binary form must reproduce the above copyright
1168673Sobrien *    notice, this list of conditions and the following disclaimer in the
1268673Sobrien *    documentation and/or other materials provided with the distribution.
1368673Sobrien * 3. All advertising materials mentioning features or use of this software
1468673Sobrien *    must display the following acknowledgement:
1568673Sobrien *	This product includes software developed by Bill Paul.
1668673Sobrien * 4. Neither the name of the author nor the names of any co-contributors
1768673Sobrien *    may be used to endorse or promote products derived from this software
1868673Sobrien *    without specific prior written permission.
1968673Sobrien *
2068673Sobrien * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
2168673Sobrien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2268673Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2368673Sobrien * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR CONTRIBUTORS BE LIABLE
2468673Sobrien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2568673Sobrien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2668673Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2768673Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2868673Sobrien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2968673Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3068673Sobrien * SUCH DAMAGE.
3168673Sobrien *
3268673Sobrien *	$Id: ypxfrd.x,v 1.8 1996/06/03 20:17:04 wpaul Exp $
3368673Sobrien */
3468673Sobrien
3568673Sobrien/*
3668673Sobrien * This protocol definition file describes a file transfer
3768673Sobrien * system used to very quickly move NIS maps from one host to
3868673Sobrien * another. This is similar to what Sun does with their ypxfrd
3968673Sobrien * protocol, but it must be stressed that this protocol is _NOT_
4068673Sobrien * compatible with Sun's. There are a couple of reasons for this:
4168673Sobrien *
4268673Sobrien * 1) Sun's protocol is proprietary. The protocol definition is
4368673Sobrien *    not freely available in any of the SunRPC source distributions,
4468673Sobrien *    even though the NIS v2 protocol is.
4568673Sobrien *
46 * 2) The idea here is to transfer entire raw files rather than
47 *    sending just the records. Sun uses ndbm for its NIS map files,
48 *    while FreeBSD uses Berkeley DB. Both are hash databases, but the
49 *    formats are incompatible, making it impossible for them to
50 *    use each others' files. Even if FreeBSD adopted ndbm for its
51 *    database format, FreeBSD/i386 is a little-endian OS and
52 *    SunOS/SPARC is big-endian; ndbm is byte-order sensitive and
53 *    not very smart about it, which means an attempt to read a
54 *    database on a little-endian box that was created on a big-endian
55 *    box (or vice-versa) can cause the ndbm code to eat itself.
56 *    Luckily, Berkeley DB is able to deal with this situation in
57 *    a more graceful manner.
58 *
59 * While the protocol is incompatible, the idea is the same: we just open
60 * up a TCP pipe to the client and transfer the raw map database
61 * from the master server to the slave. This is many times faster than
62 * the standard yppush/ypxfr transfer method since it saves us from
63 * having to recreate the map databases via the DB library each time.
64 * For example: creating a passwd database with 30,000 entries with yp_mkdb
65 * can take a couple of minutes, but to just copy the file takes only a few
66 * seconds.
67 */
68
69#ifndef RPC_HDR
70%#ifndef lint
71%static const char rcsid[] = "$Id: ypxfrd.x,v 1.8 1996/06/03 20:17:04 wpaul Exp $";
72%#endif /* not lint */
73#endif
74
75/* XXX cribbed from yp.x */
76const _YPMAXRECORD = 1024;
77const _YPMAXDOMAIN = 64;
78const _YPMAXMAP = 64;
79const _YPMAXPEER = 64;
80
81/* Suggested default -- not necesarrily the one used. */
82const YPXFRBLOCK = 32767;
83
84enum xfrstat {
85	XFR_REQUEST_OK	= 1,	/* Transfer request granted */
86	XFR_DENIED	= 2,	/* Transfer request denied */
87	XFR_NOFILE	= 3,	/* Requested map file doesn't exist */
88	XFR_ACCESS	= 4,	/* File exists, but I couldn't access it */
89	XFR_BADDB	= 5,	/* File is not a hash database */
90	XFR_READ_OK	= 6,	/* Block read successfully */
91	XFR_READ_ERR	= 7,	/* Read error during transfer */
92	XFR_DONE	= 8	/* Transfer completed */
93};
94
95typedef string xfrdomain<_YPMAXDOMAIN>;
96typedef string xfrmap<_YPMAXMAP>;
97
98/* Ask the remote ypxfrd for a map using this structure */
99struct ypxfr_mapname {
100	xfrmap xfrmap;
101	xfrdomain xfrdomain;
102};
103
104/* Read response using this structure. */
105union xfr switch (bool ok) {
106case TRUE:
107	opaque xfrblock_buf<>;
108case FALSE:
109	enum xfrstat xfrstat;
110};
111
112program YPXFRD_FREEBSD_PROG {
113	version YPXFRD_FREEBSD_VERS {
114		union xfr
115		YPXFRD_GETMAP(ypxfr_mapname) = 1;
116	} = 1;
117} = 600100069;	/* 100069 + 60000000 -- 100069 is the Sun ypxfrd prog number */
118