xref: /freebsd/include/rpcsvc/rex.x (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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  * Remote execution (rex) protocol specification
34  */
35 
36 #ifndef RPC_HDR
37 %#ifndef lint
38 %/*static char sccsid[] = "from: @(#)rex.x 1.3 87/09/18 Copyr 1987 Sun Micro";*/
39 %/*static char sccsid[] = "from: @(#)rex.x	2.1 88/08/01 4.0 RPCSRC";*/
40 %#endif /* not lint */
41 %#include <sys/cdefs.h>
42 %__FBSDID("$FreeBSD$");
43 #endif
44 
45 const STRINGSIZE = 1024;
46 typedef string rexstring<1024>;
47 
48 /*
49  * values to pass to REXPROC_SIGNAL
50  */
51 const SIGINT = 2;	/* interrupt */
52 
53 /*
54  * Values for rst_flags, below
55  */
56 const REX_INTERACTIVE = 1;	/* interactive mode */
57 
58 struct rex_start {
59 	rexstring rst_cmd<>;	/* list of command and args */
60 	rexstring rst_host;	/* working directory host name */
61 	rexstring rst_fsname;	/* working directory file system name */
62 	rexstring rst_dirwithin;/* working directory within file system */
63 	rexstring rst_env<>;	/* list of environment */
64 	unsigned int rst_port0;	/* port for stdin */
65 	unsigned int rst_port1;	/* port for stdout */
66 	unsigned int rst_port2;	/* port for stderr */
67 	unsigned int rst_flags;	/* options - see const above */
68 };
69 
70 struct rex_result {
71    	int rlt_stat;		/* integer status code */
72 	rexstring rlt_message;	/* string message for human consumption */
73 };
74 
75 
76 struct sgttyb {
77 	unsigned four;	/* always equals 4 */
78 	opaque chars[4];
79 	/* chars[0] == input speed */
80 	/* chars[1] == output speed */
81 	/* chars[2] == kill character */
82 	/* chars[3] == erase character */
83 	unsigned flags;
84 };
85 /* values for speeds above (baud rates)  */
86 const B0  = 0;
87 const B50 = 1;
88 const B75 = 2;
89 const B110 = 3;
90 const B134 = 4;
91 const B150 = 5;
92 const B200 = 6;
93 const B300 = 7;
94 const B600 = 8;
95 const B1200 = 9;
96 const B1800 = 10;
97 const B2400 = 11;
98 const B4800 = 12;
99 const B9600 = 13;
100 const B19200 = 14;
101 const B38400 = 15;
102 
103 /* values for flags above */
104 const TANDEM = 0x00000001; /* send stopc on out q full */
105 const CBREAK = 0x00000002; /* half-cooked mode */
106 const LCASE = 0x00000004; /* simulate lower case */
107 const ECHO = 0x00000008; /* echo input */
108 const CRMOD = 0x00000010; /* map \r to \r\n on output */
109 const RAW = 0x00000020; /* no i/o processing */
110 const ODDP = 0x00000040; /* get/send odd parity */
111 const EVENP = 0x00000080; /* get/send even parity */
112 const ANYP = 0x000000c0; /* get any parity/send none */
113 const NLDELAY = 0x00000300; /* \n delay */
114 const  NL0 = 0x00000000;
115 const  NL1 = 0x00000100; /* tty 37 */
116 const  NL2 = 0x00000200; /* vt05 */
117 const  NL3 = 0x00000300;
118 const TBDELAY = 0x00000c00; /* horizontal tab delay */
119 const  TAB0 = 0x00000000;
120 const  TAB1 = 0x00000400; /* tty 37 */
121 const  TAB2 = 0x00000800;
122 const XTABS = 0x00000c00; /* expand tabs on output */
123 const CRDELAY = 0x00003000; /* \r delay */
124 const  CR0 = 0x00000000;
125 const  CR1 = 0x00001000; /* tn 300 */
126 const  CR2 = 0x00002000; /* tty 37 */
127 const  CR3 = 0x00003000; /* concept 100 */
128 const VTDELAY = 0x00004000; /* vertical tab delay */
129 const  FF0 = 0x00000000;
130 const  FF1 = 0x00004000; /* tty 37 */
131 const BSDELAY = 0x00008000; /* \b delay */
132 const  BS0 = 0x00000000;
133 const  BS1 = 0x00008000;
134 const CRTBS = 0x00010000; /* do backspacing for crt */
135 const PRTERA = 0x00020000; /* \ ... / erase */
136 const CRTERA = 0x00040000; /* " \b " to wipe out char */
137 const TILDE = 0x00080000; /* hazeltine tilde kludge */
138 const MDMBUF = 0x00100000; /* start/stop output on carrier intr */
139 const LITOUT = 0x00200000; /* literal output */
140 const TOSTOP = 0x00400000; /* SIGTTOU on background output */
141 const FLUSHO = 0x00800000; /* flush output to terminal */
142 const NOHANG = 0x01000000; /* no SIGHUP on carrier drop */
143 const L001000 = 0x02000000;
144 const CRTKIL = 0x04000000; /* kill line with " \b " */
145 const PASS8 = 0x08000000;
146 const CTLECH = 0x10000000; /* echo control chars as ^X */
147 const PENDIN = 0x20000000; /* tp->t_rawq needs reread */
148 const DECCTQ = 0x40000000; /* only ^Q starts after ^S */
149 const NOFLSH = 0x80000000; /* no output flush on signal */
150 
151 struct tchars {
152 	unsigned six;	/* always equals 6 */
153 	opaque chars[6];
154 	/* chars[0] == interrupt char */
155 	/* chars[1] == quit char */
156 	/* chars[2] == start output char */
157 	/* chars[3] == stop output char */
158 	/* chars[4] == end-of-file char */
159 	/* chars[5] == input delimeter (like nl) */
160 };
161 
162 struct ltchars {
163 	unsigned six;	/* always equals 6 */
164 	opaque chars[6];
165 	/* chars[0] == stop process signal */
166 	/* chars[1] == delayed stop process signal */
167 	/* chars[2] == reprint line */
168 	/* chars[3] == flush output */
169 	/* chars[4] == word erase */
170 	/* chars[5] == literal next character */
171 	unsigned mode;
172 };
173 
174 struct rex_ttysize {
175 	int ts_lines;
176 	int ts_cols;
177 };
178 
179 struct rex_ttymode {
180     sgttyb basic;    /* standard unix tty flags */
181     tchars more; /* interrupt, kill characters, etc. */
182     ltchars yetmore; /* special Berkeley characters */
183     unsigned andmore;     /* and Berkeley modes */
184 };
185 
186 /* values for andmore above */
187 const LCRTBS = 0x0001;	/* do backspacing for crt */
188 const LPRTERA = 0x0002;	/* \ ... / erase */
189 const LCRTERA = 0x0004;	/* " \b " to wipe out char */
190 const LTILDE = 0x0008;	/* hazeltine tilde kludge */
191 const LMDMBUF = 0x0010;	/* start/stop output on carrier intr */
192 const LLITOUT = 0x0020;	/* literal output */
193 const LTOSTOP = 0x0040;	/* SIGTTOU on background output */
194 const LFLUSHO = 0x0080;	/* flush output to terminal */
195 const LNOHANG = 0x0100;	/* no SIGHUP on carrier drop */
196 const LL001000 = 0x0200;
197 const LCRTKIL = 0x0400;	/* kill line with " \b " */
198 const LPASS8 = 0x0800;
199 const LCTLECH = 0x1000;	/* echo control chars as ^X */
200 const LPENDIN = 0x2000;	/* needs reread */
201 const LDECCTQ = 0x4000;	/* only ^Q starts after ^S */
202 const LNOFLSH = 0x8000;	/* no output flush on signal */
203 
204 program REXPROG {
205 	version REXVERS {
206 
207 		/*
208 		 * Start remote execution
209 		 */
210 		rex_result
211 		REXPROC_START(rex_start) = 1;
212 
213 		/*
214 		 * Wait for remote execution to terminate
215 		 */
216 		rex_result
217 		REXPROC_WAIT(void) = 2;
218 
219 		/*
220 		 * Send tty modes
221 		 */
222 		void
223 		REXPROC_MODES(rex_ttymode) = 3;
224 
225 		/*
226 		 * Send window size change
227 		 */
228 		void
229 		REXPROC_WINCH(rex_ttysize) = 4;
230 
231 		/*
232 		 * Send other signal
233 		 */
234 		void
235 		REXPROC_SIGNAL(int) = 5;
236 	} = 1;
237 } = 100017;
238