tzsetup: Fix VERBOSE reporting when removing _PATH_LOCALTIME for UTC.
[dragonfly.git] / include / rpcsvc / yp_prot.h
CommitLineData
984263bc
MD
1/*
2 * Copyright (c) 1992/3 Theo de Raadt <deraadt@fsa.ca>
3 * 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. The name of the author may not be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
18 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
ce0e08e2 29 * $FreeBSD: src/include/rpcsvc/yp_prot.h,v 1.13 2005/12/06 02:01:06 peter Exp $
13db7107 30 * $DragonFly: src/include/rpcsvc/yp_prot.h,v 1.3 2004/12/15 09:44:47 dillon Exp $
984263bc
MD
31 */
32
33#ifndef _RPCSVC_YP_PROT_H_
34#define _RPCSVC_YP_PROT_H_
35
36/*
37 * YPSERV PROTOCOL:
38 *
39 * ypserv supports the following procedures:
40 *
41 * YPPROC_NULL takes (void), returns (void).
42 * called to check if server is alive.
43 * YPPROC_DOMAIN takes (char *), returns (bool_t).
44 * true if ypserv serves the named domain.
45 * YPPROC_DOMAIN_NOACK takes (char *), returns (bool_t).
46 * true if ypserv serves the named domain.
47 * used for broadcasts, does not ack if ypserv
48 * doesn't handle named domain.
49 * YPPROC_MATCH takes (struct ypreq_key), returns (struct ypresp_val)
50 * does a lookup.
51 * YPPROC_FIRST takes (struct ypreq_nokey) returns (ypresp_key_val).
52 * gets the first key/datum from the map.
53 * YPPROC_NEXT takes (struct ypreq_key) returns (ypresp_key_val).
54 * gets the next key/datum from the map.
55 * YPPROC_XFR takes (struct ypreq_xfr), returns (void).
56 * tells ypserv to check if there is a new version of
57 * the map.
58 * YPPROC_CLEAR takes (void), returns (void).
59 * tells ypserv to flush it's file cache, so that
60 * newly transferred files will get read.
61 * YPPROC_ALL takes (struct ypreq_nokey), returns (bool_t and
62 * struct ypresp_key_val).
63 * returns an array of data, with the bool_t being
64 * false on the last datum. read the source, it's
65 * convoluted.
66 * YPPROC_MASTER takes (struct ypreq_nokey), returns (ypresp_master).
67 * YPPROC_ORDER takes (struct ypreq_nokey), returns (ypresp_order).
68 * YPPROC_MAPLIST takes (char *), returns (struct ypmaplist *).
69 */
70
984263bc
MD
71/* Program and version symbols, magic numbers */
72
73#define YPPROG ((u_long)100004)
74#define YPVERS ((u_long)2)
75#define YPVERS_ORIG ((u_long)1)
76#define YPMAXRECORD ((u_long)1024)
77#define YPMAXDOMAIN ((u_long)64)
78#define YPMAXMAP ((u_long)64)
79#define YPMAXPEER ((u_long)256)
80
81/*
82 * I don't know if anything of sun's depends on this, or if they
83 * simply defined it so that their own code wouldn't try to send
84 * packets over the ethernet MTU. This YP code doesn't use it.
85 */
86#define YPMSGSZ 1600
87
88#ifndef DATUM
89typedef struct {
90 char *dptr;
91 int dsize;
92} datum;
93#define DATUM
94#endif
95
96struct ypmap_parms {
97 char *domain;
98 char *map;
ce0e08e2 99 u_int ordernum;
984263bc
MD
100 char *owner;
101};
102
103struct ypreq_key {
104 char *domain;
105 char *map;
106 datum keydat;
107};
108
109struct ypreq_nokey {
110 char *domain;
111 char *map;
112};
113
114struct ypreq_xfr {
115 struct ypmap_parms map_parms;
ce0e08e2
PA
116 u_int transid;
117 u_int proto;
118 u_int port;
984263bc
MD
119};
120#define ypxfr_domain map_parms.domain
121#define ypxfr_map map_parms.map
122#define ypxfr_ordernum map_parms.ordernum
123#define ypxfr_owner map_parms.owner
124
125struct ypresp_val {
ce0e08e2 126 u_int status;
984263bc
MD
127 datum valdat;
128};
129
130struct ypresp_key_val {
ce0e08e2 131 u_int status;
984263bc
MD
132 datum keydat;
133 datum valdat;
134};
135
136struct ypresp_master {
ce0e08e2 137 u_int status;
984263bc
MD
138 char *master;
139};
140
141struct ypresp_order {
ce0e08e2
PA
142 u_int status;
143 u_int ordernum;
984263bc
MD
144};
145
146struct ypmaplist {
ce0e08e2 147 char *ypml_name;
984263bc
MD
148 struct ypmaplist *ypml_next;
149};
150
151struct ypresp_maplist {
ce0e08e2 152 u_int status;
984263bc
MD
153 struct ypmaplist *list;
154};
155
156/* ypserv procedure numbers */
157#define YPPROC_NULL ((u_long)0)
158#define YPPROC_DOMAIN ((u_long)1)
159#define YPPROC_DOMAIN_NONACK ((u_long)2)
160#define YPPROC_MATCH ((u_long)3)
161#define YPPROC_FIRST ((u_long)4)
162#define YPPROC_NEXT ((u_long)5)
163#define YPPROC_XFR ((u_long)6)
164#define YPPROC_CLEAR ((u_long)7)
165#define YPPROC_ALL ((u_long)8)
166#define YPPROC_MASTER ((u_long)9)
167#define YPPROC_ORDER ((u_long)10)
168#define YPPROC_MAPLIST ((u_long)11)
169
170/* ypserv procedure return status values */
171#define YP_TRUE ((long)1) /* general purpose success code */
172#define YP_NOMORE ((long)2) /* no more entries in map */
173#define YP_FALSE ((long)0) /* general purpose failure code */
174#define YP_NOMAP ((long)-1) /* no such map in domain */
175#define YP_NODOM ((long)-2) /* domain not supported */
176#define YP_NOKEY ((long)-3) /* no such key in map */
177#define YP_BADOP ((long)-4) /* invalid operation */
178#define YP_BADDB ((long)-5) /* server data base is bad */
179#define YP_YPERR ((long)-6) /* YP server error */
180#define YP_BADARGS ((long)-7) /* request arguments bad */
181#define YP_VERS ((long)-8) /* YP server version mismatch */
182
183/*
184 * Sun's header file says:
185 * "Domain binding data structure, used by ypclnt package and ypserv modules.
186 * Users of the ypclnt package (or of this protocol) don't HAVE to know about
187 * it, but it must be available to users because _yp_dobind is a public
188 * interface."
189 *
190 * This is totally bogus! Nowhere else does Sun state that _yp_dobind() is
191 * a public interface, and I don't know any reason anyone would want to call
192 * it. But, just in case anyone does actually expect it to be available..
193 * we provide this.. exactly as Sun wants it.
194 */
195struct dom_binding {
196 struct dom_binding *dom_pnext;
197 char dom_domain[YPMAXDOMAIN + 1];
198 struct sockaddr_in dom_server_addr;
199 u_short dom_server_port;
200 int dom_socket;
201 CLIENT *dom_client;
202 u_short dom_local_port;
203 long dom_vers;
204};
205
206/*
207 * YPBIND PROTOCOL:
208 *
209 * ypbind supports the following procedures:
210 *
211 * YPBINDPROC_NULL takes (void), returns (void).
212 * to check if ypbind is running.
213 * YPBINDPROC_DOMAIN takes (char *), returns (struct ypbind_resp).
214 * requests that ypbind start to serve the
215 * named domain (if it doesn't already)
216 * YPBINDPROC_SETDOM takes (struct ypbind_setdom), returns (void).
217 * used by ypset.
218 */
219
220#define YPBINDPROG ((u_long)100007)
221#define YPBINDVERS ((u_long)2)
222#define YPBINDVERS_ORIG ((u_long)1)
223
224/* ypbind procedure numbers */
225#define YPBINDPROC_NULL ((u_long)0)
226#define YPBINDPROC_DOMAIN ((u_long)1)
227#define YPBINDPROC_SETDOM ((u_long)2)
228
229/* error code in ypbind_resp.ypbind_status */
230enum ypbind_resptype {
231 YPBIND_SUCC_VAL = 1,
232 YPBIND_FAIL_VAL = 2
233};
234
235/* network order, of course */
236struct ypbind_binding {
237 struct in_addr ypbind_binding_addr;
238 u_short ypbind_binding_port;
239};
240
241struct ypbind_resp {
242 enum ypbind_resptype ypbind_status;
243 union {
ce0e08e2 244 u_int ypbind_error;
984263bc
MD
245 struct ypbind_binding ypbind_bindinfo;
246 } ypbind_respbody;
247};
248
249/* error code in ypbind_resp.ypbind_respbody.ypbind_error */
250#define YPBIND_ERR_ERR 1 /* internal error */
251#define YPBIND_ERR_NOSERV 2 /* no bound server for passed domain */
252#define YPBIND_ERR_RESC 3 /* system resource allocation failure */
253
254/*
255 * Request data structure for ypbind "Set domain" procedure.
256 */
257struct ypbind_setdom {
258 char ypsetdom_domain[YPMAXDOMAIN + 1];
259 struct ypbind_binding ypsetdom_binding;
ce0e08e2 260 u_int ypsetdom_vers;
984263bc
MD
261};
262#define ypsetdom_addr ypsetdom_binding.ypbind_binding_addr
263#define ypsetdom_port ypsetdom_binding.ypbind_binding_port
264
265/*
266 * YPPUSH PROTOCOL:
267 *
268 * Sun says:
269 * "Protocol between clients (ypxfr, only) and yppush
270 * yppush speaks a protocol in the transient range, which
271 * is supplied to ypxfr as a command-line parameter when it
272 * is activated by ypserv."
273 *
274 * This protocol is not implemented, naturally, because this YP
275 * implementation only does the client side.
276 */
277#define YPPUSHVERS ((u_long)1)
278#define YPPUSHVERS_ORIG ((u_long)1)
279
280/* yppush procedure numbers */
281#define YPPUSHPROC_NULL ((u_long)0)
282#define YPPUSHPROC_XFRRESP ((u_long)1)
283
284struct yppushresp_xfr {
ce0e08e2
PA
285 u_int transid;
286 u_int status;
984263bc
MD
287};
288
289/* yppush status value in yppushresp_xfr.status */
290#define YPPUSH_SUCC ((long)1) /* Success */
291#define YPPUSH_AGE ((long)2) /* Master's version not newer */
292#define YPPUSH_NOMAP ((long)-1) /* Can't find server for map */
293#define YPPUSH_NODOM ((long)-2) /* Domain not supported */
294#define YPPUSH_RSRC ((long)-3) /* Local resource alloc failure */
295#define YPPUSH_RPC ((long)-4) /* RPC failure talking to server */
296#define YPPUSH_MADDR ((long)-5) /* Can't get master address */
297#define YPPUSH_YPERR ((long)-6) /* YP server/map db error */
298#define YPPUSH_BADARGS ((long)-7) /* Request arguments bad */
299#define YPPUSH_DBM ((long)-8) /* Local dbm operation failed */
300#define YPPUSH_FILE ((long)-9) /* Local file I/O operation failed */
301#define YPPUSH_SKEW ((long)-10) /* Map version skew during transfer */
302#define YPPUSH_CLEAR ((long)-11) /* Can't send "Clear" req to local ypserv */
303#define YPPUSH_FORCE ((long)-12) /* No local order number in map - use -f */
304#define YPPUSH_XFRERR ((long)-13) /* ypxfr error */
305#define YPPUSH_REFUSED ((long)-14) /* Transfer request refused by ypserv */
306
307struct inaddr;
308__BEGIN_DECLS
309bool_t xdr_datum(XDR *, datum *);
310bool_t xdr_ypreq_key(XDR *, struct ypreq_key *);
311bool_t xdr_ypreq_nokey(XDR *, struct ypreq_nokey *);
312bool_t xdr_ypreq_xfr(XDR *, struct ypreq_xfr *);
313bool_t xdr_ypresp_val(XDR *, struct ypresp_val *);
314bool_t xdr_ypresp_key_val(XDR *, struct ypresp_key_val *);
315bool_t xdr_ypbind_resp(XDR *, struct ypbind_resp *);
316bool_t xdr_ypbind_setdom(XDR *, struct ypbind_setdom *);
317bool_t xdr_yp_inaddr(XDR *, struct inaddr *);
318bool_t xdr_ypmap_parms(XDR *, struct ypmap_parms *);
319bool_t xdr_yppushresp_xfr(XDR *, struct yppushresp_xfr *);
320bool_t xdr_ypresp_order(XDR *, struct ypresp_order *);
321bool_t xdr_ypresp_master(XDR *, struct ypresp_master *);
322bool_t xdr_ypresp_maplist(XDR *, struct ypresp_maplist *);
323__END_DECLS
324
325#endif /* _RPCSVC_YP_PROT_H_ */