xref: /freebsd/include/rpcsvc/bootparam_prot.x (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1 /*-
2  * Copyright (c) 2010, Oracle America, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  *       notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  *       copyright notice, this list of conditions and the following
12  *       disclaimer in the documentation and/or other materials
13  *       provided with the distribution.
14  *     * Neither the name of the "Oracle America, Inc." nor the names of its
15  *       contributors may be used to endorse or promote products derived
16  *       from this software without specific prior written permission.
17  *
18  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21  *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22  *   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
23  *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
25  *   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27  *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * RPC for bootparms service.
34  * There are two procedures:
35  *   WHOAMI takes a net address and returns a client name and also a
36  *	likely net address for routing
37  *   GETFILE takes a client name and file identifier and returns the
38  *	server name, server net address and pathname for the file.
39  *   file identifiers typically include root, swap, pub and dump
40  */
41 
42 #ifdef RPC_HDR
43 %#include <rpc/types.h>
44 %#include <sys/time.h>
45 %#include <sys/errno.h>
46 %#include <sys/param.h>
47 %#include <sys/syslimits.h>
48 #endif
49 
50 const MAX_MACHINE_NAME  = 255;
51 const MAX_PATH_LEN	= 1024;
52 const MAX_FILEID	= 32;
53 const IP_ADDR_TYPE	= 1;
54 
55 typedef	string	bp_machine_name_t<MAX_MACHINE_NAME>;
56 typedef	string	bp_path_t<MAX_PATH_LEN>;
57 typedef	string	bp_fileid_t<MAX_FILEID>;
58 
59 struct	ip_addr_t {
60 	char	net;
61 	char	host;
62 	char	lh;
63 	char	impno;
64 };
65 
66 union bp_address switch (int address_type) {
67 	case IP_ADDR_TYPE:
68 		ip_addr_t	ip_addr;
69 };
70 
71 struct bp_whoami_arg {
72 	bp_address		client_address;
73 };
74 
75 struct bp_whoami_res {
76 	bp_machine_name_t	client_name;
77 	bp_machine_name_t	domain_name;
78 	bp_address		router_address;
79 };
80 
81 struct bp_getfile_arg {
82 	bp_machine_name_t	client_name;
83 	bp_fileid_t		file_id;
84 };
85 
86 struct bp_getfile_res {
87 	bp_machine_name_t	server_name;
88 	bp_address		server_address;
89 	bp_path_t		server_path;
90 };
91 
92 program BOOTPARAMPROG {
93 	version BOOTPARAMVERS {
94 		bp_whoami_res	BOOTPARAMPROC_WHOAMI(bp_whoami_arg) = 1;
95 		bp_getfile_res	BOOTPARAMPROC_GETFILE(bp_getfile_arg) = 2;
96 	} = 1;
97 } = 100026;
98