xref: /minix/minix/fs/procfs/service.c (revision 9f988b79)
1 /* ProcFS - service.c - the service subdirectory */
2 
3 #include "inc.h"
4 
5 #include <minix/rs.h>
6 #include "rs/const.h"
7 #include "rs/type.h"
8 
9 enum policy {
10 	POL_NONE	= 0x00,	/*     user	| endpoint	*/
11 	POL_RESET	= 0x01,	/* visible	|  change	*/
12 	POL_RESTART	= 0x02,	/* transparent	| preserved	*/
13 	POL_LIVE_UPDATE	= 0x04	/* transparent	| preserved	*/
14 };
15 
16 struct policies {
17 	#define MAX_POL_FORMAT_SZ 20
18 	char formatted[MAX_POL_FORMAT_SZ];
19 	enum policy supported;
20 };
21 
22 typedef struct {
23 	struct rproc proc[NR_SYS_PROCS];
24 	struct rprocpub pub[NR_SYS_PROCS];
25 } ixfer_rproc_t;
26 static ixfer_rproc_t rproc;
27 
28 static struct policies policies[NR_SYS_PROCS];
29 
30 static struct inode *service_node;
31 
32 /* Updates the policies state from RS. Always returns an ASCIIZ string.  */
33 static const char *
34 service_get_policies(struct policies * pol, index_t slot)
35 {
36 #if 1 /* The following should be retrieved from RS and formated instead. */
37 	int pos;
38 	char *ref_label;
39 	static const struct {
40 		const char *label;
41 		const char *policy_str;
42 	} def_pol[] = {
43 		/* audio */
44 		{ .label = "es1370", .policy_str = "reset" },
45 		{ .label = "es1371", .policy_str = "reset" },
46 		{ .label = "sb16", .policy_str = "reset" },
47 		/* bus */
48 		{ .label = "i2c", .policy_str = "restart" },
49 		{ .label = "pci", .policy_str = "restart" },
50 		{ .label = "ti1225", .policy_str = "restart" },
51 		/* clock */
52 		{ .label = "readclock.drv", .policy_str = "restart" },
53 		/* eeprom */
54 		{ .label = "cat24c256", .policy_str = "restart" },
55 		/* examples */
56 		{ .label = "hello", .policy_str = "restart" },
57 		/* hid */
58 		{ .label = "pckbd", .policy_str = "reset" },
59 		/* iommu */
60 		{ .label = "amddev", .policy_str = "" },
61 		/* net */
62 		{ .label = "3c90x", .policy_str = "reset" },
63 		{ .label = "atl2", .policy_str = "reset" },
64 		{ .label = "dec21140A", .policy_str = "reset" },
65 		{ .label = "dp8390", .policy_str = "reset" },
66 		{ .label = "dpeth", .policy_str = "reset" },
67 		{ .label = "e1000", .policy_str = "reset" },
68 		{ .label = "fxp", .policy_str = "reset" },
69 		{ .label = "lance", .policy_str = "reset" },
70 		{ .label = "lan8710a", .policy_str = "reset" },
71 		{ .label = "orinoco", .policy_str = "reset" },
72 		{ .label = "rtl8139", .policy_str = "reset" },
73 		{ .label = "rtl8169", .policy_str = "reset" },
74 		{ .label = "uds", .policy_str = "reset" },
75 		{ .label = "virtio_net", .policy_str = "reset" },
76 		/* power */
77 		{ .label = "acpi", .policy_str = "" },
78 		{ .label = "tps65217", .policy_str = "" },
79 		{ .label = "tps65590", .policy_str = "" },
80 		/* printer */
81 		{ .label = "printer", .policy_str = "restart" },
82 		/* sensors */
83 		{ .label = "bmp085", .policy_str = "" },
84 		{ .label = "sht21", .policy_str = "restart" },
85 		{ .label = "tsl2550", .policy_str = "restart" },
86 		/* storage */
87 		{ .label = "ahci", .policy_str = "reset" },
88 		{ .label = "at_wini", .policy_str = "reset" },
89 		{ .label = "fbd", .policy_str = "reset" },
90 		{ .label = "filter", .policy_str = "reset" },
91 		{ .label = "floppy", .policy_str = "reset" },
92 		{ .label = "memory", .policy_str = "restart" },
93 		{ .label = "mmc", .policy_str = "reset" },
94 		{ .label = "virtio_blk", .policy_str = "reset" },
95 		{ .label = "vnd", .policy_str = "reset" },
96 		/* system */
97 		{ .label = "gpio", .policy_str = "restart" },
98 		{ .label = "log", .policy_str = "reset" },
99 		{ .label = "random", .policy_str = "restart" },
100 		/* tty */
101 		{ .label = "pty", .policy_str = "restart" },
102 		{ .label = "tty", .policy_str = "restart" },
103 		/* usb */
104 		{ .label = "usbd", .policy_str = "" },
105 		{ .label = "usb_hub", .policy_str = "" },
106 		{ .label = "usb_storage", .policy_str = "" },
107 		/* video */
108 		{ .label = "fb", .policy_str = "" },
109 		{ .label = "tda19988", .policy_str = "" },
110 		/* vmm_guest */
111 		{ .label = "vbox", .policy_str = "" },
112 		/* fs */
113 		{ .label = "ext2", .policy_str = "" },
114 		{ .label = "hgfs", .policy_str = "" },
115 		{ .label = "isofs", .policy_str = "" },
116 		{ .label = "mfs", .policy_str = "restart" },
117 		{ .label = "pfs", .policy_str = "restart" },
118 		{ .label = "procfs", .policy_str = "restart" },
119 		{ .label = "ptyfs", .policy_str = "" },
120 		{ .label = "vbfs", .policy_str = "" },
121 		/* net */
122 		{ .label = "inet", .policy_str = "reset" },
123 		{ .label = "lwip", .policy_str = "" },
124 		/* servers */
125 		{ .label = "devman", .policy_str = "restart" },
126 		{ .label = "ds", .policy_str = "restart" },
127 		{ .label = "input", .policy_str = "reset" },
128 		{ .label = "ipc", .policy_str = "restart" },
129 		{ .label = "is", .policy_str = "restart" },
130 		{ .label = "pm", .policy_str = "restart" },
131 		{ .label = "rs", .policy_str = "restart" },
132 		{ .label = "sched", .policy_str = "restart" },
133 		{ .label = "vfs", .policy_str = "restart" },
134 		{ .label = "vm", .policy_str = "restart" },
135 		//{ .label = "", .policy_str = "" },
136 	};
137 
138 	/* Find the related policy, based on the file name of the service. */
139 	ref_label = strrchr(rproc.pub[slot].proc_name, '/');
140 	if (NULL == ref_label)
141 		ref_label = rproc.pub[slot].proc_name;
142 
143 	memset(pol[slot].formatted, 0, MAX_POL_FORMAT_SZ);
144 	for(pos = 0; pos < (sizeof(def_pol) / sizeof(def_pol[0])); pos++) {
145 		if (0 == strcmp(ref_label, def_pol[pos].label)) {
146 			(void)strncpy(pol[slot].formatted,
147 			    def_pol[pos].policy_str, MAX_POL_FORMAT_SZ);
148 			pol[slot].formatted[MAX_POL_FORMAT_SZ-1] = '\0';
149 			break;
150 		}
151 	}
152 #else
153 	/* Should do something sensible, based on flags from RS/SEF. */
154 #endif
155 
156 	return pol[slot].formatted;
157 }
158 
159 /* Returns a ASCIIZ string encoding RS flags.  */
160 static const char *
161 service_get_flags(index_t slot)
162 {
163 	static char str[10];
164 	int flags, sys_flags;
165 
166 	flags = rproc.proc[slot].r_flags;
167 	sys_flags = rproc.pub[slot].sys_flags;
168 
169 	str[0] = (flags & RS_ACTIVE)        ? 'A' : '-';
170 	str[1] = (flags & RS_UPDATING)      ? 'U' : '-';
171 	str[2] = (flags & RS_EXITING)       ? 'E' : '-';
172 	str[3] = (flags & RS_NOPINGREPLY)   ? 'N' : '-';
173 	str[4] = (sys_flags & SF_USE_COPY)  ? 'C' : '-';
174 	str[5] = (sys_flags & SF_USE_REPL)  ? 'R' : '-';
175 	str[6] = (sys_flags & SF_NEED_COPY) ? 'c' : '-';
176 	str[7] = (sys_flags & SF_NEED_REPL) ? 'r' : '-';
177 	str[8] = (sys_flags & SF_CORE_SRV)  ? 's' : '-';
178 	str[9] = '\0';
179 
180 	return str;
181 }
182 
183 /*
184  * Return whether a slot is in use and active.  The purpose of this check is
185  * to ensure that after eliminating all slots that do not pass this check, we
186  * are left with a set of live services each with a unique label.
187  */
188 static int
189 service_active(index_t slot)
190 {
191 
192 	/*
193 	 * Init is in RS's process tables as the representation of user
194 	 * processes.  It is not a system service.
195 	 */
196 	return ((rproc.proc[slot].r_flags & (RS_IN_USE | RS_ACTIVE)) ==
197 	    (RS_IN_USE | RS_ACTIVE) &&
198 	   rproc.pub[slot].endpoint != INIT_PROC_NR);
199 }
200 
201 /*
202  * Update the contents of the service directory, by first updating the RS
203  * tables and then updating the directory contents.
204  */
205 static void
206 service_update(void)
207 {
208 	struct inode *node;
209 	struct inode_stat stat;
210 	index_t slot;
211 	static int warned = FALSE;
212 	int r;
213 
214 	/* There is not much we can do if this call fails. */
215 	r = getsysinfo(RS_PROC_NR, SI_PROCALL_TAB, &rproc, sizeof(rproc));
216 	if (r != OK && !warned) {
217 		printf("PROCFS: unable to obtain RS tables (%d)\n", r);
218 		warned = TRUE;
219 	}
220 
221 	/*
222 	 * As with PIDs, we make two passes.  Delete first, then add.  This
223 	 * prevents problems in the hypothetical case that between updates, one
224 	 * slot ends up with the label name of a previous, different slot.
225 	 */
226 	for (slot = 0; slot < NR_SYS_PROCS; slot++) {
227 		if ((node = get_inode_by_index(service_node, slot)) == NULL)
228 			continue;
229 
230 		/*
231 		 * If the slot is no longer in use, or the label name does not
232 		 * match, the node must be deleted.
233 		 */
234 		if (!service_active(slot) ||
235 		    strcmp(get_inode_name(node), rproc.pub[slot].label))
236 			delete_inode(node);
237 	}
238 
239 	memset(&stat, 0, sizeof(stat));
240 	stat.mode = REG_ALL_MODE;
241 	stat.uid = SUPER_USER;
242 	stat.gid = SUPER_USER;
243 
244 	for (slot = 0; slot < NR_SYS_PROCS; slot++) {
245 		if (!service_active(slot) ||
246 		    get_inode_by_index(service_node, slot) != NULL)
247 			continue;
248 
249 		node = add_inode(service_node, rproc.pub[slot].label, slot,
250 		    &stat, (index_t)0, (cbdata_t)slot);
251 
252 		if (node == NULL)
253 			out_of_inodes();
254 	}
255 }
256 
257 /*
258  * Initialize the service directory.
259  */
260 void
261 service_init(void)
262 {
263 	struct inode *root, *node;
264 	struct inode_stat stat;
265 
266 	root = get_root_inode();
267 
268 	memset(&stat, 0, sizeof(stat));
269 	stat.mode = DIR_ALL_MODE;
270 	stat.uid = SUPER_USER;
271 	stat.gid = SUPER_USER;
272 
273 	service_node = add_inode(root, "service", NO_INDEX, &stat,
274 	    NR_SYS_PROCS, NULL);
275 
276 	if (service_node == NULL)
277 		panic("unable to create service node");
278 }
279 
280 /*
281  * A lookup request is being performed.  If it is in the service directory,
282  * update the tables.  We do this lazily, to reduce overhead.
283  */
284 void
285 service_lookup(struct inode * parent, clock_t now)
286 {
287 	static clock_t last_update = 0;
288 
289 	if (parent != service_node)
290 		return;
291 
292 	if (last_update != now) {
293 		service_update();
294 
295 		last_update = now;
296 	}
297 }
298 
299 /*
300  * A getdents request is being performed.  If it is in the service directory,
301  * update the tables.
302  */
303 void
304 service_getdents(struct inode * node)
305 {
306 
307 	if (node != service_node)
308 		return;
309 
310 	service_update();
311 }
312 
313 /*
314  * A read request is being performed.  If it is on a file in the service
315  * directory, process the read request.  We rely on the fact that any read
316  * call will have been preceded by a lookup, so its table entry has been
317  * updated very recently.
318  */
319 void
320 service_read(struct inode * node)
321 {
322 	struct inode *parent;
323 	index_t slot;
324 	struct rprocpub *rpub;
325 	struct rproc *rp;
326 
327 	if (get_parent_inode(node) != service_node)
328 		return;
329 
330 	slot = get_inode_index(node);
331 	rpub = &rproc.pub[slot];
332 	rp = &rproc.proc[slot];
333 
334 	/* TODO: add a large number of other fields! */
335 	buf_printf("filename: %s\n", rpub->proc_name);
336 	buf_printf("endpoint: %d\n", rpub->endpoint);
337 	buf_printf("pid:      %d\n", rp->r_pid);
338 	buf_printf("restarts: %d\n", rp->r_restarts);
339 	buf_printf("flags:    %s\n", service_get_flags(slot));
340 	buf_printf("policies: %s\n", service_get_policies(policies, slot));
341 	buf_printf("ASRcount: %u\n", rp->r_asr_count);
342 }
343