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/param.h>
41 #include <sys/diskslice.h>
42 #include <sys/sysctl.h>
43 
44 #include <fcntl.h>
45 #include <stdio.h>
46 #include <string.h>
47 #include <unistd.h>
48 
49 #include "libaura/dict.h"
50 
51 #include "commands.h"
52 #include "diskutil.h"
53 #include "functions.h"
54 
55 static int	fgets_chomp(char *, int, FILE *);
56 static int	parse_geometry_info(char *, int *, int *, int *);
57 static int	parse_slice_info(char *, int *,
58 		    unsigned long *, unsigned long *, int *, int *);
59 
60 /*
61  * Get a line from a file.  Remove any trailing EOL's.
62  * Return 1 if we did not hit EOF, 0 if we did.
63  */
64 static int
65 fgets_chomp(char *line, int size, FILE *f)
66 {
67 	if (fgets(line, size, f) == NULL)
68 		return(0);
69 	while (strlen(line) > 0 && line[strlen(line) - 1] == '\n')
70 		line[strlen(line) - 1] = '\0';
71 	return(1);
72 }
73 
74 /*
75  * Given a geometry line from fdisk's summary output, return the
76  * number of cylinders, heads, and sectors.
77  */
78 static int
79 parse_geometry_info(char *line, int *cyl, int *head, int *sec)
80 {
81 	char *word;
82 
83 	/*
84 	 * /dev/ad3: 2112 cyl 16 hd 63 sec
85 	 */
86 	if ((word = strtok(line, " \t")) == NULL)	/* /dev/ad3: */
87 		return(0);
88 	if ((word = strtok(NULL, " \t")) == NULL)	/* 2112 */
89 		return(0);
90 	*cyl = atoi(word);
91 	if ((word = strtok(NULL, " \t")) == NULL)	/* cyl */
92 		return(0);
93 	if ((word = strtok(NULL, " \t")) == NULL)	/* 16 */
94 		return(0);
95 	*head = atoi(word);
96 	if ((word = strtok(NULL, " \t")) == NULL)	/* hd */
97 		return(0);
98 	if ((word = strtok(NULL, " \t")) == NULL)	/* 63 */
99 		return(0);
100 	*sec = atoi(word);
101 
102 	return(1);
103 }
104 
105 /*
106  * Given a slice description line from fdisk's summary output, return
107  * the number of the slice, and its start, size, type, and flags.
108  */
109 static int
110 parse_slice_info(char *line, int *slice,
111 		 unsigned long *start, unsigned long *size,
112 		 int *type, int *flags)
113 {
114 	char *word;
115 
116 	/*
117 	 * Part        Start        Size Type Flags
118 	 *    1:          63     2128833 0x6c 0x80
119 	 */
120 	if ((word = strtok(line, " \t")) == NULL)	/* 1: */
121 		return(0);
122 	*slice = atoi(word);
123 	if ((word = strtok(NULL, " \t")) == NULL)	/* 63 */
124 		return(0);
125 	*start = strtoul(word, NULL, 10);
126 	if ((word = strtok(NULL, " \t")) == NULL)	/* 2128833 */
127 		return(0);
128 	*size = strtoul(word, NULL, 10);
129 	if ((word = strtok(NULL, " \t")) == NULL)	/* 0x6c */
130 		return(0);
131 	if (!hex_to_int(word, type))
132 		return(0);
133 	if ((word = strtok(NULL, " \t")) == NULL)	/* 0x80 */
134 		return(0);
135 	if (!hex_to_int(word, flags))
136 		return(0);
137 
138 	return(1);
139 }
140 
141 /*
142  * Survey storage capacity of this system.
143  */
144 int
145 survey_storage(struct i_fn_args *a)
146 {
147 	unsigned long mem = 0;
148 	char disks[256], line[256];
149 	char *disk, *disk_ptr;
150 	struct commands *cmds;
151 	struct command *cmd;
152 	FILE *f;
153 	char *filename;
154 	struct disk *d = NULL;
155 	int number = 0;
156 	int failure = 0;
157 	int ndisks = 0;
158 	int fd;
159 	size_t len;
160 	struct aura_dict *di;
161 	void *rk;
162 	size_t rk_len;
163 	struct partinfo diskpart;
164 	char diskpath[PATH_MAX];
165 
166 	sleep(1);		/* give devfs time to probe */
167 	disks_free(a->s);
168 
169 	len = sizeof(mem);
170 	if (sysctlbyname("hw.physmem", &mem, &len, NULL, 0) < 0) {
171 		failure |= 1;
172 	} else {
173 		storage_set_memsize(a->s, next_power_of_two(mem >> 20));
174 	}
175 	len = 256;
176 	if (sysctlbyname("kern.disks", disks, &len, NULL, 0) < 0) {
177 		failure |= 1;
178 	}
179 	disk_ptr = disks;
180 
181 	di = aura_dict_new(1, AURA_DICT_SORTED_LIST);
182 	while (!failure && (disk = strsep(&disk_ptr, " ")) != NULL) {
183 		if (disk[0] == '\0')
184 			continue;
185 
186 		/*
187 		 * If the disk is a memory disk, floppy or CD-ROM, skip it.
188 		 */
189 		if (strncmp(disk, "md", 2) == 0 ||
190 		    strncmp(disk, "cd", 2) == 0 ||
191 		    strncmp(disk, "acd", 3) == 0 ||
192 		    strncmp(disk, "fd", 2) == 0)
193 			continue;
194 
195 		aura_dict_store(di, disk, strlen(disk) + 1, "", 1);
196 		ndisks++;
197 	}
198 
199 	if (ndisks == 0)
200 		failure |= 1;
201 
202 	cmds = commands_new();
203 	cmd = command_add(cmds, "%s%s -n '' >%ssurvey.txt",
204 	    a->os_root, cmd_name(a, "ECHO"), a->tmp);
205 	command_set_log_mode(cmd, COMMAND_LOG_SILENT);
206 
207 	for (aura_dict_rewind(di); !aura_dict_eof(di); aura_dict_next(di) ) {
208 		aura_dict_get_current_key(di, &rk, &rk_len);
209 		disk = (char *)rk;
210 
211 		/*
212 		 * Attempt to get media information from the disk. This information
213 		 * might be used later on for partitioning. Any disk that does not
214 		 * provide the information will be discarded as not suitable for
215 		 * an installation.
216 		 */
217 		bzero(&diskpart, sizeof(diskpart));
218 		snprintf(diskpath, PATH_MAX, "/dev/%s", disk);
219 		if ((fd = open(diskpath, O_RDONLY)) < 0)
220 			continue;
221 		if (ioctl(fd, DIOCGPART, &diskpart) < 0)
222 			continue;
223 
224 		cmd = command_add(cmds, "%s%s '@DISK' >>%ssurvey.txt",
225 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
226 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
227 		cmd = command_add(cmds, "%s%s '%s' >>%ssurvey.txt",
228 		    a->os_root, cmd_name(a, "ECHO"), disk, a->tmp);
229 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
230 
231 		/*
232 		 * Look for descriptions of this disk.
233 		 */
234 		cmd = command_add(cmds, "%s%s '@DESC' >>%ssurvey.txt",
235 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
236 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
237 		cmd = command_add(cmds, "%s%s '%s: %luMB' >>%ssurvey.txt",
238 		    a->os_root, cmd_name(a, "ECHO"),
239 		    disk,
240 		    diskpart.media_size / 1024 / 1024,
241 		    a->tmp);
242 		close(fd);
243 		cmd = command_add(cmds, "%s%s '@END' >>%ssurvey.txt",
244 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
245 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
246 
247 		/*
248 		 * Look for the disk's serial number.
249 		 */
250 		cmd = command_add(cmds, "%s%s '@SERNO' >>%ssurvey.txt",
251 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
252 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
253 		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",
254 		    a->os_root, cmd_name(a, "TEST"),
255 		    a->os_root, cmd_name(a, "LS"),
256 		    a->os_root, cmd_name(a, "GREP"),
257 		    a->os_root, cmd_name(a, "LS"),
258 		    disk,
259 		    a->os_root, cmd_name(a, "AWK"),
260 		    a->os_root, cmd_name(a, "AWK"),
261 		    a->tmp);
262 		cmd = command_add(cmds, "%s%s '@END' >>%ssurvey.txt",
263 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
264 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
265 
266 		/*
267 		 * Probe the disk with fdisk.
268 		 */
269 		cmd = command_add(cmds, "%s%s '@SLICES' >>%ssurvey.txt",
270 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
271 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
272 		cmd = command_add(cmds, "%s%s -s %s 2>/dev/null >>%ssurvey.txt || %s%s '' >>%ssurvey.txt",
273 		    a->os_root, cmd_name(a, "FDISK"),
274 		    disk,
275 		    a->tmp,
276 		    a->os_root, cmd_name(a, "ECHO"),
277 		    a->tmp);
278 		cmd = command_add(cmds, "%s%s '@END' >>%ssurvey.txt",
279 		    a->os_root, cmd_name(a, "ECHO"), a->tmp);
280 		command_set_log_mode(cmd, COMMAND_LOG_SILENT);
281 	}
282 
283 	cmd = command_add(cmds, "%s%s '.' >>%ssurvey.txt",
284 	    a->os_root, cmd_name(a, "ECHO"), a->tmp);
285 	command_set_log_mode(cmd, COMMAND_LOG_SILENT);
286 
287 	if (!commands_execute(a, cmds))
288 		failure |= 1;
289 	commands_free(cmds);
290 	temp_file_add(a, "survey.txt");
291 
292 	aura_dict_free(di);
293 
294 	/*
295 	 * Now read in and parse the file that those commands just created.
296 	 */
297 	asprintf(&filename, "%ssurvey.txt", a->tmp);
298 	if ((f = fopen(filename, "r")) == NULL)
299 		failure |= 1;
300 	free(filename);
301 
302 	while (!failure && fgets_chomp(line, 255, f)) {
303 		if (strcmp(line, "@DISK") == 0) {
304 			if (fgets_chomp(line, 255, f)) {
305 				d = disk_new(a->s, line);
306 				disk_set_number(d, number++);
307 			}
308 		} else if (strcmp(line, "@DESC") == 0) {
309 			while (d != NULL && strcmp(line, "@END") != 0 && fgets_chomp(line, 255, f)) {
310 				disk_set_desc(d, line);
311 			}
312 		} else if (strcmp(line, "@SERNO") == 0) {
313 			fgets_chomp(line, 255, f);
314 			if (line[0] != '\0' && strcmp(line, "@END") != 0)
315 				disk_set_serno(d, line);
316 		} else if (strcmp(line, "@SLICES") == 0) {
317 			int cyl, hd, sec;
318 			int sliceno, type, flags;
319 			unsigned long start, size;
320 
321 			/*
322 			 * /dev/ad3: 2112 cyl 16 hd 63 sec
323 			 * Part        Start        Size Type Flags
324 			 *    1:          63     2128833 0x6c 0x80
325 			 */
326 			while (d != NULL && strcmp(line, "@END") != 0 && fgets_chomp(line, 255, f)) {
327 				if (strncmp(line, "/dev/", 5) == 0) {
328 					cyl = hd = sec = 0;
329 					parse_geometry_info(line, &cyl, &hd, &sec);
330 					disk_set_geometry(d, cyl, hd, sec);
331 				} else if (strncmp(line, "Part", 4) == 0) {
332 					/* ignore it */
333 				} else {
334 					if (parse_slice_info(line, &sliceno, &start, &size,
335 					    &type, &flags)) {
336 						/*
337 						fprintfo(log, "| Found slice #%d, sysid %d, "
338 						    "start %ld, size %ld\n", sliceno, type, start, size);
339 						*/
340 						slice_new(d, sliceno, type, flags, start, size);
341 					}
342 				}
343 			}
344 		}
345 	}
346 
347 	if (f != NULL)
348 		fclose(f);
349 
350 	/*
351 	 * Fix up any disk descriptions that didn't make it.
352 	 */
353 	for (d = storage_disk_first(a->s); d != NULL; d = disk_next(d)) {
354 		if (disk_get_desc(d) == NULL)
355 			disk_set_desc(d, disk_get_device_name(d));
356 	}
357 
358 	return(!failure);
359 }
360