freebsd-dev/usr.sbin/config/main.c
Craig Rodrigues 69627a0de1 Add -s option to config.
This option allows for specifying the directory to use as the location for
kernel source files. This option was ported from NetBSD.

GitHub Pull Request:   https://github.com/freebsd/freebsd/pull/18
Submitted by:          Steve Kiernan <stevek@juniper.net>, Simon Gerraty <sjg@juniper.net>
Obtained from:         Juniper Networks, Inc.
Reviewed by:           imp
Differential Revision: https://reviews.freebsd.org/D1722
Relnotes:              yes
2015-01-29 22:49:30 +00:00

779 lines
17 KiB
C

/*
* Copyright (c) 1980, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#ifndef lint
static const char copyright[] =
"@(#) Copyright (c) 1980, 1993\n\
The Regents of the University of California. All rights reserved.\n";
#endif /* not lint */
#ifndef lint
#if 0
static char sccsid[] = "@(#)main.c 8.1 (Berkeley) 6/6/93";
#endif
static const char rcsid[] =
"$FreeBSD$";
#endif /* not lint */
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/sbuf.h>
#include <sys/file.h>
#include <sys/mman.h>
#include <sys/param.h>
#include <assert.h>
#include <ctype.h>
#include <err.h>
#include <stdio.h>
#include <string.h>
#include <sysexits.h>
#include <unistd.h>
#include <dirent.h>
#include "y.tab.h"
#include "config.h"
#include "configvers.h"
#ifndef TRUE
#define TRUE (1)
#endif
#ifndef FALSE
#define FALSE (0)
#endif
#define CDIR "../compile/"
char * PREFIX;
char destdir[MAXPATHLEN];
char srcdir[MAXPATHLEN];
int debugging;
int profiling;
int found_defaults;
int incignore;
/*
* Preserve old behaviour in INCLUDE_CONFIG_FILE handling (files are included
* literally).
*/
int filebased = 0;
static void configfile(void);
static void get_srcdir(void);
static void usage(void);
static void cleanheaders(char *);
static void kernconfdump(const char *);
static void checkversion(void);
extern int yyparse(void);
struct hdr_list {
char *h_name;
struct hdr_list *h_next;
} *htab;
/*
* Config builds a set of files for building a UNIX
* system given a description of the desired system.
*/
int
main(int argc, char **argv)
{
struct stat buf;
int ch, len;
char *p;
char *kernfile;
struct includepath* ipath;
int printmachine;
printmachine = 0;
kernfile = NULL;
SLIST_INIT(&includepath);
while ((ch = getopt(argc, argv, "CI:d:gmpsVx:")) != -1)
switch (ch) {
case 'C':
filebased = 1;
break;
case 'I':
ipath = (struct includepath *) \
calloc(1, sizeof (struct includepath));
if (ipath == NULL)
err(EXIT_FAILURE, "calloc");
ipath->path = optarg;
SLIST_INSERT_HEAD(&includepath, ipath, path_next);
break;
case 'm':
printmachine = 1;
break;
case 'd':
if (*destdir == '\0')
strlcpy(destdir, optarg, sizeof(destdir));
else
errx(EXIT_FAILURE, "directory already set");
break;
case 'g':
debugging++;
break;
case 'p':
profiling++;
break;
case 's':
if (*srcdir == '\0')
strlcpy(srcdir, optarg, sizeof(srcdir));
else
errx(EXIT_FAILURE, "src directory already set");
break;
case 'V':
printf("%d\n", CONFIGVERS);
exit(0);
case 'x':
kernfile = optarg;
break;
case '?':
default:
usage();
}
argc -= optind;
argv += optind;
if (kernfile != NULL) {
kernconfdump(kernfile);
exit(EXIT_SUCCESS);
}
if (argc != 1)
usage();
PREFIX = *argv;
if (stat(PREFIX, &buf) != 0 || !S_ISREG(buf.st_mode))
err(2, "%s", PREFIX);
if (freopen("DEFAULTS", "r", stdin) != NULL) {
found_defaults = 1;
yyfile = "DEFAULTS";
} else {
if (freopen(PREFIX, "r", stdin) == NULL)
err(2, "%s", PREFIX);
yyfile = PREFIX;
}
if (*destdir != '\0') {
len = strlen(destdir);
while (len > 1 && destdir[len - 1] == '/')
destdir[--len] = '\0';
if (*srcdir == '\0')
get_srcdir();
} else {
strlcpy(destdir, CDIR, sizeof(destdir));
strlcat(destdir, PREFIX, sizeof(destdir));
}
SLIST_INIT(&cputype);
SLIST_INIT(&mkopt);
SLIST_INIT(&opt);
SLIST_INIT(&rmopts);
STAILQ_INIT(&cfgfiles);
STAILQ_INIT(&dtab);
STAILQ_INIT(&fntab);
STAILQ_INIT(&ftab);
STAILQ_INIT(&hints);
if (yyparse())
exit(3);
/*
* Ensure that required elements (machine, cpu, ident) are present.
*/
if (machinename == NULL) {
printf("Specify machine type, e.g. ``machine i386''\n");
exit(1);
}
if (ident == NULL) {
printf("no ident line specified\n");
exit(1);
}
if (SLIST_EMPTY(&cputype)) {
printf("cpu type must be specified\n");
exit(1);
}
checkversion();
if (printmachine) {
printf("%s\t%s\n",machinename,machinearch);
exit(0);
}
/* Make compile directory */
p = path((char *)NULL);
if (stat(p, &buf)) {
if (mkdir(p, 0777))
err(2, "%s", p);
} else if (!S_ISDIR(buf.st_mode))
errx(EXIT_FAILURE, "%s isn't a directory", p);
configfile(); /* put config file into kernel*/
options(); /* make options .h files */
makefile(); /* build Makefile */
makeenv(); /* build env.c */
makehints(); /* build hints.c */
headers(); /* make a lot of .h files */
cleanheaders(p);
printf("Kernel build directory is %s\n", p);
printf("Don't forget to do ``make cleandepend && make depend''\n");
exit(0);
}
/*
* get_srcdir
* determine the root of the kernel source tree
* and save that in srcdir.
*/
static void
get_srcdir(void)
{
struct stat lg, phy;
char *p, *pwd;
int i;
if (realpath("../..", srcdir) == NULL)
err(EXIT_FAILURE, "Unable to find root of source tree");
if ((pwd = getenv("PWD")) != NULL && *pwd == '/' &&
(pwd = strdup(pwd)) != NULL) {
/* Remove the last two path components. */
for (i = 0; i < 2; i++) {
if ((p = strrchr(pwd, '/')) == NULL) {
free(pwd);
return;
}
*p = '\0';
}
if (stat(pwd, &lg) != -1 && stat(srcdir, &phy) != -1 &&
lg.st_dev == phy.st_dev && lg.st_ino == phy.st_ino)
strlcpy(srcdir, pwd, MAXPATHLEN);
free(pwd);
}
}
static void
usage(void)
{
fprintf(stderr,
"usage: config [-CgmpV] [-d destdir] [-s srcdir] sysname\n");
fprintf(stderr, " config -x kernel\n");
exit(EX_USAGE);
}
/*
* get_word
* returns EOF on end of file
* NULL on end of line
* pointer to the word otherwise
*/
char *
get_word(FILE *fp)
{
static char line[80];
int ch;
char *cp;
int escaped_nl = 0;
begin:
while ((ch = getc(fp)) != EOF)
if (ch != ' ' && ch != '\t')
break;
if (ch == EOF)
return ((char *)EOF);
if (ch == '\\'){
escaped_nl = 1;
goto begin;
}
if (ch == '\n') {
if (escaped_nl){
escaped_nl = 0;
goto begin;
}
else
return (NULL);
}
cp = line;
*cp++ = ch;
/* Negation operator is a word by itself. */
if (ch == '!') {
*cp = 0;
return (line);
}
while ((ch = getc(fp)) != EOF) {
if (isspace(ch))
break;
*cp++ = ch;
}
*cp = 0;
if (ch == EOF)
return ((char *)EOF);
(void) ungetc(ch, fp);
return (line);
}
/*
* get_quoted_word
* like get_word but will accept something in double or single quotes
* (to allow embedded spaces).
*/
char *
get_quoted_word(FILE *fp)
{
static char line[256];
int ch;
char *cp;
int escaped_nl = 0;
begin:
while ((ch = getc(fp)) != EOF)
if (ch != ' ' && ch != '\t')
break;
if (ch == EOF)
return ((char *)EOF);
if (ch == '\\'){
escaped_nl = 1;
goto begin;
}
if (ch == '\n') {
if (escaped_nl){
escaped_nl = 0;
goto begin;
}
else
return (NULL);
}
cp = line;
if (ch == '"' || ch == '\'') {
int quote = ch;
escaped_nl = 0;
while ((ch = getc(fp)) != EOF) {
if (ch == quote && !escaped_nl)
break;
if (ch == '\n' && !escaped_nl) {
*cp = 0;
printf("config: missing quote reading `%s'\n",
line);
exit(2);
}
if (ch == '\\' && !escaped_nl) {
escaped_nl = 1;
continue;
}
if (ch != quote && escaped_nl)
*cp++ = '\\';
*cp++ = ch;
escaped_nl = 0;
}
} else {
*cp++ = ch;
while ((ch = getc(fp)) != EOF) {
if (isspace(ch))
break;
*cp++ = ch;
}
if (ch != EOF)
(void) ungetc(ch, fp);
}
*cp = 0;
if (ch == EOF)
return ((char *)EOF);
return (line);
}
/*
* prepend the path to a filename
*/
char *
path(const char *file)
{
char *cp = NULL;
if (file)
asprintf(&cp, "%s/%s", destdir, file);
else
cp = strdup(destdir);
return (cp);
}
/*
* Generate configuration file based on actual settings. With this mode, user
* will be able to obtain and build conifguration file with one command.
*/
static void
configfile_dynamic(struct sbuf *sb)
{
struct cputype *cput;
struct device *d;
struct opt *ol;
char *lend;
unsigned int i;
asprintf(&lend, "\\n\\\n");
assert(lend != NULL);
sbuf_printf(sb, "options\t%s%s", OPT_AUTOGEN, lend);
sbuf_printf(sb, "ident\t%s%s", ident, lend);
sbuf_printf(sb, "machine\t%s%s", machinename, lend);
SLIST_FOREACH(cput, &cputype, cpu_next)
sbuf_printf(sb, "cpu\t%s%s", cput->cpu_name, lend);
SLIST_FOREACH(ol, &mkopt, op_next)
sbuf_printf(sb, "makeoptions\t%s=%s%s", ol->op_name,
ol->op_value, lend);
SLIST_FOREACH(ol, &opt, op_next) {
if (strncmp(ol->op_name, "DEV_", 4) == 0)
continue;
sbuf_printf(sb, "options\t%s", ol->op_name);
if (ol->op_value != NULL) {
sbuf_putc(sb, '=');
for (i = 0; i < strlen(ol->op_value); i++) {
if (ol->op_value[i] == '"')
sbuf_printf(sb, "\\%c",
ol->op_value[i]);
else
sbuf_printf(sb, "%c",
ol->op_value[i]);
}
sbuf_printf(sb, "%s", lend);
} else {
sbuf_printf(sb, "%s", lend);
}
}
/*
* Mark this file as containing everything we need.
*/
STAILQ_FOREACH(d, &dtab, d_next)
sbuf_printf(sb, "device\t%s%s", d->d_name, lend);
free(lend);
}
/*
* Generate file from the configuration files.
*/
static void
configfile_filebased(struct sbuf *sb)
{
FILE *cff;
struct cfgfile *cf;
int i;
/*
* Try to read all configuration files. Since those will be present as
* C string in the macro, we have to slash their ends then the line
* wraps.
*/
STAILQ_FOREACH(cf, &cfgfiles, cfg_next) {
cff = fopen(cf->cfg_path, "r");
if (cff == NULL) {
warn("Couldn't open file %s", cf->cfg_path);
continue;
}
while ((i = getc(cff)) != EOF) {
if (i == '\n')
sbuf_printf(sb, "\\n\\\n");
else if (i == '"' || i == '\'')
sbuf_printf(sb, "\\%c", i);
else
sbuf_putc(sb, i);
}
fclose(cff);
}
}
static void
configfile(void)
{
FILE *fo;
struct sbuf *sb;
char *p;
/* Add main configuration file to the list of files to be included */
cfgfile_add(PREFIX);
p = path("config.c.new");
fo = fopen(p, "w");
if (!fo)
err(2, "%s", p);
sb = sbuf_new(NULL, NULL, 2048, SBUF_AUTOEXTEND);
assert(sb != NULL);
sbuf_clear(sb);
if (filebased) {
/* Is needed, can be used for backward compatibility. */
configfile_filebased(sb);
} else {
configfile_dynamic(sb);
}
sbuf_finish(sb);
/*
* We print first part of the template, replace our tag with
* configuration files content and later continue writing our
* template.
*/
p = strstr(kernconfstr, KERNCONFTAG);
if (p == NULL)
errx(EXIT_FAILURE, "Something went terribly wrong!");
*p = '\0';
fprintf(fo, "%s", kernconfstr);
fprintf(fo, "%s", sbuf_data(sb));
p += strlen(KERNCONFTAG);
fprintf(fo, "%s", p);
sbuf_delete(sb);
fclose(fo);
moveifchanged(path("config.c.new"), path("config.c"));
cfgfile_removeall();
}
/*
* moveifchanged --
* compare two files; rename if changed.
*/
void
moveifchanged(const char *from_name, const char *to_name)
{
char *p, *q;
int changed;
size_t tsize;
struct stat from_sb, to_sb;
int from_fd, to_fd;
changed = 0;
if ((from_fd = open(from_name, O_RDONLY)) < 0)
err(EX_OSERR, "moveifchanged open(%s)", from_name);
if ((to_fd = open(to_name, O_RDONLY)) < 0)
changed++;
if (!changed && fstat(from_fd, &from_sb) < 0)
err(EX_OSERR, "moveifchanged fstat(%s)", from_name);
if (!changed && fstat(to_fd, &to_sb) < 0)
err(EX_OSERR, "moveifchanged fstat(%s)", to_name);
if (!changed && from_sb.st_size != to_sb.st_size)
changed++;
tsize = (size_t)from_sb.st_size;
if (!changed) {
p = mmap(NULL, tsize, PROT_READ, MAP_SHARED, from_fd, (off_t)0);
if (p == MAP_FAILED)
err(EX_OSERR, "mmap %s", from_name);
q = mmap(NULL, tsize, PROT_READ, MAP_SHARED, to_fd, (off_t)0);
if (q == MAP_FAILED)
err(EX_OSERR, "mmap %s", to_name);
changed = memcmp(p, q, tsize);
munmap(p, tsize);
munmap(q, tsize);
}
if (changed) {
if (rename(from_name, to_name) < 0)
err(EX_OSERR, "rename(%s, %s)", from_name, to_name);
} else {
if (unlink(from_name) < 0)
err(EX_OSERR, "unlink(%s)", from_name);
}
}
static void
cleanheaders(char *p)
{
DIR *dirp;
struct dirent *dp;
struct file_list *fl;
struct hdr_list *hl;
size_t len;
remember("y.tab.h");
remember("setdefs.h");
STAILQ_FOREACH(fl, &ftab, f_next)
remember(fl->f_fn);
/*
* Scan the build directory and clean out stuff that looks like
* it might have been a leftover NFOO header, etc.
*/
if ((dirp = opendir(p)) == NULL)
err(EX_OSERR, "opendir %s", p);
while ((dp = readdir(dirp)) != NULL) {
len = strlen(dp->d_name);
/* Skip non-headers */
if (len < 2 || dp->d_name[len - 2] != '.' ||
dp->d_name[len - 1] != 'h')
continue;
/* Skip special stuff, eg: bus_if.h, but check opt_*.h */
if (strchr(dp->d_name, '_') &&
strncmp(dp->d_name, "opt_", 4) != 0)
continue;
/* Check if it is a target file */
for (hl = htab; hl != NULL; hl = hl->h_next) {
if (eq(dp->d_name, hl->h_name)) {
break;
}
}
if (hl)
continue;
printf("Removing stale header: %s\n", dp->d_name);
if (unlink(path(dp->d_name)) == -1)
warn("unlink %s", dp->d_name);
}
(void)closedir(dirp);
}
void
remember(const char *file)
{
char *s;
struct hdr_list *hl;
if ((s = strrchr(file, '/')) != NULL)
s = ns(s + 1);
else
s = ns(file);
if (strchr(s, '_') && strncmp(s, "opt_", 4) != 0) {
free(s);
return;
}
for (hl = htab; hl != NULL; hl = hl->h_next) {
if (eq(s, hl->h_name)) {
free(s);
return;
}
}
hl = calloc(1, sizeof(*hl));
if (hl == NULL)
err(EXIT_FAILURE, "calloc");
hl->h_name = s;
hl->h_next = htab;
htab = hl;
}
/*
* This one is quick hack. Will be probably moved to elf(3) interface.
* It takes kernel configuration file name, passes it as an argument to
* elfdump -a, which output is parsed by some UNIX tools...
*/
static void
kernconfdump(const char *file)
{
struct stat st;
FILE *fp, *pp;
int error, len, osz, r;
unsigned int i, off, size, t1, t2, align;
char *cmd, *o;
r = open(file, O_RDONLY);
if (r == -1)
err(EXIT_FAILURE, "Couldn't open file '%s'", file);
error = fstat(r, &st);
if (error == -1)
err(EXIT_FAILURE, "fstat() failed");
if (S_ISDIR(st.st_mode))
errx(EXIT_FAILURE, "'%s' is a directory", file);
fp = fdopen(r, "r");
if (fp == NULL)
err(EXIT_FAILURE, "fdopen() failed");
osz = 1024;
o = calloc(1, osz);
if (o == NULL)
err(EXIT_FAILURE, "Couldn't allocate memory");
/* ELF note section header. */
asprintf(&cmd, "/usr/bin/elfdump -c %s | grep -A 8 kern_conf"
"| tail -5 | cut -d ' ' -f 2 | paste - - - - -", file);
if (cmd == NULL)
errx(EXIT_FAILURE, "asprintf() failed");
pp = popen(cmd, "r");
if (pp == NULL)
errx(EXIT_FAILURE, "popen() failed");
free(cmd);
len = fread(o, osz, 1, pp);
pclose(pp);
r = sscanf(o, "%d%d%d%d%d", &off, &size, &t1, &t2, &align);
free(o);
if (r != 5)
errx(EXIT_FAILURE, "File %s doesn't contain configuration "
"file. Either unsupported, or not compiled with "
"INCLUDE_CONFIG_FILE", file);
r = fseek(fp, off, SEEK_CUR);
if (r != 0)
err(EXIT_FAILURE, "fseek() failed");
for (i = 0; i < size; i++) {
r = fgetc(fp);
if (r == EOF)
break;
if (r == '\0') {
assert(i == size - 1 &&
("\\0 found in the middle of a file"));
break;
}
fputc(r, stdout);
}
fclose(fp);
}
static void
badversion(int versreq)
{
fprintf(stderr, "ERROR: version of config(8) does not match kernel!\n");
fprintf(stderr, "config version = %d, ", CONFIGVERS);
fprintf(stderr, "version required = %d\n\n", versreq);
fprintf(stderr, "Make sure that /usr/src/usr.sbin/config is in sync\n");
fprintf(stderr, "with your /usr/src/sys and install a new config binary\n");
fprintf(stderr, "before trying this again.\n\n");
fprintf(stderr, "If running the new config fails check your config\n");
fprintf(stderr, "file against the GENERIC or LINT config files for\n");
fprintf(stderr, "changes in config syntax, or option/device naming\n");
fprintf(stderr, "conventions\n\n");
exit(1);
}
static void
checkversion(void)
{
FILE *ifp;
char line[BUFSIZ];
int versreq;
ifp = open_makefile_template();
while (fgets(line, BUFSIZ, ifp) != 0) {
if (*line != '%')
continue;
if (strncmp(line, "%VERSREQ=", 9) != 0)
continue;
versreq = atoi(line + 9);
if (MAJOR_VERS(versreq) == MAJOR_VERS(CONFIGVERS) &&
versreq <= CONFIGVERS)
continue;
badversion(versreq);
}
fclose(ifp);
}