git.ozlabs.org Git - petitboot/blob - discover/pxe-parser.c

   1
   2 #if defined(HAVE_CONFIG_H)
   3 #include "config.h"
   4 #endif
   5 #include <stdlib.h>
   6 #include <string.h>
   7
   8 #include <talloc/talloc.h>
   9 #include <url/url.h>
  10 #include <log/log.h>
  11 #include <file/file.h>
  12 #include <i18n/i18n.h>
  13
  14 #include "parser.h"
  15 #include "parser-conf.h"
  16 #include "parser-utils.h"
  17 #include "resource.h"
  18 #include "paths.h"
  19 #include "event.h"
  20 #include "user-event.h"
  21 #include "network.h"
  22
  23 static const char *pxelinux_prefix = "pxelinux.cfg/";
  24
  25 static void pxe_conf_parse_cb(struct load_url_result *result, void *data);
  26
  27 struct pxe_parser_info {
  28         struct discover_boot_option     *opt;
  29         const char                      *default_name;
  30         char                            **pxe_conf_files;
  31         struct pb_url                   *pxe_base_url;
  32         int                             current;
  33 };
  34
  35 static void pxe_finish(struct conf_context *conf)
  36 {
  37         struct pxe_parser_info *info = conf->parser_info;
  38         if (info->opt)
  39                 discover_context_add_boot_option(conf->dc, info->opt);
  40 }
  41
  42 /* We need a slightly modified version of pb_url_join, to allow for the
  43  * pxelinux "::filename" syntax for absolute URLs
  44  */
  45 static struct pb_url *pxe_url_join(void *ctx, const struct pb_url *url,
  46                 const char *s)
  47 {
  48         struct pb_url *new_url;
  49         int len;
  50
  51         len = strlen(s);
  52
  53         if (len > 2 && s[0] == ':' && s[1] == ':') {
  54                 char *tmp;
  55
  56                 if (s[2] == '/') {
  57                         /* ::/path -> /path */
  58                         tmp = talloc_strdup(ctx, s+2);
  59                 } else {
  60                         /* ::path -> /path */
  61                         tmp = talloc_strdup(ctx, s+1);
  62                         tmp[0] = '/';
  63                 }
  64
  65                 new_url = pb_url_join(ctx, url, tmp);
  66
  67                 talloc_free(tmp);
  68
  69         } else {
  70                 const char *tmp;
  71                 /* strip leading slashes */
  72                 for (tmp = s; *tmp == '/'; tmp++)
  73                         ;
  74                 new_url = pb_url_join(ctx, url, tmp);
  75         }
  76
  77         return new_url;
  78 }
  79
  80 static void pxe_append_string(struct discover_boot_option *opt,
  81                 const char *str)
  82 {
  83         if (opt->option->boot_args)
  84                 opt->option->boot_args = talloc_asprintf_append(
  85                                 opt->option->boot_args, " %s", str);
  86         else
  87                 opt->option->boot_args = talloc_strdup(opt->option, str);
  88 }
  89
  90 static char *pxe_sysappend_mac(void *ctx, uint8_t *mac)
  91 {
  92         if (!mac)
  93                 return NULL;
  94
  95         return talloc_asprintf(ctx,
  96                 "BOOTIF=01-%02x-%02x-%02x-%02x-%02x-%02x",
  97                 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
  98 }
  99
 100 static void pxe_process_sysappend(struct discover_context *ctx,
 101                 struct discover_boot_option *opt,
 102                 unsigned long val)
 103 {
 104         struct event *event = ctx->event;
 105         char *str = NULL;
 106
 107         if (!event)
 108                 return;
 109
 110         if (val & 0x2) {
 111                 uint8_t *mac = find_mac_by_name(ctx, ctx->network,
 112                                         event->device);
 113                 str = pxe_sysappend_mac(ctx, mac);
 114                 if (str) {
 115                         pxe_append_string(opt, str);
 116                         talloc_free(str);
 117                 }
 118                 val &= ~0x2;
 119         }
 120
 121         if (val)
 122                 pb_log("pxe: unsupported features requested in "
 123                                 "ipappend/sysappend: 0x%04lx", val);
 124
 125 }
 126
 127 static void pxe_process_pair(struct conf_context *ctx,
 128                 const char *name, char *value)
 129 {
 130         struct pxe_parser_info *parser_info = ctx->parser_info;
 131         struct discover_boot_option *opt = parser_info->opt;
 132         struct pb_url *url;
 133
 134         /* quirk in the syslinux config format: initrd can be separated
 135          * by an '=' */
 136         if (!name && !strncasecmp(value, "initrd=", strlen("initrd="))) {
 137                 name = "initrd";
 138                 value += strlen("initrd=");
 139         }
 140
 141         if (!name)
 142                 return;
 143
 144         if (streq(name, "DEFAULT")) {
 145                 parser_info->default_name = talloc_strdup(parser_info, value);
 146                 return;
 147         }
 148
 149         if (streq(name, "LABEL")) {
 150                 if (opt)
 151                         pxe_finish(ctx);
 152
 153                 opt = discover_boot_option_create(ctx->dc, ctx->dc->device);
 154
 155                 opt->option->name = talloc_strdup(opt, value);
 156                 opt->option->id = talloc_asprintf(opt, "%s@%p",
 157                                 ctx->dc->device->device->id, opt);
 158
 159                 opt->option->is_default = parser_info->default_name &&
 160                                         streq(parser_info->default_name, value);
 161
 162                 parser_info->opt = opt;
 163                 return;
 164         }
 165
 166         /* all other parameters need an option */
 167         if (!opt)
 168                 return;
 169
 170         if (streq(name, "KERNEL")) {
 171                 url = pxe_url_join(ctx->dc, ctx->dc->conf_url, value);
 172                 opt->boot_image = create_url_resource(opt, url);
 173
 174         } else if (streq(name, "INITRD")) {
 175                 url = pxe_url_join(ctx->dc, ctx->dc->conf_url, value);
 176                 opt->initrd = create_url_resource(opt, url);
 177
 178         } else if (streq(name, "APPEND")) {
 179                 char *str, *end;
 180
 181                 pxe_append_string(opt, value);
 182
 183                 str = strcasestr(value, "INITRD=");
 184                 if (str) {
 185                         str += strlen("INITRD=");
 186                         end = strchrnul(str, ' ');
 187                         *end = '\0';
 188
 189                         url = pxe_url_join(ctx->dc, ctx->dc->conf_url, str);
 190                         opt->initrd = create_url_resource(opt, url);
 191                 }
 192         } else if (streq(name, "SYSAPPEND") || streq(name, "IPAPPEND")) {
 193                 unsigned long type;
 194                 char *end;
 195
 196                 type = strtoul(value, &end, 10);
 197                 if (end != value && !(*end))
 198                         pxe_process_sysappend(ctx->dc, opt, type);
 199
 200         } else if (streq(name, "DTB") || streq(name, "FDT")) {
 201                 url = pxe_url_join(ctx->dc, ctx->dc->conf_url, value);
 202                 opt->dtb = create_url_resource(opt, url);
 203         }
 204
 205 }
 206
 207 static void pxe_load_next_filename(struct conf_context *conf)
 208 {
 209         struct pxe_parser_info *info = conf->parser_info;
 210         struct pb_url *url;
 211
 212         if (!info->pxe_conf_files)
 213                 return;
 214
 215         for (; info->pxe_conf_files[info->current]; info->current++) {
 216                 url = pb_url_join(conf->dc, info->pxe_base_url,
 217                                   info->pxe_conf_files[info->current]);
 218                 if (!url)
 219                         continue;
 220
 221                 if (load_url_async(conf, url, pxe_conf_parse_cb, conf))
 222                         break;
 223         }
 224
 225         return;
 226 }
 227
 228 /*
 229  * Callback for asynchronous loads from pxe_parse()
 230  * @param result Result of load_url_async()
 231  * @param data   Pointer to associated conf_context
 232  */
 233 static void pxe_conf_parse_cb(struct load_url_result *result, void *data)
 234 {
 235         struct conf_context *conf = data;
 236         struct device_handler *handler;
 237         struct boot_status status = {0};
 238         struct pxe_parser_info *info;
 239         char *buf = NULL;
 240         int len, rc = 0;
 241
 242         if (!data)
 243                 return;
 244
 245         if (result && result->status == LOAD_OK)
 246                 rc = read_file(conf, result->local, &buf, &len);
 247         if (!result || result->status != LOAD_OK || rc) {
 248                 /* This load failed so try the next available filename */
 249                 info = conf->parser_info;
 250                 if (!info->pxe_conf_files)
 251                         return;
 252
 253                 info->current++;
 254                 pxe_load_next_filename(conf);
 255                 if (info->pxe_conf_files[info->current] == NULL) {
 256                         /* Nothing left to try */
 257                         goto out_clean;
 258                 }
 259                 return;
 260         }
 261
 262         /*
 263          * Parse the first successfully downloaded file. We only want to parse
 264          * the first because otherwise we could parse options from both a
 265          * machine-specific config and a 'fallback' default config
 266          */
 267
 268         conf_parse_buf(conf, buf, len);
 269
 270         /* We may be called well after the original caller of iterate_parsers(),
 271          * commit any new boot options ourselves */
 272         handler = talloc_parent(conf);
 273         device_handler_discover_context_commit(handler, conf->dc);
 274
 275         status.type = BOOT_STATUS_INFO;
 276         /*
 277          * TRANSLATORS: the format specifier in this string in an IP address,
 278          * eg. 192.168.1.1
 279          */
 280         status.message = talloc_asprintf(conf, _("pxe: parsed config for %s"),
 281                                         conf->dc->conf_url->host);
 282         device_handler_boot_status(handler, &status);
 283
 284         talloc_free(buf);
 285 out_clean:
 286         if (result->cleanup_local)
 287                 unlink(result->local);
 288         talloc_free(conf);
 289 }
 290
 291 /**
 292  * Return a new conf_context and increment the talloc reference count on
 293  * the discover_context struct.
 294  * @param  ctx  Parent talloc context
 295  * @param  orig Original discover_context
 296  * @return      Pointer to new conf_context
 297  */
 298 static struct conf_context *copy_context(void *ctx, struct discover_context *dc)
 299 {
 300         struct pxe_parser_info *info;
 301         struct conf_context *conf;
 302
 303         conf = talloc_zero(ctx, struct conf_context);
 304
 305         if (!conf)
 306                 return NULL;
 307
 308         conf->get_pair = conf_get_pair_space;
 309         conf->process_pair = pxe_process_pair;
 310         conf->finish = pxe_finish;
 311         info = talloc_zero(conf, struct pxe_parser_info);
 312         if (!info) {
 313                 talloc_free(conf);
 314                 return NULL;
 315         }
 316         conf->parser_info = info;
 317
 318         /*
 319          * The discover_context may be freed once pxe_parse() returns, but the
 320          * callback will still need it. Take a reference so that that it will
 321          * persist until the last callback completes.
 322          */
 323         conf->dc = talloc_reference(conf, dc);
 324
 325         return conf;
 326 }
 327
 328 static int pxe_parse(struct discover_context *dc)
 329 {
 330         struct pb_url *pxe_base_url;
 331         struct conf_context *conf = NULL;
 332         struct load_url_result *result;
 333         void *ctx = talloc_parent(dc);
 334         struct pxe_parser_info *info;
 335         char **pxe_conf_files;
 336         bool complete_url;
 337
 338         /* Expects dhcp event parameters to support network boot */
 339         if (!dc->event)
 340                 return -1;
 341
 342         dc->conf_url = user_event_parse_conf_url(dc, dc->event, &complete_url);
 343         if (!dc->conf_url)
 344                 return -1;
 345
 346         /*
 347          * Retrieving PXE configs over the network can take some time depending
 348          * on factors such as slow network, malformed paths, bad DNS, and
 349          * overzealous firewalls. Instead of blocking the discover server while
 350          * we wait for these, spawn an asynchronous job that will attempt to
 351          * retrieve each possible URL until it successfully finds one, and
 352          * parse and process the resulting file in a callback.
 353          */
 354         conf = copy_context(ctx, dc);
 355         if (!conf)
 356                 return -1;
 357
 358         if (complete_url) {
 359                 /* we have a complete URL; use this and we're done. */
 360                 result = load_url_async(conf->dc, conf->dc->conf_url,
 361                                         pxe_conf_parse_cb, conf);
 362                 if (!result) {
 363                         pb_log("load_url_async fails for %s\n",
 364                                         dc->conf_url->path);
 365                         goto out_conf;
 366                 }
 367         } else {
 368                 pxe_conf_files = user_event_parse_conf_filenames(dc, dc->event);
 369                 if (!pxe_conf_files)
 370                         goto out_conf;
 371
 372                 pxe_base_url = pb_url_join(dc, dc->conf_url, pxelinux_prefix);
 373                 if (!pxe_base_url)
 374                         goto out_pxe_conf;
 375
 376                 info = conf->parser_info;
 377                 info->pxe_conf_files = pxe_conf_files;
 378                 info->pxe_base_url = pxe_base_url;
 379
 380                 pxe_load_next_filename(conf);
 381         }
 382
 383         return 0;
 384
 385 out_pxe_conf:
 386         talloc_free(pxe_conf_files);
 387 out_conf:
 388         talloc_free(conf);
 389         return -1;
 390 }
 391
 392 static struct parser pxe_parser = {
 393         .name                   = "pxe",
 394         .parse                  = pxe_parse,
 395 };
 396
 397 register_parser(pxe_parser);