1 /*
2  * Copyright (c)2004 The DragonFly Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  *   Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  *
11  *   Redistributions in binary form must reproduce the above copyright
12  *   notice, this list of conditions and the following disclaimer in
13  *   the documentation and/or other materials provided with the
14  *   distribution.
15  *
16  *   Neither the name of the DragonFly Project 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
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31  * OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * survey.c
36  * Survey the storage capacity of the system.
37  * $Id: survey.c,v 1.17 2005/02/06 21:05:18 cpressey Exp $
38  */
39 
40 #include <sys/types.h>
41 #include <sys/sysctl.h>
42 
43 #include <stdio.h>
44 #include <string.h>
45 
46 #include "libaura/dict.h"
47 
48 #include "commands.h"
49 #include "diskutil.h"
50 #include "functions.h"
51 
52 static int	fgets_chomp(char *, int, FILE *);
53 static int	parse_geometry_info(char *, int *, int *, int *);
54 static int	parse_slice_info(char *, int *,
55 		    unsigned long *, unsigned long *, int *, int *);
56 
57 /*
58  * Get a line from a file.  Remove any trailing EOL's.
59  * Return 1 if we did not hit EOF, 0 if we did.
60  */
61 static int
62 fgets_chomp(char *line, int size, FILE *f)
63 {
64 	if (fgets(line, size, f) == NULL)
65 		return(0);
66 	while (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
67 		line[strlen(line) - 1] = '\0';
68 	return(1);
69 }
70 
71 /*
72  * Given a geometry line from fdisk's summary output, return the
73  * number of cylinders, heads, and sectors.
74  */
75 static int
76 parse_geometry_info(char *line, int *cyl, int *head, int *sec)
77 {
78 	char *word;
79 
80 	/*
81 	 * /dev/ad3: 2112 cyl 16 hd 63 sec
82 	 */
83 	if ((word = strtok(line, " \t")) == NULL)	/* /dev/ad3: */
84 		return(0);
85 	if ((word = strtok(NULL, " \t")) == NULL)	/* 2112 */
86 		return(0);
87 	*cyl = atoi(word);
88 	if ((word = strtok(NULL, " \t")) == NULL)	/* cyl */
89 		return(0);
90 	if ((word = strtok(NULL, " \t")) == NULL)	/* 16 */
91 		return(0);
92 	*head = atoi(word);
93 	if ((word = strtok(NULL, " \t")) == NULL)	/* hd */
94 		return(0);
95 	if ((word = strtok(NULL, " \t")) == NULL)	/* 63 */
96 		return(0);
97 	*sec = atoi(word);
98 
99 	return(1);
100 }
101 
102 /*
103  * Given a slice description line from fdisk's summary output, return
104  * the number of the slice, and its start, size, type, and flags.
105  */
106 static int
107 parse_slice_info(char *line, int *slice,
108 		 unsigned long *start, unsigned long *size,
109 		 int *type, int *flags)
110 {
111 	char *word;
112 
113 	/*
114 	 * Part        Start        Size Type Flags
115 	 *    1:          63     2128833 0xa5 0x80
116 	 */
117 	if ((word = strtok(line, " \t")) == NULL)	/* 1: */
118 		return(0);
119 	*slice = atoi(word);
120 	if ((word = strtok(NULL, " \t")) == NULL)	/* 63 */
121 		return(0);
122 	*start = strtoul(word, NULL, 10);
123 	if ((word = strtok(NULL, " \t")) == NULL)	/* 2128833 */
124 		return(0);
125 	*size = strtoul(word, NULL, 10);
126 	if ((word = strtok(NULL, " \t")) == NULL)	/* 0xa5 */
127 		return(0);
128 	if (!hex_to_int(word, type))
129 		return(0);
130 	if ((word = strtok(NULL, " \t")) == NULL)	/* 0x80 */
131 		return(0);
132 	if (!hex_to_int(word, flags))
133 		return(0);
134 
135 	return(1);
136 }
137 
138 /*
139  * Survey storage capacity of this system.
140  */
141 int
142 survey_storage(struct i_fn_args *a)
143 {
144 	unsigned long mem = 0;
145 	char disks[256], line[256];
146 	char *disk, *disk_ptr;
147 	struct commands *cmds;
148 	struct command *cmd;
149 	FILE *f;
150 	char *filename;
151 	struct disk *d = NULL;
152 	int number = 0;
153 	int failure = 0;
154 	size_t len;
155 	struct aura_dict *di;
156 	void *rk;
157 	size_t rk_len;
158 
159 	disks_free(a->s);
160 
161 	len = sizeof(mem);
162 	if (sysctlbyname("hw.physmem", &mem, &len, NULL, 0) < 0) {
163 		failure |= 1;
164 	} else {
165 		storage_set_memsize(a->s, next_power_of_two(mem >> 20));
166 	}
167 	len = 256;
168 	if (sysctlbyname("kern.disks", disks, &len, NULL, 0) < 0) {
169 		failure |= 1;
170 	}
171 	disk_ptr = disks;
172 
173 	di = aura_dict_new(1, AURA_DICT_SORTED_LIST);
174 	while (!failure && (disk = strsep(&disk_ptr, " ")) != NULL) {
175 		if (disk[0] == '\0')
176 			continue;
177 
178 		/*
179 		 * If the disk is a memory disk, floppy or CD-ROM, skip it.
180 		 */
181 		if (strncmp(disk, "md", 2) == 0 ||
182 		    strncmp(disk, "cd", 2) == 0 ||
183 		    strncmp(disk, "acd", 3) == 0 ||
184 		    strncmp(disk, "fd", 2) == 0)
185 			continue;
186 
187 		aura_dict_store(di, disk, strlen(disk) + 1, "", 1);
188 	}
189 
190 	cmds = commands_new();
191 	cmd = command_add(cmds, "%s%s -n '' >%ssurvey.txt",
192 	    a->os_root, cmd_name(a, "ECHO"), a->tmp);
193 	command_set_log_mode(cmd, COMMAND_LOG_SILENT);
194 
195 	aura_dict_rewind(di);
196 	while (!aura_dict_eof(di)) {
197 		aura_dict_get_current_key(di, &rk, &rk_len),
198 
199 		disk = (char *)rk;
200 
201 		cmd = command_add(cmds, "%s%s '@DISK' >>%ssurvey.txt",
202 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
203 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
204 		cmd = command_add(cmds, "%s%s '%s' >>%ssurvey.txt",
205 		    a->os_root, cmd_name(a, "ECHO"), disk, a->tmp);
206 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
207 
208 		/*
209 		 * Look for descriptions of this disk.
210 		 */
211 		cmd = command_add(cmds, "%s%s '@DESC' >>%ssurvey.txt",
212 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
213 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
214 		cmd = command_add(cmds, "%s%s -w '^%s: [0-9]*MB' %s%s >>%ssurvey.txt || %s%s '%s' >>%ssurvey.txt",
215 		    a->os_root, cmd_name(a, "GREP"),
216 		    disk,
217 		    a->os_root, cmd_name(a, "DMESG_BOOT"),
218 		    a->tmp,
219 		    a->os_root, cmd_name(a, "ECHO"),
220 		    disk,
221 		    a->tmp);
222 		cmd = command_add(cmds, "%s%s '@END' >>%ssurvey.txt",
223 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
224 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
225 
226 		/*
227 		 * Look for the disk's serial number.
228 		 */
229 		cmd = command_add(cmds, "%s%s '@SERNO' >>%ssurvey.txt",
230 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
231 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
232 		cmd = command_add(cmds, "if %s%s -d /dev/serno; then %s%s -l /dev/serno | %s%s \"`%s%s -l /dev/%s | %s%s '{print $5, $6;}'`\" | %s%s '{print $10;}' >>%ssurvey.txt; fi",
233 		    a->os_root, cmd_name(a, "TEST"),
234 		    a->os_root, cmd_name(a, "LS"),
235 		    a->os_root, cmd_name(a, "GREP"),
236 		    a->os_root, cmd_name(a, "LS"),
237 		    disk,
238 		    a->os_root, cmd_name(a, "AWK"),
239 		    a->os_root, cmd_name(a, "AWK"),
240 		    a->tmp);
241 		cmd = command_add(cmds, "%s%s '@END' >>%ssurvey.txt",
242 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
243 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
244 
245 		/*
246 		 * Probe the disk with fdisk.
247 		 */
248 		cmd = command_add(cmds, "%s%s '@SLICES' >>%ssurvey.txt",
249 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
250 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
251 		cmd = command_add(cmds, "%s%s -s %s 2>/dev/null >>%ssurvey.txt || %s%s '' >>%ssurvey.txt",
252 		    a->os_root, cmd_name(a, "FDISK"),
253 		    disk,
254 		    a->tmp,
255 		    a->os_root, cmd_name(a, "ECHO"),
256 		    a->tmp);
257 		cmd = command_add(cmds, "%s%s '@END' >>%ssurvey.txt",
258 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
259 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
260 
261 		aura_dict_next(di);
262 	}
263 
264 	cmd = command_add(cmds, "%s%s '.' >>%ssurvey.txt",
265 	    a->os_root, cmd_name(a, "ECHO"), a->tmp);
266 	command_set_log_mode(cmd, COMMAND_LOG_SILENT);
267 
268 	if (!commands_execute(a, cmds))
269 		failure |= 1;
270 	commands_free(cmds);
271 	temp_file_add(a, "survey.txt");
272 
273 	aura_dict_free(di);
274 
275 	/*
276 	 * Now read in and parse the file that those commands just created.
277 	 */
278 	asprintf(&filename, "%ssurvey.txt", a->tmp);
279 	if ((f = fopen(filename, "r")) == NULL)
280 		failure |= 1;
281 	free(filename);
282 
283 	while (!failure && fgets_chomp(line, 255, f)) {
284 		if (strcmp(line, "@DISK") == 0) {
285 			if (fgets_chomp(line, 255, f)) {
286 				d = disk_new(a->s, line);
287 				disk_set_number(d, number++);
288 			}
289 		} else if (strcmp(line, "@DESC") == 0) {
290 			while (d != NULL && strcmp(line, "@END") != 0 && fgets_chomp(line, 255, f)) {
291 				disk_set_desc(d, line);
292 			}
293 		} else if (strcmp(line, "@SERNO") == 0) {
294 			fgets_chomp(line, 255, f);
295 			if (line[0] != '\0' && strcmp(line, "@END") != 0)
296 				disk_set_serno(d, line);
297 		} else if (strcmp(line, "@SLICES") == 0) {
298 			int cyl, hd, sec;
299 			int sliceno, type, flags;
300 			unsigned long start, size;
301 
302 			/*
303 			 * /dev/ad3: 2112 cyl 16 hd 63 sec
304 			 * Part        Start        Size Type Flags
305 			 *    1:          63     2128833 0xa5 0x80
306 			 */
307 			while (d != NULL && strcmp(line, "@END") != 0 && fgets_chomp(line, 255, f)) {
308 				if (strncmp(line, "/dev/", 5) == 0) {
309 					cyl = hd = sec = 0;
310 					parse_geometry_info(line, &cyl, &hd, &sec);
311 					disk_set_geometry(d, cyl, hd, sec);
312 				} else if (strncmp(line, "Part", 4) == 0) {
313 					/* ignore it */
314 				} else {
315 					if (parse_slice_info(line, &sliceno, &start, &size,
316 					    &type, &flags)) {
317 						/*
318 						fprintfo(log, "| Found slice #%d, sysid %d, "
319 						    "start %ld, size %ld\n", sliceno, type, start, size);
320 						*/
321 						slice_new(d, sliceno, type, flags, start, size);
322 					}
323 				}
324 			}
325 		}
326 	}
327 
328 	if (f != NULL)
329 		fclose(f);
330 
331 	/*
332 	 * Fix up any disk descriptions that didn't make it.
333 	 */
334 	for (d = storage_disk_first(a->s); d != NULL; d = disk_next(d)) {
335 		if (disk_get_desc(d) == NULL)
336 			disk_set_desc(d, disk_get_device_name(d));
337 	}
338 
339 	return(!failure);
340 }
341