cdfee483767e449c885d0ebf3db3671040a4c78f
[petitboot] / discover / device-handler.c
1
2 #include <assert.h>
3 #include <stdlib.h>
4 #include <unistd.h>
5 #include <string.h>
6 #include <errno.h>
7 #include <sys/stat.h>
8 #include <sys/wait.h>
9
10 #include <pb-config/pb-config.h>
11 #include <talloc/talloc.h>
12 #include <list/list.h>
13 #include <log/log.h>
14 #include <types/types.h>
15 #include <system/system.h>
16 #include <process/process.h>
17 #include <url/url.h>
18
19 #include "device-handler.h"
20 #include "discover-server.h"
21 #include "event.h"
22 #include "parser.h"
23 #include "resource.h"
24 #include "paths.h"
25 #include "boot.h"
26
27 struct device_handler {
28         struct discover_server  *server;
29         int                     dry_run;
30
31         struct discover_device  **devices;
32         unsigned int            n_devices;
33
34         struct waitset          *waitset;
35         struct waiter           *timeout_waiter;
36         bool                    autoboot_enabled;
37         unsigned int            sec_to_boot;
38
39         struct discover_boot_option *default_boot_option;
40         struct list             unresolved_boot_options;
41 };
42
43 static int mount_device(struct discover_device *dev);
44 static int umount_device(struct discover_device *dev);
45
46 void discover_context_add_boot_option(struct discover_context *ctx,
47                 struct discover_boot_option *boot_option)
48 {
49         boot_option->source = ctx->parser;
50         list_add_tail(&ctx->boot_options, &boot_option->list);
51         talloc_steal(ctx, boot_option);
52 }
53
54 /**
55  * device_handler_get_device_count - Get the count of current handler devices.
56  */
57
58 int device_handler_get_device_count(const struct device_handler *handler)
59 {
60         return handler->n_devices;
61 }
62
63 /**
64  * device_handler_get_device - Get a handler device by index.
65  */
66
67 const struct discover_device *device_handler_get_device(
68         const struct device_handler *handler, unsigned int index)
69 {
70         if (index >= handler->n_devices) {
71                 assert(0 && "bad index");
72                 return NULL;
73         }
74
75         return handler->devices[index];
76 }
77
78 struct discover_boot_option *discover_boot_option_create(
79                 struct discover_context *ctx,
80                 struct discover_device *device)
81 {
82         struct discover_boot_option *opt;
83
84         opt = talloc_zero(ctx, struct discover_boot_option);
85         opt->option = talloc_zero(opt, struct boot_option);
86         opt->device = device;
87
88         return opt;
89 }
90
91 static int device_match_uuid(struct discover_device *dev, const char *uuid)
92 {
93         return dev->uuid && !strcmp(dev->uuid, uuid);
94 }
95
96 static int device_match_label(struct discover_device *dev, const char *label)
97 {
98         return dev->label && !strcmp(dev->label, label);
99 }
100
101 static int device_match_id(struct discover_device *dev, const char *id)
102 {
103         return !strcmp(dev->device->id, id);
104 }
105
106 static struct discover_device *device_lookup(
107                 struct device_handler *device_handler,
108                 int (match_fn)(struct discover_device *, const char *),
109                 const char *str)
110 {
111         struct discover_device *dev;
112         unsigned int i;
113
114         if (!str)
115                 return NULL;
116
117         for (i = 0; i < device_handler->n_devices; i++) {
118                 dev = device_handler->devices[i];
119
120                 if (match_fn(dev, str))
121                         return dev;
122         }
123
124         return NULL;
125 }
126
127 struct discover_device *device_lookup_by_name(struct device_handler *handler,
128                 const char *name)
129 {
130         if (!strncmp(name, "/dev/", strlen("/dev/")))
131                 name += strlen("/dev/");
132
133         return device_lookup_by_id(handler, name);
134 }
135
136 struct discover_device *device_lookup_by_uuid(
137                 struct device_handler *device_handler,
138                 const char *uuid)
139 {
140         return device_lookup(device_handler, device_match_uuid, uuid);
141 }
142
143 struct discover_device *device_lookup_by_label(
144                 struct device_handler *device_handler,
145                 const char *label)
146 {
147         return device_lookup(device_handler, device_match_label, label);
148 }
149
150 struct discover_device *device_lookup_by_id(
151                 struct device_handler *device_handler,
152                 const char *id)
153 {
154         return device_lookup(device_handler, device_match_id, id);
155 }
156
157 void device_handler_destroy(struct device_handler *handler)
158 {
159         talloc_free(handler);
160 }
161
162 static int destroy_device(void *arg)
163 {
164         struct discover_device *dev = arg;
165
166         umount_device(dev);
167
168         return 0;
169 }
170
171 struct discover_device *discover_device_create(struct device_handler *handler,
172                 const char *id)
173 {
174         struct discover_device *dev;
175
176         dev = device_lookup_by_id(handler, id);
177         if (dev)
178                 return dev;
179
180         dev = talloc_zero(handler, struct discover_device);
181         dev->device = talloc_zero(dev, struct device);
182         dev->device->id = talloc_strdup(dev->device, id);
183         list_init(&dev->params);
184         list_init(&dev->boot_options);
185
186         talloc_set_destructor(dev, destroy_device);
187
188         return dev;
189 }
190
191 struct discover_device_param {
192         char                    *name;
193         char                    *value;
194         struct list_item        list;
195 };
196
197 void discover_device_set_param(struct discover_device *device,
198                 const char *name, const char *value)
199 {
200         struct discover_device_param *param;
201         bool found = false;
202
203         list_for_each_entry(&device->params, param, list) {
204                 if (!strcmp(param->name, name)) {
205                         found = true;
206                         break;
207                 }
208         }
209
210         if (!found) {
211                 if (!value)
212                         return;
213                 param = talloc(device, struct discover_device_param);
214                 param->name = talloc_strdup(param, name);
215                 list_add(&device->params, &param->list);
216         } else {
217                 if (!value) {
218                         list_remove(&param->list);
219                         talloc_free(param);
220                         return;
221                 }
222                 talloc_free(param->value);
223         }
224
225         param->value = talloc_strdup(param, value);
226 }
227
228 const char *discover_device_get_param(struct discover_device *device,
229                 const char *name)
230 {
231         struct discover_device_param *param;
232
233         list_for_each_entry(&device->params, param, list) {
234                 if (!strcmp(param->name, name))
235                         return param->name;
236         }
237         return NULL;
238 }
239
240 struct device_handler *device_handler_init(struct discover_server *server,
241                 struct waitset *waitset, int dry_run)
242 {
243         struct device_handler *handler;
244
245         handler = talloc_zero(NULL, struct device_handler);
246         handler->server = server;
247         handler->waitset = waitset;
248         handler->dry_run = dry_run;
249         handler->autoboot_enabled = config_get()->autoboot_enabled;
250
251         list_init(&handler->unresolved_boot_options);
252
253         /* set up our mount point base */
254         pb_mkdir_recursive(mount_base());
255
256         parser_init();
257
258         return handler;
259 }
260
261 void device_handler_remove(struct device_handler *handler,
262                 struct discover_device *device)
263 {
264         unsigned int i;
265
266         for (i = 0; i < handler->n_devices; i++)
267                 if (handler->devices[i] == device)
268                         break;
269
270         if (i == handler->n_devices) {
271                 talloc_free(device);
272                 return;
273         }
274
275         handler->n_devices--;
276         memmove(&handler->devices[i], &handler->devices[i + 1],
277                 (handler->n_devices - i) * sizeof(handler->devices[0]));
278         handler->devices = talloc_realloc(handler, handler->devices,
279                 struct discover_device *, handler->n_devices);
280
281         if (device->notified)
282                 discover_server_notify_device_remove(handler->server,
283                                                         device->device);
284
285         talloc_free(device);
286 }
287
288 static void boot_status(void *arg, struct boot_status *status)
289 {
290         struct device_handler *handler = arg;
291
292         discover_server_notify_boot_status(handler->server, status);
293 }
294
295 static void countdown_status(struct device_handler *handler,
296                 struct discover_boot_option *opt, unsigned int sec)
297 {
298         struct boot_status status;
299
300         status.type = BOOT_STATUS_INFO;
301         status.progress = -1;
302         status.detail = NULL;
303         status.message = talloc_asprintf(handler,
304                         "Booting %s in %u sec", opt->option->name, sec);
305
306         discover_server_notify_boot_status(handler->server, &status);
307
308         talloc_free(status.message);
309 }
310
311 static int default_timeout(void *arg)
312 {
313         struct device_handler *handler = arg;
314         struct discover_boot_option *opt;
315
316         if (!handler->default_boot_option)
317                 return 0;
318
319         opt = handler->default_boot_option;
320
321         if (handler->sec_to_boot) {
322                 countdown_status(handler, opt, handler->sec_to_boot);
323                 handler->sec_to_boot--;
324                 handler->timeout_waiter = waiter_register_timeout(
325                                                 handler->waitset, 1000,
326                                                 default_timeout, handler);
327                 return 0;
328         }
329
330         pb_log("Timeout expired, booting default option %s\n", opt->option->id);
331
332         boot(handler, handler->default_boot_option, NULL,
333                         handler->dry_run, boot_status, handler);
334         return 0;
335 }
336
337 static void set_default(struct device_handler *handler,
338                 struct discover_boot_option *opt)
339 {
340         if (handler->default_boot_option)
341                 return;
342
343         if (!handler->autoboot_enabled)
344                 return;
345
346         handler->default_boot_option = opt;
347         handler->sec_to_boot = config_get()->autoboot_timeout_sec;
348
349         pb_log("Boot option %s set as default, timeout %u sec.\n",
350                opt->option->id, handler->sec_to_boot);
351
352         default_timeout(handler);
353 }
354
355 static bool resource_is_resolved(struct resource *res)
356 {
357         return !res || res->resolved;
358 }
359
360 /* We only use this in an assert, which will disappear if we're compiling
361  * with NDEBUG, so we need the 'used' attribute for these builds */
362 static bool __attribute__((used)) boot_option_is_resolved(
363                 struct discover_boot_option *opt)
364 {
365         return resource_is_resolved(opt->boot_image) &&
366                 resource_is_resolved(opt->initrd) &&
367                 resource_is_resolved(opt->dtb) &&
368                 resource_is_resolved(opt->icon);
369 }
370
371 static bool resource_resolve(struct resource *res, const char *name,
372                 struct discover_boot_option *opt,
373                 struct device_handler *handler)
374 {
375         struct parser *parser = opt->source;
376
377         if (resource_is_resolved(res))
378                 return true;
379
380         pb_log("Attempting to resolve resource %s->%s with parser %s\n",
381                         opt->option->id, name, parser->name);
382         parser->resolve_resource(handler, res);
383
384         return res->resolved;
385 }
386
387 static bool boot_option_resolve(struct discover_boot_option *opt,
388                 struct device_handler *handler)
389 {
390         return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
391                 resource_resolve(opt->initrd, "initrd", opt, handler) &&
392                 resource_resolve(opt->dtb, "dtb", opt, handler) &&
393                 resource_resolve(opt->icon, "icon", opt, handler);
394 }
395
396 static void boot_option_finalise(struct device_handler *handler,
397                 struct discover_boot_option *opt)
398 {
399         assert(boot_option_is_resolved(opt));
400
401         /* check that the parsers haven't set any of the final data */
402         assert(!opt->option->boot_image_file);
403         assert(!opt->option->initrd_file);
404         assert(!opt->option->dtb_file);
405         assert(!opt->option->icon_file);
406         assert(!opt->option->device_id);
407
408         if (opt->boot_image)
409                 opt->option->boot_image_file = opt->boot_image->url->full;
410         if (opt->initrd)
411                 opt->option->initrd_file = opt->initrd->url->full;
412         if (opt->dtb)
413                 opt->option->dtb_file = opt->dtb->url->full;
414         if (opt->icon)
415                 opt->option->icon_file = opt->icon->url->full;
416
417         opt->option->device_id = opt->device->device->id;
418
419         if (opt->option->is_default)
420                 set_default(handler, opt);
421 }
422
423 static void notify_boot_option(struct device_handler *handler,
424                 struct discover_boot_option *opt)
425 {
426         struct discover_device *dev = opt->device;
427
428         if (!dev->notified)
429                 discover_server_notify_device_add(handler->server,
430                                                   opt->device->device);
431         dev->notified = true;
432         discover_server_notify_boot_option_add(handler->server, opt->option);
433 }
434
435 static void process_boot_option_queue(struct device_handler *handler)
436 {
437         struct discover_boot_option *opt, *tmp;
438
439         list_for_each_entry_safe(&handler->unresolved_boot_options,
440                         opt, tmp, list) {
441
442                 pb_log("queue: attempting resolution for %s\n",
443                                 opt->option->id);
444
445                 if (!boot_option_resolve(opt, handler))
446                         continue;
447
448                 pb_log("\tresolved!\n");
449
450                 list_remove(&opt->list);
451                 list_add_tail(&opt->device->boot_options, &opt->list);
452                 talloc_steal(opt->device, opt);
453                 boot_option_finalise(handler, opt);
454                 notify_boot_option(handler, opt);
455         }
456 }
457
458 struct discover_context *device_handler_discover_context_create(
459                 struct device_handler *handler,
460                 struct discover_device *device)
461 {
462         struct discover_context *ctx;
463
464         ctx = talloc(handler, struct discover_context);
465         ctx->device = device;
466         ctx->conf_url = NULL;
467         list_init(&ctx->boot_options);
468
469         return ctx;
470 }
471
472 /**
473  * context_commit - Commit a temporary discovery context to the handler,
474  * and notify the clients about any new options / devices
475  */
476 void device_handler_discover_context_commit(struct device_handler *handler,
477                 struct discover_context *ctx)
478 {
479         struct discover_device *dev = ctx->device;
480         struct discover_boot_option *opt, *tmp;
481
482         if (!device_lookup_by_id(handler, dev->device->id))
483                 device_handler_add_device(handler, dev);
484
485         /* move boot options from the context to the device */
486         list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
487                 list_remove(&opt->list);
488
489                 if (boot_option_resolve(opt, handler)) {
490                         pb_log("boot option %s is resolved, "
491                                         "sending to clients\n",
492                                         opt->option->id);
493                         list_add_tail(&dev->boot_options, &opt->list);
494                         talloc_steal(dev, opt);
495                         boot_option_finalise(handler, opt);
496                         notify_boot_option(handler, opt);
497                 } else {
498                         if (!opt->source->resolve_resource) {
499                                 pb_log("parser %s gave us an unresolved "
500                                         "resource (%s), but no way to "
501                                         "resolve it\n",
502                                         opt->source->name, opt->option->id);
503                                 talloc_free(opt);
504                         } else {
505                                 pb_log("boot option %s is unresolved, "
506                                                 "adding to queue\n",
507                                                 opt->option->id);
508                                 list_add(&handler->unresolved_boot_options,
509                                                 &opt->list);
510                                 talloc_steal(handler, opt);
511                         }
512                 }
513         }
514 }
515
516 void device_handler_add_device(struct device_handler *handler,
517                 struct discover_device *device)
518 {
519         handler->n_devices++;
520         handler->devices = talloc_realloc(handler, handler->devices,
521                                 struct discover_device *, handler->n_devices);
522         handler->devices[handler->n_devices - 1] = device;
523
524 }
525
526 /* Start discovery on a hotplugged device. The device will be in our devices
527  * array, but has only just been initialised by the hotplug source.
528  */
529 int device_handler_discover(struct device_handler *handler,
530                 struct discover_device *dev, enum conf_method method)
531 {
532         struct discover_context *ctx;
533
534         process_boot_option_queue(handler);
535
536         /* create our context */
537         ctx = device_handler_discover_context_create(handler, dev);
538
539         mount_device(dev);
540
541         /* run the parsers. This will populate the ctx's boot_option list. */
542         iterate_parsers(ctx, method);
543
544         /* add discovered stuff to the handler */
545         device_handler_discover_context_commit(handler, ctx);
546
547         talloc_free(ctx);
548
549         return 0;
550 }
551
552 /* incoming conf event */
553 int device_handler_conf(struct device_handler *handler,
554                 struct discover_device *dev, struct pb_url *url,
555                 enum conf_method method)
556 {
557         struct discover_context *ctx;
558
559         /* create our context */
560         ctx = device_handler_discover_context_create(handler, dev);
561         ctx->conf_url = url;
562
563         iterate_parsers(ctx, method);
564
565         device_handler_discover_context_commit(handler, ctx);
566
567         talloc_free(ctx);
568
569         return 0;
570 }
571
572 static struct discover_boot_option *find_boot_option_by_id(
573                 struct device_handler *handler, const char *id)
574 {
575         unsigned int i;
576
577         for (i = 0; i < handler->n_devices; i++) {
578                 struct discover_device *dev = handler->devices[i];
579                 struct discover_boot_option *opt;
580
581                 list_for_each_entry(&dev->boot_options, opt, list)
582                         if (!strcmp(opt->option->id, id))
583                                 return opt;
584         }
585
586         return NULL;
587 }
588
589 void device_handler_boot(struct device_handler *handler,
590                 struct boot_command *cmd)
591 {
592         struct discover_boot_option *opt;
593
594         opt = find_boot_option_by_id(handler, cmd->option_id);
595
596         boot(handler, opt, cmd, handler->dry_run, boot_status, handler);
597 }
598
599 void device_handler_cancel_default(struct device_handler *handler)
600 {
601         struct boot_status status;
602
603         if (handler->timeout_waiter)
604                 waiter_remove(handler->timeout_waiter);
605
606         handler->timeout_waiter = NULL;
607         handler->autoboot_enabled = false;
608
609         /* we only send status if we had a default boot option queued */
610         if (!handler->default_boot_option)
611                 return;
612
613         pb_log("Cancelling default boot option\n");
614
615         handler->default_boot_option = NULL;
616
617         status.type = BOOT_STATUS_INFO;
618         status.progress = -1;
619         status.detail = NULL;
620         status.message = "Default boot cancelled";
621
622         discover_server_notify_boot_status(handler->server, &status);
623 }
624
625 #ifndef PETITBOOT_TEST
626 static int mount_device(struct discover_device *dev)
627 {
628         int rc;
629
630         if (!dev->device_path)
631                 return -1;
632
633         if (!dev->mount_path)
634                 dev->mount_path = join_paths(dev, mount_base(),
635                                                 dev->device_path);
636
637         if (pb_mkdir_recursive(dev->mount_path))
638                 pb_log("couldn't create mount directory %s: %s\n",
639                                 dev->mount_path, strerror(errno));
640
641         rc = process_run_simple(dev, pb_system_apps.mount,
642                         dev->device_path, dev->mount_path,
643                         "-o", "ro", NULL);
644
645         if (!rc)
646                 return 0;
647
648         /* Retry mount without ro option. */
649         rc = process_run_simple(dev, pb_system_apps.mount,
650                         dev->device_path, dev->mount_path, NULL);
651
652         if (!rc)
653                 return 0;
654
655         pb_rmdir_recursive(mount_base(), dev->mount_path);
656         return -1;
657 }
658
659 static int umount_device(struct discover_device *dev)
660 {
661         int status;
662
663         if (!dev->mount_path)
664                 return 0;
665
666         status = process_run_simple(dev, pb_system_apps.umount,
667                         dev->mount_path, NULL);
668
669         if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
670                 return -1;
671
672         pb_rmdir_recursive(mount_base(), dev->mount_path);
673
674         return 0;
675 }
676 #else
677
678 static int umount_device(struct discover_device *dev __attribute__((unused)))
679 {
680         return 0;
681 }
682
683 static int __attribute__((unused)) mount_device(
684                 struct discover_device *dev __attribute__((unused)))
685 {
686         return 0;
687 }
688
689 #endif
690