helper/appliance.c

   1 /* febootstrap-supermin-helper reimplementation in C.
   2  * Copyright (C) 2009-2010 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <config.h>
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <errno.h>
  27 #include <dirent.h>
  28 #include <fnmatch.h>
  29 #include <sys/stat.h>
  30 #include <assert.h>
  31
  32 #include "error.h"
  33 #include "fts_.h"
  34 #include "xalloc.h"
  35 #include "xvasprintf.h"
  36
  37 #include "helper.h"
  38
  39 static void iterate_inputs (char **inputs, int nr_inputs, struct writer *);
  40 static void iterate_input_directory (const char *dirname, int dirfd, struct writer *);
  41 static void add_kernel_modules (const char *whitelist, const char *modpath, struct writer *);
  42 static void add_hostfiles (const char *hostfiles_file, struct writer *);
  43
  44 /* Create the appliance.
  45  *
  46  * The initrd consists of these components concatenated together:
  47  *
  48  * (1) The base skeleton appliance that we constructed at build time.
  49  *     format = plain cpio
  50  * (2) The host files which match wildcards in *.supermin.hostfiles.
  51  *     input format = plain text, output format = plain cpio
  52  * (3) The modules from modpath which are on the module whitelist.
  53  *     output format = plain cpio
  54  *
  55  * The original shell script used the external cpio program to create
  56  * parts (2) and (3), but we have decided it's going to be faster if
  57  * we just write out the data outselves.  The reasons are that
  58  * external cpio is slow (particularly when used with SELinux because
  59  * it does 512 byte reads), and the format that we're writing is
  60  * narrow and well understood, because we only care that the Linux
  61  * kernel can read it.
  62  *
  63  * This version contains some improvements over the C version written
  64  * for libguestfs, in that we can have multiple base images (or
  65  * hostfiles) or use a directory to store these files.
  66  */
  67 void
  68 create_appliance (const char *hostcpu,
  69                   char **inputs, int nr_inputs,
  70                   const char *whitelist,
  71                   const char *modpath,
  72                   const char *initrd,
  73                   const char *appliance,
  74                   struct writer *writer)
  75 {
  76   writer->wr_start (hostcpu, appliance, modpath, initrd);
  77
  78   iterate_inputs (inputs, nr_inputs, writer);
  79
  80   /* Kernel modules (3). */
  81   add_kernel_modules (whitelist, modpath, writer);
  82
  83   writer->wr_end ();
  84 }
  85
  86 /* Iterate over the inputs to find out what they are, visiting
  87  * directories if specified.
  88  */
  89 static void
  90 iterate_inputs (char **inputs, int nr_inputs, struct writer *writer)
  91 {
  92   int i;
  93   for (i = 0; i < nr_inputs; ++i) {
  94     if (verbose)
  95       print_timestamped_message ("visiting %s", inputs[i]);
  96
  97     int fd = open (inputs[i], O_RDONLY);
  98     if (fd == -1)
  99       error (EXIT_FAILURE, errno, "open: %s", inputs[i]);
 100
 101     struct stat statbuf;
 102     if (fstat (fd, &statbuf) == -1)
 103       error (EXIT_FAILURE, errno, "fstat: %s", inputs[i]);
 104
 105     /* Directory? */
 106     if (S_ISDIR (statbuf.st_mode))
 107       iterate_input_directory (inputs[i], fd, writer);
 108     else if (S_ISREG (statbuf.st_mode)) {
 109       /* Is it a cpio file? */
 110       char buf[6];
 111       if (read (fd, buf, 6) == 6 && memcmp (buf, "070701", 6) == 0)
 112         /* Yes, a cpio file.  This is a skeleton appliance, case (1). */
 113         writer->wr_cpio_file (inputs[i]);
 114       else
 115         /* No, must be hostfiles, case (2). */
 116         add_hostfiles (inputs[i], writer);
 117     }
 118     else
 119       error (EXIT_FAILURE, 0, "%s: input is not a regular file or directory",
 120              inputs[i]);
 121
 122     close (fd);
 123   }
 124 }
 125
 126 static void
 127 iterate_input_directory (const char *dirname, int dirfd, struct writer *writer)
 128 {
 129   char path[PATH_MAX];
 130   strcpy (path, dirname);
 131   size_t len = strlen (dirname);
 132   path[len++] = '/';
 133
 134   char *inputs[] = { path };
 135
 136   DIR *dir = fdopendir (dirfd);
 137   if (dir == NULL)
 138     error (EXIT_FAILURE, errno, "fdopendir: %s", dirname);
 139
 140   struct dirent *d;
 141   while ((errno = 0, d = readdir (dir)) != NULL) {
 142     if (d->d_name[0] == '.') /* ignore ., .. and any hidden files. */
 143       continue;
 144
 145     strcpy (&path[len], d->d_name);
 146     iterate_inputs (inputs, 1, writer);
 147   }
 148
 149   if (errno != 0)
 150     error (EXIT_FAILURE, errno, "readdir: %s", dirname);
 151
 152   if (closedir (dir) == -1)
 153     error (EXIT_FAILURE, errno, "closedir: %s", dirname);
 154 }
 155
 156 /* Copy kernel modules.
 157  *
 158  * Find every file under modpath.
 159  *
 160  * Exclude all *.ko files, *except* ones which match names in
 161  * the whitelist (which may contain wildcards).  Include all
 162  * other files.
 163  *
 164  * Add chosen files to the output.
 165  *
 166  * whitelist_file may be NULL, to include ALL kernel modules.
 167  */
 168 static void
 169 add_kernel_modules (const char *whitelist_file, const char *modpath,
 170                     struct writer *writer)
 171 {
 172   char **whitelist = NULL;
 173   if (whitelist_file != NULL)
 174     whitelist = load_file (whitelist_file);
 175
 176   char *paths[2] = { (char *) modpath, NULL };
 177   FTS *fts = fts_open (paths, FTS_COMFOLLOW|FTS_PHYSICAL, NULL);
 178   if (fts == NULL)
 179     error (EXIT_FAILURE, errno, "add_kernel_modules: fts_open: %s", modpath);
 180
 181   for (;;) {
 182     errno = 0;
 183     FTSENT *entry = fts_read (fts);
 184     if (entry == NULL && errno != 0)
 185       error (EXIT_FAILURE, errno, "add_kernel_modules: fts_read: %s", modpath);
 186     if (entry == NULL)
 187       break;
 188
 189     /* Ignore directories being visited in post-order. */
 190     if (entry->fts_info & FTS_DP)
 191       continue;
 192
 193     /* Is it a *.ko file? */
 194     if (entry->fts_namelen >= 3 &&
 195         entry->fts_name[entry->fts_namelen-3] == '.' &&
 196         entry->fts_name[entry->fts_namelen-2] == 'k' &&
 197         entry->fts_name[entry->fts_namelen-1] == 'o') {
 198       if (whitelist) {
 199         /* Is it a *.ko file which is on the whitelist? */
 200         size_t j;
 201         for (j = 0; whitelist[j] != NULL; ++j) {
 202           int r;
 203           r = fnmatch (whitelist[j], entry->fts_name, 0);
 204           if (r == 0) {
 205             /* It's on the whitelist, so include it. */
 206             if (verbose >= 2)
 207               fprintf (stderr, "including kernel module %s (matches whitelist entry %s)\n",
 208                        entry->fts_name, whitelist[j]);
 209             writer->wr_fts_entry (entry);
 210             break;
 211           } else if (r != FNM_NOMATCH)
 212             error (EXIT_FAILURE, 0, "internal error: fnmatch ('%s', '%s', %d) returned unexpected non-zero value %d\n",
 213                    whitelist[j], entry->fts_name, 0, r);
 214         } /* for (j) */
 215       } else { /* whitelist == NULL, always include */
 216         if (verbose >= 2)
 217           fprintf (stderr, "including kernel module %s\n", entry->fts_name);
 218         writer->wr_fts_entry (entry);
 219       }
 220     } else
 221       /* It's some other sort of file, or a directory, always include. */
 222       writer->wr_fts_entry (entry);
 223   }
 224
 225   if (fts_close (fts) == -1)
 226     error (EXIT_FAILURE, errno, "add_kernel_modules: fts_close: %s", modpath);
 227 }
 228
 229 /* Copy the host files.
 230  *
 231  * Read the list of entries in hostfiles (which may contain
 232  * wildcards).  Look them up in the filesystem, and add those files
 233  * that exist.  Ignore any files that don't exist or are not readable.
 234  */
 235 static void
 236 add_hostfiles (const char *hostfiles_file, struct writer *writer)
 237 {
 238   char **hostfiles = load_file (hostfiles_file);
 239
 240   /* Hostfiles list can contain "." before each path - ignore it.
 241    * It also contains each directory name before we enter it.  But
 242    * we don't read that until we see a wildcard for that directory.
 243    */
 244   size_t i, j;
 245   for (i = 0; hostfiles[i] != NULL; ++i) {
 246     char *hostfile = hostfiles[i];
 247     if (hostfile[0] == '.')
 248       hostfile++;
 249
 250     struct stat statbuf;
 251
 252     /* Is it a wildcard? */
 253     if (strchr (hostfile, '*') || strchr (hostfile, '?')) {
 254       char *dirname = xstrdup (hostfile);
 255       char *patt = strrchr (dirname, '/');
 256       assert (patt);
 257       *patt++ = '\0';
 258
 259       char **files = read_dir (dirname);
 260       files = filter_fnmatch (files, patt, FNM_NOESCAPE);
 261
 262       /* Add matching files. */
 263       for (j = 0; files[j] != NULL; ++j) {
 264         char *tmp = xasprintf ("%s/%s", dirname, files[j]);
 265
 266         if (verbose >= 2)
 267           fprintf (stderr, "including host file %s (matches %s)\n", tmp, patt);
 268
 269         writer->wr_file (tmp);
 270
 271         free (tmp);
 272       }
 273     }
 274     /* Else does this file/directory/whatever exist? */
 275     else if (lstat (hostfile, &statbuf) == 0) {
 276       if (verbose >= 2)
 277         fprintf (stderr, "including host file %s (directly referenced)\n",
 278                  hostfile);
 279
 280       writer->wr_file_stat (hostfile, &statbuf);
 281     } /* Ignore files that don't exist. */
 282   }
 283 }