xref: /freebsd/sys/rpc/pmap_prot.h (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1 /*	$NetBSD: pmap_prot.h,v 1.8 2000/06/02 22:57:55 fvdl Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (c) 2009, Sun Microsystems, Inc.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are met:
11  * - Redistributions of source code must retain the above copyright notice,
12  *   this list of conditions and the following disclaimer.
13  * - Redistributions in binary form must reproduce the above copyright notice,
14  *   this list of conditions and the following disclaimer in the documentation
15  *   and/or other materials provided with the distribution.
16  * - Neither the name of Sun Microsystems, Inc. nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * pmap_prot.h
35  * Protocol for the local binder service, or pmap.
36  *
37  * Copyright (C) 1984, Sun Microsystems, Inc.
38  *
39  * The following procedures are supported by the protocol:
40  *
41  * PMAPPROC_NULL() returns ()
42  * 	takes nothing, returns nothing
43  *
44  * PMAPPROC_SET(struct portmap) returns (bool_t)
45  * 	TRUE is success, FALSE is failure.  Registers the tuple
46  *	[prog, vers, prot, port].
47  *
48  * PMAPPROC_UNSET(struct portmap) returns (bool_t)
49  *	TRUE is success, FALSE is failure.  Un-registers pair
50  *	[prog, vers].  prot and port are ignored.
51  *
52  * PMAPPROC_GETPORT(struct portmap) returns (long unsigned).
53  *	0 is failure.  Otherwise returns the port number where the pair
54  *	[prog, vers] is registered.  It may lie!
55  *
56  * PMAPPROC_DUMP() RETURNS (struct pmaplist *)
57  *
58  * PMAPPROC_CALLIT(unsigned, unsigned, unsigned, string<>)
59  * 	RETURNS (port, string<>);
60  * usage: encapsulatedresults = PMAPPROC_CALLIT(prog, vers, proc, encapsulatedargs);
61  * 	Calls the procedure on the local machine.  If it is not registered,
62  *	this procedure is quite; ie it does not return error information!!!
63  *	This procedure only is supported on rpc/udp and calls via
64  *	rpc/udp.  This routine only passes null authentication parameters.
65  *	This file has no interface to xdr routines for PMAPPROC_CALLIT.
66  *
67  * The service supports remote procedure calls on udp/ip or tcp/ip socket 111.
68  */
69 
70 #ifndef _RPC_PMAP_PROT_H
71 #define _RPC_PMAP_PROT_H
72 #include <sys/cdefs.h>
73 
74 #define PMAPPORT		((u_short)111)
75 #define PMAPPROG		((u_long)100000)
76 #define PMAPVERS		((u_long)2)
77 #define PMAPVERS_PROTO		((u_long)2)
78 #define PMAPVERS_ORIG		((u_long)1)
79 #define PMAPPROC_NULL		((u_long)0)
80 #define PMAPPROC_SET		((u_long)1)
81 #define PMAPPROC_UNSET		((u_long)2)
82 #define PMAPPROC_GETPORT	((u_long)3)
83 #define PMAPPROC_DUMP		((u_long)4)
84 #define PMAPPROC_CALLIT		((u_long)5)
85 
86 struct portmap {
87 	long unsigned pm_prog;
88 	long unsigned pm_vers;
89 	long unsigned pm_prot;
90 	long unsigned pm_port;
91 };
92 
93 struct pmaplist {
94 	struct portmap	pml_map;
95 	struct pmaplist *pml_next;
96 };
97 
98 __BEGIN_DECLS
99 extern bool_t xdr_portmap(XDR *, struct portmap *);
100 extern bool_t xdr_pmaplist(XDR *, struct pmaplist **);
101 extern bool_t xdr_pmaplist_ptr(XDR *, struct pmaplist *);
102 __END_DECLS
103 
104 #endif /* !_RPC_PMAP_PROT_H */
105