kldxref.c revision 134358
1/* 2 * Copyright (c) 2000, Boris Popov 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 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by Boris Popov. 16 * 4. Neither the name of the author nor the names of any co-contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $FreeBSD: head/usr.sbin/kldxref/kldxref.c 134358 2004-08-27 00:51:21Z iedowse $ 33 */ 34 35#include <sys/types.h> 36#include <sys/param.h> 37#include <sys/exec.h> 38#include <sys/queue.h> 39#include <sys/kernel.h> 40#include <sys/reboot.h> 41#include <sys/linker.h> 42#include <sys/stat.h> 43#include <sys/module.h> 44#define FREEBSD_ELF 45#include <link.h> 46#include <err.h> 47#include <fts.h> 48#include <string.h> 49#include <machine/elf.h> 50#include <stdio.h> 51#include <stdlib.h> 52#include <unistd.h> 53#include <errno.h> 54 55#include "ef.h" 56 57#define MAXRECSIZE 1024 58#define check(val) if ((error = (val)) != 0) break 59 60#ifndef min 61#define min(a,b) (((a)<(b)) ? (a) : (b)) 62#endif 63 64struct mod_info { 65 char* mi_name; 66 int mi_ver; 67 SLIST_ENTRY(mod_info) mi_next; 68}; 69 70#ifdef notnow 71struct kld_info { 72 char* k_filename; 73 SLIST_HEAD(mod_list_head, mod_info) k_modules; 74 SLIST_ENTRY(kld_info) k_next; 75}; 76 77SLIST_HEAD(kld_list_head, kld_info) kldlist; 78#endif 79 80static int dflag, verbose; 81 82FILE *fxref; 83 84static const char *xref_file = "linker.hints"; 85 86static char recbuf[MAXRECSIZE]; 87static int recpos, reccnt; 88 89void maketempfile(char *, const char *); 90static void usage(void); 91 92static void 93intalign(void) 94{ 95 recpos = (recpos + sizeof(int) - 1) & ~(sizeof(int) - 1); 96} 97 98static void 99record_start(void) 100{ 101 recpos = 0; 102 memset(recbuf, 0, MAXRECSIZE); 103} 104 105static int 106record_end(void) 107{ 108 if (dflag || recpos == 0) 109 return 0; 110 reccnt++; 111 intalign(); 112 fwrite(&recpos, sizeof(recpos), 1, fxref); 113 return fwrite(recbuf, recpos, 1, fxref) != 1 ? errno : 0; 114} 115 116static int 117record_buf(const void *buf, int size) 118{ 119 if (MAXRECSIZE - recpos < size) 120 errx(1, "record buffer overflow"); 121 memcpy(recbuf + recpos, buf, size); 122 recpos += size; 123 return 0; 124} 125 126static int 127record_int(int val) 128{ 129 intalign(); 130 return record_buf(&val, sizeof(val)); 131} 132 133static int 134record_byte(u_char val) 135{ 136 return record_buf(&val, sizeof(val)); 137} 138 139static int 140record_string(const char *str) 141{ 142 int len = strlen(str); 143 int error; 144 145 if (dflag) 146 return 0; 147 error = record_byte(len); 148 if (error) 149 return error; 150 return record_buf(str, len); 151} 152 153static int 154parse_entry(struct mod_metadata *md, const char *cval, 155 struct elf_file *ef, const char *kldname) 156{ 157 struct mod_depend mdp; 158 struct mod_version mdv; 159 Elf_Off data = (Elf_Off)md->md_data; 160 int error = 0; 161 162 record_start(); 163 switch (md->md_type) { 164 case MDT_DEPEND: 165 if (!dflag) 166 break; 167 check(EF_SEG_READ(ef, data, sizeof(mdp), &mdp)); 168 printf(" depends on %s.%d (%d,%d)\n", cval, 169 mdp.md_ver_preferred, mdp.md_ver_minimum, mdp.md_ver_maximum); 170 break; 171 case MDT_VERSION: 172 check(EF_SEG_READ(ef, data, sizeof(mdv), &mdv)); 173 record_int(MDT_VERSION); 174 record_string(cval); 175 record_int(mdv.mv_version); 176 record_string(kldname); 177 if (!dflag) 178 break; 179 printf(" interface %s.%d\n", cval, mdv.mv_version); 180 break; 181 case MDT_MODULE: 182 record_int(MDT_MODULE); 183 record_string(cval); 184 record_string(kldname); 185 if (!dflag) 186 break; 187 printf(" module %s\n", cval); 188 break; 189 default: 190 warnx("unknown metdata record %d in file %s", md->md_type, kldname); 191 } 192 if (!error) 193 record_end(); 194 return error; 195} 196 197static int 198read_kld(char *filename, char *kldname) 199{ 200 struct mod_metadata md; 201 struct elf_file ef; 202/* struct kld_info *kip; 203 struct mod_info *mip;*/ 204 void **p, **orgp; 205 int error, eftype, nmlen; 206 long start, finish, entries; 207 char kldmodname[MAXMODNAME + 1], cval[MAXMODNAME + 1], *cp; 208 209 if (verbose || dflag) 210 printf("%s\n", filename); 211 error = ef_open(filename, &ef, verbose); 212 if (error) { 213 if (verbose) 214 warnc(error, "elf_open(%s)", filename); 215 return error; 216 } 217 eftype = EF_GET_TYPE(&ef); 218 if (eftype != EFT_KLD && eftype != EFT_KERNEL) { 219 EF_CLOSE(&ef); 220 return 0; 221 } 222 if (!dflag) { 223 cp = strrchr(kldname, '.'); 224 nmlen = cp ? min(MAXMODNAME, cp - kldname) : 225 min(MAXMODNAME, strlen(kldname)); 226 strncpy(kldmodname, kldname, nmlen); 227 kldmodname[nmlen] = '\0'; 228/* fprintf(fxref, "%s:%s:%d\n", kldmodname, kldname, 0);*/ 229 } 230 do { 231 check(EF_LOOKUP_SET(&ef, MDT_SETNAME, &start, &finish, 232 &entries)); 233 check(EF_SEG_READ_ENTRY_REL(&ef, start, sizeof(*p) * entries, 234 (void *)&p)); 235 orgp = p; 236 while(entries--) { 237 check(EF_SEG_READ_REL(&ef, (Elf_Off)*p, sizeof(md), 238 &md)); 239 p++; 240 check(EF_SEG_READ(&ef, (Elf_Off)md.md_cval, 241 sizeof(cval), cval)); 242 cval[MAXMODNAME] = '\0'; 243 parse_entry(&md, cval, &ef, kldname); 244 } 245 if (error) 246 warnc(error, "error while reading %s", filename); 247 free(orgp); 248 } while(0); 249 EF_CLOSE(&ef); 250 return error; 251} 252 253void 254maketempfile(char *dest, const char *root) 255{ 256 char *p; 257 258 strncpy(dest, root, MAXPATHLEN - 1); 259 dest[MAXPATHLEN] = '\0'; 260 261 if ((p = strrchr(dest, '/')) != 0) 262 p++; 263 else 264 p = dest; 265 strcpy(p, "lhint.XXXXXX"); 266 if (mkstemp(dest) == -1) 267 err(1, "%s", dest); 268} 269 270static char xrefname[MAXPATHLEN], tempname[MAXPATHLEN]; 271 272int 273main(int argc, char *argv[]) 274{ 275 FTS *ftsp; 276 FTSENT *p; 277 int opt, fts_options, ival; 278 struct stat sb; 279 280 fts_options = FTS_PHYSICAL; 281/* SLIST_INIT(&kldlist);*/ 282 283 while ((opt = getopt(argc, argv, "Rdf:v")) != -1) { 284 switch (opt) { 285 case 'd': 286 dflag = 1; 287 break; 288 case 'f': 289 xref_file = optarg; 290 break; 291 case 'v': 292 verbose++; 293 break; 294 case 'R': 295 fts_options |= FTS_COMFOLLOW; 296 break; 297 default: 298 usage(); 299 /* NOTREACHED */ 300 } 301 } 302 if (argc - optind < 1) 303 usage(); 304 argc -= optind; 305 argv += optind; 306 307 if (stat(argv[0], &sb) != 0) 308 err(1, "%s", argv[0]); 309 if ((sb.st_mode & S_IFDIR) == 0) { 310 errno = ENOTDIR; 311 err(1, "%s", argv[0]); 312 } 313 314 ftsp = fts_open(argv, fts_options, 0); 315 if (ftsp == NULL) 316 exit(1); 317 318 for (;;) { 319 p = fts_read(ftsp); 320 if ((p == NULL || p->fts_info == FTS_D) && !dflag && fxref) { 321 fclose(fxref); 322 if (reccnt) { 323 rename(tempname, xrefname); 324 } else { 325 unlink(tempname); 326 unlink(xrefname); 327 } 328 } 329 if (p == NULL) 330 break; 331 if (p && p->fts_info == FTS_D && !dflag) { 332 snprintf(xrefname, sizeof(xrefname), "%s/%s", 333 ftsp->fts_path, xref_file); 334 maketempfile(tempname, ftsp->fts_path); 335 fxref = fopen(tempname, "w+t"); 336 if (fxref == NULL) 337 err(1, "can't create %s", tempname); 338 ival = 1; 339 fwrite(&ival, sizeof(ival), 1, fxref); 340 reccnt = 0; 341 } 342 if (p->fts_info != FTS_F) 343 continue; 344 read_kld(p->fts_path, p->fts_name); 345 } 346 fts_close(ftsp); 347 return 0; 348} 349 350static void 351usage(void) 352{ 353 354 fprintf(stderr, "%s\n", 355 "usage: kldxref [-Rdv] [-f hintsfile] path ..." 356 ); 357 exit(1); 358} 359