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