xref: /dragonfly/usr.sbin/asf/asf.c (revision 6b5c5d0d)
1 /*
2  * Copyright (c) 2002, 2003 Greg Lehey
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * This software is provided by the author ``as is'' and any express
15  * or implied warranties, including, but not limited to, the implied
16  * warranties of merchantability and fitness for a particular purpose
17  * are disclaimed.  In no event shall the author be liable for any
18  * direct, indirect, incidental, special, exemplary, or consequential
19  * damages (including, but not limited to, procurement of substitute
20  * goods or services; loss of use, data, or profits; or business
21  * interruption) however caused and on any theory of liability,
22  * whether in contract, strict liability, or tort (including
23  * negligence or otherwise) arising in any way out of the use of this
24  * software, even if advised of the possibility of such damage.
25  */
26 /* $Id: asf.c,v 1.6 2003/11/04 06:38:37 green Exp $ */
27 /* $FreeBSD: src/usr.sbin/asf/asf.c,v 1.6 2003/11/04 06:38:37 green Exp $ */
28 /* $DragonFly: src/usr.sbin/asf/asf.c,v 1.4 2007/11/12 21:19:11 swildner Exp $ */
29 
30 #define MAXLINE 1024
31 #include <ctype.h>
32 #include <errno.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include <sys/file.h>
37 #include <sys/param.h>
38 #include <sys/stat.h>
39 #include <sys/wait.h>
40 #include <sys/types.h>
41 #include <fts.h>
42 #include <unistd.h>
43 
44 #define MAXTOKEN 10
45 const char *modules_path;		/* path relative to kernel
46 					 * build directory */
47 const char *outfile;			/* and where to write the output */
48 
49 /*
50  * Take a blank separated list of tokens and turn it into a list of
51  * individual nul-delimited strings.  Build a list of pointers at
52  * token, which must have enough space for the tokens.  Return the
53  * number of tokens, or -1 on error (typically a missing string
54  * delimiter).
55  */
56 static int
57 tokenize(char *cptr, char *token[], int maxtoken)
58 {
59     char delim;				/* delimiter to search for */
60     int tokennr;			/* index of this token */
61 
62     for (tokennr = 0; tokennr < maxtoken;) {
63 	while (isspace(*cptr))
64 	    cptr++;			/* skip initial white space */
65 	if ((*cptr == '\0') || (*cptr == '\n')
66 	    || (*cptr == '#'))		/* end of line */
67 	    return tokennr;		/* return number of tokens found */
68 	delim = *cptr;
69 	token[tokennr] = cptr;		/* point to it */
70 	tokennr++;			/* one more */
71 	if (tokennr == maxtoken)	/* run off the end? */
72 	    return tokennr;
73 	if ((delim == '\'') || (delim == '"')) { /* delimitered */
74 	    for (;;) {
75 		cptr++;
76 		if ((*cptr == delim)
77 		    && (cptr[-1] != '\\')) { /* found the partner */
78 		    cptr++;		/* move on past */
79 		    if (!isspace(*cptr)) /* no space after closing quote */
80 			return -1;
81 		    *cptr++ = '\0';	/* delimit */
82 		} else if ((*cptr == '\0')
83 		    || (*cptr == '\n'))	/* end of line */
84 		    return -1;
85 	    }
86 	} else {			/* not quoted */
87 	    while ((*cptr != '\0') && (!isspace(*cptr)) && (*cptr != '\n'))
88 		cptr++;
89 	    if (*cptr != '\0')		/* not end of the line, */
90 		*cptr++ = '\0';		/* delimit and move to the next */
91 	}
92     }
93     return maxtoken;			/* can't get here */
94 }
95 
96 static char *
97 findmodule(char *modules_path, const char *module_name)
98 {
99     char *const path_argv[2] = { modules_path, NULL };
100     char *module_path = NULL;
101     int module_name_len = strlen(module_name);
102     FTS *fts;
103     FTSENT *ftsent;
104 
105     if (modules_path == NULL) {
106 	fprintf(stderr,
107 	    "Can't allocate memory to traverse a path: %s (%d)\n",
108 	    strerror(errno),
109 	    errno);
110 	exit(1);
111     }
112     fts = fts_open(path_argv, FTS_PHYSICAL | FTS_NOCHDIR, NULL);
113     if (fts == NULL) {
114 	fprintf(stderr,
115 	    "Can't begin traversing path %s: %s (%d)\n",
116 	    modules_path,
117 	    strerror(errno),
118 	    errno);
119 	exit(1);
120     }
121     while ((ftsent = fts_read(fts)) != NULL) {
122 	if (ftsent->fts_info == FTS_DNR ||
123 	    ftsent->fts_info == FTS_ERR ||
124 	    ftsent->fts_info == FTS_NS) {
125 	    fprintf(stderr,
126 		"Error while traversing path %s: %s (%d)\n",
127 		modules_path,
128 		strerror(errno),
129 		errno);
130 	    exit(1);
131 	}
132 	if (ftsent->fts_info != FTS_F ||
133 	    ftsent->fts_namelen != module_name_len ||
134 	    memcmp(module_name, ftsent->fts_name, module_name_len) != 0)
135 		continue;
136 	if (asprintf(&module_path,
137 	    "%.*s",
138 	    ftsent->fts_pathlen,
139 	    ftsent->fts_path) == -1) {
140 	    fprintf(stderr,
141 		"Can't allocate memory traversing path %s: %s (%d)\n",
142 		modules_path,
143 		strerror(errno),
144 		errno);
145 	    exit(1);
146 	}
147 	break;
148     }
149     if (ftsent == NULL && errno != 0) {
150 	fprintf(stderr,
151 	    "Couldn't complete traversing path %s: %s (%d)\n",
152 	    modules_path,
153 	    strerror(errno),
154 	    errno);
155 	exit(1);
156     }
157     fts_close(fts);
158     free(modules_path);
159     return (module_path);
160 }
161 
162 static void
163 usage(const char *myname)
164 {
165     fprintf(stderr,
166 	"Usage:\n"
167 	"%s [-a] [-f] [-k] [-s] [modules-path [outfile]]\n\n"
168 	"\t-a\tappend to outfile)\n"
169 	"\t-f\tfind the module in any subdirectory of module-path\n"
170 	"\t-k\ttake input from kldstat(8)\n"
171 	"\t-s\tdon't prepend subdir for module path\n",
172 	myname);
173 }
174 
175 int
176 main(int argc, char *argv[])
177 {
178     char buf[MAXLINE];
179     FILE *kldstat;
180     FILE *objcopy;
181     FILE *out;				/* output file */
182     char ocbuf[MAXLINE];
183     int tokens;				/* number of tokens on line */
184     char basetoken[MAXLINE];
185     int i, ch;
186     const char *filemode = "w";		/* mode for outfile */
187     char cwd[MAXPATHLEN];		/* current directory */
188     char *token[MAXTOKEN];
189     int nosubdir = 0;
190     int dofind = 0;
191 
192     getcwd(cwd, MAXPATHLEN);		/* find where we are */
193     kldstat = stdin;
194     while ((ch = getopt(argc, argv, "afks")) != -1) {
195 	switch (ch) {
196 	case 'k': /* get input from kldstat(8) */
197 	    if (!(kldstat = popen("kldstat", "r"))) {
198 		perror("Can't start kldstat");
199 		return 1;
200 	    }
201 	    break;
202 	case 'a': /* append to outfile */
203 	    filemode = "a";
204 	    break;
205 	case 's': /* no subdir */
206 	    nosubdir = 1;		/* nothing */
207 	    break;
208 	case 'f': /* find .ko (recursively) */
209 	    dofind = 1;
210 	    break;
211 	default:
212 	    fprintf(stderr,
213 		    "Invalid option: %s, aborting\n",
214 		    argv[i]);
215 	    usage(argv[0]);
216 	    return 1;
217 	}
218     }
219 
220     argv += optind;
221     argc -= optind;
222 
223     if (argc >= 1) {
224 	modules_path = argv[0];
225 	argc--;
226 	argv++;
227     }
228 
229     if (argc >= 1) {
230 	outfile = argv[0];
231 	argc--;
232 	argv++;
233     }
234 
235     if (argc > 0) {
236 	fprintf(stderr,
237 	    "Extraneous startup information: \"%s\", aborting\n",
238 	    argv[0]);
239 	usage(getprogname());
240 	return 1;
241     }
242     if (modules_path == NULL)
243 	modules_path = "modules";
244     if (outfile == NULL)
245 	outfile = ".asf";
246     if ((out = fopen(outfile, filemode)) == NULL) {
247 	fprintf(stderr,
248 	    "Can't open output file %s: %s (%d)\n",
249 	    outfile,
250 	    strerror(errno),
251 	    errno);
252 	return 1;
253     }
254     while (fgets(buf, MAXLINE, kldstat)) {
255 	if ((!(strstr(buf, "kernel")))
256 	    && buf[0] != 'I') {
257 	    quad_t base;
258 	    quad_t textaddr;
259 	    quad_t dataaddr;
260 	    quad_t bssaddr;
261 
262 	    tokens = tokenize(buf, token, MAXTOKEN);
263 	    base = strtoll(token[2], NULL, 16);
264 	    if (!dofind) {
265 		strcpy(basetoken, token[4]);
266 		basetoken[strlen(basetoken) - 3] = '/';
267 		basetoken[strlen(basetoken) - 2] = '\0'; /* cut off the .ko */
268 		snprintf(ocbuf,
269 		    MAXLINE,
270 		    "/usr/bin/objdump --section-headers %s/%s%s",
271 		    modules_path,
272 		    nosubdir ? "" : basetoken,
273 		    token[4]);
274 	    } else {
275 		char *modpath;
276 
277 		modpath = findmodule(strdup(modules_path), token[4]);
278 		if (modpath == NULL)
279 		    continue;
280 		snprintf(ocbuf,
281 		    MAXLINE,
282 		    "/usr/bin/objdump --section-headers %s",
283 		    modpath);
284 		free(modpath);
285 	    }
286 	    if (!(objcopy = popen(ocbuf, "r"))) {
287 		fprintf(stderr,
288 		    "Can't start %s: %s (%d)\n",
289 		    ocbuf,
290 		    strerror(errno),
291 		    errno);
292 		return 1;
293 	    }
294 	    while (fgets(ocbuf, MAXLINE, objcopy)) {
295 		int octokens;
296 		char *octoken[MAXTOKEN];
297 
298 		octokens = tokenize(ocbuf, octoken, MAXTOKEN);
299 		if (octokens > 1) {
300 		    if (!strcmp(octoken[1], ".text"))
301 			textaddr = strtoll(octoken[3], NULL, 16) + base;
302 		    else if (!strcmp(octoken[1], ".data"))
303 			dataaddr = strtoll(octoken[3], NULL, 16) + base;
304 		    else if (!strcmp(octoken[1], ".bss"))
305 			bssaddr = strtoll(octoken[3], NULL, 16) + base;
306 		}
307 	    }
308 	    if (textaddr) {		/* we must have a text address */
309 		if (!dofind) {
310 		    fprintf(out,
311 			"add-symbol-file %s%s%s/%s%s 0x%llx",
312 			modules_path[0] != '/' ? cwd : "",
313 			modules_path[0] != '/' ? "/" : "",
314 			modules_path,
315 			nosubdir ? "" : basetoken,
316 			token[4],
317 			textaddr);
318 		} else {
319 		    char *modpath;
320 
321 		    modpath = findmodule(strdup(modules_path), token[4]);
322 		    if (modpath == NULL)
323 			continue;
324 		    fprintf(out,
325 			"add-symbol-file %s 0x%llx",
326 			modpath,
327 			textaddr);
328 		    free(modpath);
329 		}
330 		if (dataaddr)
331 		    fprintf(out, " -s .data 0x%llx", dataaddr);
332 		if (bssaddr)
333 		    fprintf(out, " -s .bss 0x%llx", bssaddr);
334 		fprintf(out, "\n");
335 	    }
336 	}
337     }
338     return 0;
339 }
340