xref: /dragonfly/include/rpcsvc/sm_inter.x (revision c8860c9a)
1 /*
2  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
3  * unrestricted use provided that this legend is included on all tape
4  * media and as a part of the software program in whole or part.  Users
5  * may copy or modify Sun RPC without charge, but are not authorized
6  * to license or distribute it to anyone else except as part of a product or
7  * program developed by the user.
8  *
9  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
10  * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
11  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
12  *
13  * Sun RPC is provided with no support and without any obligation on the
14  * part of Sun Microsystems, Inc. to assist in its use, correction,
15  * modification or enhancement.
16  *
17  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
18  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
19  * OR ANY PART THEREOF.
20  *
21  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
22  * or profits or other special, indirect and consequential damages, even if
23  * Sun has been advised of the possibility of such damages.
24  *
25  * Sun Microsystems, Inc.
26  * 2550 Garcia Avenue
27  * Mountain View, California  94043
28  *
29  * @(#)sm_inter.x	2.2 88/08/01 4.0 RPCSRC
30  * @(#)sm_inter.x 1.7 87/06/24 Copyr 1987 Sun Micro
31  * $FreeBSD: src/include/rpcsvc/sm_inter.x,v 1.8.2.1 2002/04/11 17:08:33 alfred Exp $
32  */
33 
34 /*
35  * Status monitor protocol specification
36  * Copyright (C) 1986 Sun Microsystems, Inc.
37  *
38  */
39 
40 program SM_PROG {
41 	version SM_VERS  {
42 		/* res_stat = stat_succ if status monitor agrees to monitor */
43 		/* res_stat = stat_fail if status monitor cannot monitor */
44 		/* if res_stat == stat_succ, state = state number of site sm_name */
45 		struct sm_stat_res			 SM_STAT(struct sm_name) = 1;
46 
47 		/* res_stat = stat_succ if status monitor agrees to monitor */
48 		/* res_stat = stat_fail if status monitor cannot monitor */
49 		/* stat consists of state number of local site */
50 		struct sm_stat_res			 SM_MON(struct mon) = 2;
51 
52 		/* stat consists of state number of local site */
53 		struct sm_stat				 SM_UNMON(struct mon_id) = 3;
54 
55 		/* stat consists of state number of local site */
56 		struct sm_stat				 SM_UNMON_ALL(struct my_id) = 4;
57 
58 		void					 SM_SIMU_CRASH(void) = 5;
59 		void					 SM_NOTIFY(struct stat_chge) = 6;
60 
61 	} = 1;
62 } = 100024;
63 
64 const	SM_MAXSTRLEN = 1024;
65 
66 struct sm_name {
67 	string mon_name<SM_MAXSTRLEN>;
68 };
69 
70 struct my_id {
71 	string	 my_name<SM_MAXSTRLEN>;		/* name of the site iniates the monitoring request*/
72 	int	my_prog;			/* rpc program # of the requesting process */
73 	int	my_vers;			/* rpc version # of the requesting process */
74 	int	my_proc;			/* rpc procedure # of the requesting process */
75 };
76 
77 struct mon_id {
78 	string	mon_name<SM_MAXSTRLEN>;		/* name of the site to be monitored */
79 	struct my_id my_id;
80 };
81 
82 
83 struct mon{
84 	struct mon_id mon_id;
85 	opaque priv[16]; 		/* private information to store at monitor for requesting process */
86 };
87 
88 struct stat_chge {
89 	string  mon_name<SM_MAXSTRLEN>;         /* name of the site that had the state change */
90 	int state;
91 };
92 
93 /*
94  * state # of status monitor monitonically increases each time
95  * status of the site changes:
96  * an even number (>= 0) indicates the site is down and
97  * an odd number (> 0) indicates the site is up;
98  */
99 struct sm_stat {
100 	int state;		/* state # of status monitor */
101 };
102 
103 enum sm_res {
104 	stat_succ = 0,		/* status monitor agrees to monitor */
105 	stat_fail = 1		/* status monitor cannot monitor */
106 };
107 
108 struct sm_stat_res {
109 	sm_res res_stat;
110 	int state;
111 };
112 
113 /*
114  * structure of the status message sent back by the status monitor
115  * when monitor site status changes
116  */
117 struct sm_status {
118 	string mon_name<SM_MAXSTRLEN>;
119 	int state;
120 	opaque priv[16];		/* stored private information */
121 };
122