]> git.ozlabs.org Git - petitboot/blob - discover/device-handler.c
test/parser: test no whitespace on grub menuentry
[petitboot] / discover / device-handler.c
1 #include <assert.h>
2 #include <inttypes.h>
3 #include <stdlib.h>
4 #include <stdbool.h>
5 #include <unistd.h>
6 #include <string.h>
7 #include <errno.h>
8 #include <mntent.h>
9 #include <locale.h>
10 #include <sys/stat.h>
11 #include <sys/wait.h>
12 #include <sys/mount.h>
13
14 #include <talloc/talloc.h>
15 #include <list/list.h>
16 #include <log/log.h>
17 #include <types/types.h>
18 #include <system/system.h>
19 #include <process/process.h>
20 #include <url/url.h>
21 #include <i18n/i18n.h>
22 #include <pb-config/pb-config.h>
23
24 #include <sys/sysmacros.h>
25 #include <sys/types.h>
26 #include <sys/socket.h>
27 #include <netdb.h>
28 #include <arpa/inet.h>
29
30 #include "device-handler.h"
31 #include "discover-server.h"
32 #include "devmapper.h"
33 #include "user-event.h"
34 #include "platform.h"
35 #include "event.h"
36 #include "parser.h"
37 #include "resource.h"
38 #include "paths.h"
39 #include "sysinfo.h"
40 #include "boot.h"
41 #include "udev.h"
42 #include "network.h"
43 #include "ipmi.h"
44
45 enum default_priority {
46         DEFAULT_PRIORITY_REMOTE         = 1,
47         DEFAULT_PRIORITY_LOCAL_FIRST    = 2,
48         DEFAULT_PRIORITY_LOCAL_LAST     = 0xfe,
49         DEFAULT_PRIORITY_DISABLED       = 0xff,
50 };
51
52 struct progress_info {
53         unsigned int                    percentage;
54         unsigned long                   size;           /* size in bytes */
55
56         const struct process_info       *procinfo;
57         struct list_item        list;
58 };
59
60 struct device_handler {
61         struct discover_server  *server;
62         int                     dry_run;
63
64         struct pb_udev          *udev;
65         struct network          *network;
66         struct user_event       *user_event;
67
68         struct discover_device  **devices;
69         unsigned int            n_devices;
70
71         struct ramdisk_device   **ramdisks;
72         unsigned int            n_ramdisks;
73
74         struct waitset          *waitset;
75         struct waiter           *timeout_waiter;
76         bool                    autoboot_enabled;
77         unsigned int            sec_to_boot;
78
79         struct discover_boot_option *default_boot_option;
80         int                     default_boot_option_priority;
81
82         struct list             unresolved_boot_options;
83
84         struct boot_task        *pending_boot;
85         bool                    pending_boot_is_default;
86
87         struct list             progress;
88         unsigned int            n_progress;
89
90         struct plugin_option    **plugins;
91         unsigned int            n_plugins;
92         bool                    plugin_installing;
93 };
94
95 static int mount_device(struct discover_device *dev);
96 static int umount_device(struct discover_device *dev);
97
98 static int device_handler_init_sources(struct device_handler *handler);
99 static void device_handler_reinit_sources(struct device_handler *handler);
100
101 static void device_handler_update_lang(const char *lang);
102
103 void discover_context_add_boot_option(struct discover_context *ctx,
104                 struct discover_boot_option *boot_option)
105 {
106         boot_option->source = ctx->parser;
107         list_add_tail(&ctx->boot_options, &boot_option->list);
108         talloc_steal(ctx, boot_option);
109 }
110
111 /**
112  * device_handler_get_device_count - Get the count of current handler devices.
113  */
114
115 int device_handler_get_device_count(const struct device_handler *handler)
116 {
117         return handler->n_devices;
118 }
119
120 /**
121  * device_handler_get_device - Get a handler device by index.
122  */
123
124 const struct discover_device *device_handler_get_device(
125         const struct device_handler *handler, unsigned int index)
126 {
127         if (index >= handler->n_devices) {
128                 assert(0 && "bad index");
129                 return NULL;
130         }
131
132         return handler->devices[index];
133 }
134
135 /**
136  * device_handler_get_plugin_count - Get the count of current handler plugins.
137  */
138 int device_handler_get_plugin_count(const struct device_handler *handler)
139 {
140         return handler->n_plugins;
141 }
142
143 /**
144  * discover_handler_get_plugin - Get a handler plugin by index.
145  */
146 const struct plugin_option *device_handler_get_plugin(
147         const struct device_handler *handler, unsigned int index)
148 {
149         if (index >= handler->n_plugins) {
150                 assert(0 && "bad index");
151                 return NULL;
152         }
153
154         return handler->plugins[index];
155 }
156
157 struct network *device_handler_get_network(
158                 const struct device_handler *handler)
159 {
160         return handler->network;
161 }
162
163 struct discover_boot_option *discover_boot_option_create(
164                 struct discover_context *ctx,
165                 struct discover_device *device)
166 {
167         struct discover_boot_option *opt;
168
169         opt = talloc_zero(ctx, struct discover_boot_option);
170         opt->option = talloc_zero(opt, struct boot_option);
171         opt->device = device;
172
173         return opt;
174 }
175
176 static int device_match_uuid(struct discover_device *dev, const char *uuid)
177 {
178         return dev->uuid && !strcmp(dev->uuid, uuid);
179 }
180
181 static int device_match_label(struct discover_device *dev, const char *label)
182 {
183         return dev->label && !strcmp(dev->label, label);
184 }
185
186 static int device_match_id(struct discover_device *dev, const char *id)
187 {
188         return !strcmp(dev->device->id, id);
189 }
190
191 static int device_match_serial(struct discover_device *dev, const char *serial)
192 {
193         const char *val = discover_device_get_param(dev, "ID_SERIAL");
194         return val && !strcmp(val, serial);
195 }
196
197 static struct discover_device *device_lookup(
198                 struct device_handler *device_handler,
199                 int (match_fn)(struct discover_device *, const char *),
200                 const char *str)
201 {
202         struct discover_device *dev;
203         unsigned int i;
204
205         if (!str)
206                 return NULL;
207
208         for (i = 0; i < device_handler->n_devices; i++) {
209                 dev = device_handler->devices[i];
210
211                 if (match_fn(dev, str))
212                         return dev;
213         }
214
215         return NULL;
216 }
217
218 struct discover_device *device_lookup_by_name(struct device_handler *handler,
219                 const char *name)
220 {
221         if (!strncmp(name, "/dev/", strlen("/dev/")))
222                 name += strlen("/dev/");
223
224         return device_lookup_by_id(handler, name);
225 }
226
227 struct discover_device *device_lookup_by_uuid(
228                 struct device_handler *device_handler,
229                 const char *uuid)
230 {
231         return device_lookup(device_handler, device_match_uuid, uuid);
232 }
233
234 struct discover_device *device_lookup_by_label(
235                 struct device_handler *device_handler,
236                 const char *label)
237 {
238         return device_lookup(device_handler, device_match_label, label);
239 }
240
241 struct discover_device *device_lookup_by_id(
242                 struct device_handler *device_handler,
243                 const char *id)
244 {
245         return device_lookup(device_handler, device_match_id, id);
246 }
247
248 struct discover_device *device_lookup_by_serial(
249                 struct device_handler *device_handler,
250                 const char *serial)
251 {
252         return device_lookup(device_handler, device_match_serial, serial);
253 }
254
255 void device_handler_destroy(struct device_handler *handler)
256 {
257         talloc_free(handler);
258 }
259
260 static int destroy_device(void *arg)
261 {
262         struct discover_device *dev = arg;
263
264         umount_device(dev);
265
266         return 0;
267 }
268
269 struct discover_device *discover_device_create(struct device_handler *handler,
270                 const char *uuid, const char *id)
271 {
272         struct discover_device *dev;
273
274         if (uuid)
275                 dev = device_lookup_by_uuid(handler, uuid);
276         else
277                 dev = device_lookup_by_id(handler, id);
278
279         if (dev)
280                 return dev;
281
282         dev = talloc_zero(handler, struct discover_device);
283         dev->device = talloc_zero(dev, struct device);
284         dev->device->id = talloc_strdup(dev->device, id);
285         dev->uuid = talloc_strdup(dev, uuid);
286         list_init(&dev->params);
287         list_init(&dev->boot_options);
288
289         talloc_set_destructor(dev, destroy_device);
290
291         return dev;
292 }
293
294 struct discover_device_param {
295         char                    *name;
296         char                    *value;
297         struct list_item        list;
298 };
299
300 void discover_device_set_param(struct discover_device *device,
301                 const char *name, const char *value)
302 {
303         struct discover_device_param *param;
304         bool found = false;
305
306         list_for_each_entry(&device->params, param, list) {
307                 if (!strcmp(param->name, name)) {
308                         found = true;
309                         break;
310                 }
311         }
312
313         if (!found) {
314                 if (!value)
315                         return;
316                 param = talloc(device, struct discover_device_param);
317                 param->name = talloc_strdup(param, name);
318                 list_add(&device->params, &param->list);
319         } else {
320                 if (!value) {
321                         list_remove(&param->list);
322                         talloc_free(param);
323                         return;
324                 }
325                 talloc_free(param->value);
326         }
327
328         param->value = talloc_strdup(param, value);
329 }
330
331 const char *discover_device_get_param(struct discover_device *device,
332                 const char *name)
333 {
334         struct discover_device_param *param;
335
336         list_for_each_entry(&device->params, param, list) {
337                 if (!strcmp(param->name, name))
338                         return param->value;
339         }
340         return NULL;
341 }
342
343 static void set_env_variables(const struct config *config)
344 {
345         if (config->http_proxy)
346                 setenv("http_proxy", config->http_proxy, 1);
347         else
348                 unsetenv("http_proxy");
349
350         if (config->https_proxy)
351                 setenv("https_proxy", config->https_proxy, 1);
352         else
353                 unsetenv("https_proxy");
354
355         /* Reduce noise in the log from LVM listing open file descriptors */
356         setenv("LVM_SUPPRESS_FD_WARNINGS", "1", 1);
357 }
358
359 struct device_handler *device_handler_init(struct discover_server *server,
360                 struct waitset *waitset, int dry_run)
361 {
362         struct device_handler *handler;
363         int rc;
364
365         handler = talloc_zero(NULL, struct device_handler);
366         handler->server = server;
367         handler->waitset = waitset;
368         handler->dry_run = dry_run;
369         handler->autoboot_enabled = config_autoboot_active(config_get());
370
371         list_init(&handler->unresolved_boot_options);
372
373         list_init(&handler->progress);
374
375         /* set up our mount point base */
376         pb_mkdir_recursive(mount_base());
377
378         parser_init();
379
380         if (config_get()->safe_mode)
381                 return handler;
382
383         set_env_variables(config_get());
384
385         rc = device_handler_init_sources(handler);
386         if (rc) {
387                 talloc_free(handler);
388                 return NULL;
389         }
390
391         return handler;
392 }
393
394 void device_handler_reinit(struct device_handler *handler)
395 {
396         struct discover_boot_option *opt, *tmp;
397         struct ramdisk_device *ramdisk;
398         struct config *config;
399         unsigned int i;
400
401         device_handler_cancel_default(handler);
402         /* Cancel any pending non-default boot */
403         if (handler->pending_boot) {
404                 boot_cancel(handler->pending_boot);
405                 handler->pending_boot = NULL;
406                 handler->pending_boot_is_default = false;
407         }
408
409         /* Cancel any remaining async jobs */
410         process_stop_async_all();
411         pending_network_jobs_cancel();
412
413         /* free unresolved boot options */
414         list_for_each_entry_safe(&handler->unresolved_boot_options,
415                         opt, tmp, list)
416                 talloc_free(opt);
417         list_init(&handler->unresolved_boot_options);
418
419         /* drop all devices */
420         for (i = 0; i < handler->n_devices; i++) {
421                 discover_server_notify_device_remove(handler->server,
422                                 handler->devices[i]->device);
423                 ramdisk = handler->devices[i]->ramdisk;
424                 talloc_free(handler->devices[i]);
425                 talloc_free(ramdisk);
426         }
427
428         talloc_free(handler->devices);
429         handler->devices = NULL;
430         handler->n_devices = 0;
431         talloc_free(handler->ramdisks);
432         handler->ramdisks = NULL;
433         handler->n_ramdisks = 0;
434
435         /* drop any known plugins */
436         for (i = 0; i < handler->n_plugins; i++)
437                 talloc_free(handler->plugins[i]);
438         talloc_free(handler->plugins);
439         handler->plugins = NULL;
440         handler->n_plugins = 0;
441
442         discover_server_notify_plugins_remove(handler->server);
443
444         set_env_variables(config_get());
445
446         /* If the safe mode warning was active disable it now */
447         if (config_get()->safe_mode) {
448                 config = config_copy(handler, config_get());
449                 config->safe_mode = false;
450                 config_set(config);
451                 discover_server_notify_config(handler->server, config);
452         }
453
454         device_handler_reinit_sources(handler);
455 }
456
457 void device_handler_remove(struct device_handler *handler,
458                 struct discover_device *device)
459 {
460         struct discover_boot_option *opt, *tmp;
461         unsigned int i;
462
463         list_for_each_entry_safe(&device->boot_options, opt, tmp, list) {
464                 if (opt == handler->default_boot_option) {
465                         pb_log("Default option %s cancelled since device removed",
466                                         opt->option->name);
467                         device_handler_cancel_default(handler);
468                         break;
469                 }
470         }
471
472         for (i = 0; i < handler->n_devices; i++)
473                 if (handler->devices[i] == device)
474                         break;
475
476         if (i == handler->n_devices) {
477                 talloc_free(device);
478                 return;
479         }
480
481         /* Free any unresolved options, as they're currently allocated
482          * against the handler */
483         list_for_each_entry_safe(&handler->unresolved_boot_options,
484                         opt, tmp, list) {
485                 if (opt->device != device)
486                         continue;
487                 list_remove(&opt->list);
488                 talloc_free(opt);
489         }
490
491         /* if this is a network device, we have to unregister it from the
492          * network code */
493         if (device->device->type == DEVICE_TYPE_NETWORK)
494                 network_unregister_device(handler->network, device);
495
496         handler->n_devices--;
497         memmove(&handler->devices[i], &handler->devices[i + 1],
498                 (handler->n_devices - i) * sizeof(handler->devices[0]));
499         handler->devices = talloc_realloc(handler, handler->devices,
500                 struct discover_device *, handler->n_devices);
501
502         if (device->notified)
503                 discover_server_notify_device_remove(handler->server,
504                                                         device->device);
505
506         talloc_free(device);
507 }
508
509 void device_handler_status(struct device_handler *handler,
510                 struct status *status)
511 {
512         discover_server_notify_boot_status(handler->server, status);
513 }
514
515 static void _device_handler_vstatus(struct device_handler *handler,
516                 enum status_type type, const char *fmt, va_list ap)
517 {
518         struct status status;
519
520         status.type = type;
521         status.message = talloc_vasprintf(handler, fmt, ap);
522         status.backlog = false;
523
524         device_handler_status(handler, &status);
525
526         talloc_free(status.message);
527 }
528
529 static void _device_handler_vdevstatus(struct device_handler *handler,
530                 struct discover_device *device, enum status_type type,
531                 const char *fmt, va_list ap)
532 {
533         char *msg;
534
535         msg = talloc_asprintf(handler, "[%s] %s",
536                         device ? device->device->id : "unknown", fmt);
537         _device_handler_vstatus(handler, type, msg, ap);
538         talloc_free(msg);
539 }
540
541 void device_handler_status_dev_info(struct device_handler *handler,
542                 struct discover_device *dev, const char *fmt, ...)
543 {
544         va_list ap;
545
546         va_start(ap, fmt);
547         _device_handler_vdevstatus(handler, dev, STATUS_INFO, fmt, ap);
548         va_end(ap);
549 }
550
551 void device_handler_status_dev_err(struct device_handler *handler,
552                 struct discover_device *dev, const char *fmt, ...)
553 {
554         va_list ap;
555
556         va_start(ap, fmt);
557         _device_handler_vdevstatus(handler, dev, STATUS_ERROR, fmt, ap);
558         va_end(ap);
559 }
560
561 void device_handler_status_info(struct device_handler *handler,
562                 const char *fmt, ...)
563 {
564         va_list ap;
565
566         va_start(ap, fmt);
567         _device_handler_vstatus(handler, STATUS_INFO, fmt, ap);
568         va_end(ap);
569 }
570
571 void device_handler_status_err(struct device_handler *handler,
572                 const char *fmt, ...)
573 {
574         va_list ap;
575
576         va_start(ap, fmt);
577         _device_handler_vstatus(handler, STATUS_ERROR, fmt, ap);
578         va_end(ap);
579 }
580
581 void device_handler_status_download(struct device_handler *handler,
582                 const struct process_info *procinfo,
583                 unsigned int percentage, unsigned int size, char suffix)
584 {
585         struct progress_info *p, *progress = NULL;
586         uint64_t current_converted, current = 0;
587         const char *units = " kMGTP";
588         unsigned long size_bytes;
589         char *update = NULL;
590         double total = 0;
591         unsigned int i;
592         int unit = 0;
593
594         list_for_each_entry(&handler->progress, p, list)
595                 if (p->procinfo == procinfo)
596                         progress = p;
597
598         if (!progress) {
599                 pb_log("Registering new progress struct\n");
600                 progress = talloc_zero(handler, struct progress_info);
601                 if (!progress) {
602                         pb_log("Failed to allocate room for progress struct\n");
603                         return;
604                 }
605                 progress->procinfo = procinfo;
606                 list_add(&handler->progress, &progress->list);
607                 handler->n_progress++;
608         }
609
610         size_bytes = size;
611         for (i = 0; i < strlen(units); i++) {
612                 if (units[i] == suffix)
613                         break;
614         }
615
616         if (i >= strlen(units)) {
617             pb_log("Couldn't recognise suffix '%c'\n", suffix);
618             size_bytes = 0;
619         } else {
620                 while (i--)
621                         size_bytes <<= 10;
622         }
623
624         progress->percentage = percentage;
625         progress->size = size_bytes;
626
627         /*
628          * Aggregate the info we have and update status. If a progress struct
629          * has zero for both percentage and size we assume progress information
630          * is unavailable and fall back to a generic progress message.
631          */
632         list_for_each_entry(&handler->progress, p, list) {
633                 uint64_t c;
634                 double t;
635                 if (!p->percentage || !p->size) {
636                         update = talloc_asprintf(handler,
637                                         _("%u downloads in progress..."),
638                                         handler->n_progress);
639                         current = total = 0;
640                         break;
641                 }
642
643                 c = p->size;
644                 t = (100 * c) / p->percentage;
645
646                 current += c;
647                 total += t;
648         }
649
650         if (total) {
651                 current_converted = current;
652                 while (current_converted >= 1000) {
653                         current_converted >>= 10;
654                         unit++;
655                 }
656                 update = talloc_asprintf(handler,
657                                 _("%u %s downloading: %.0f%% - %" PRIu64 "%cB"),
658                                 handler->n_progress,
659                                 ngettext("item", "items", handler->n_progress),
660                                 (current / total) * 100, current_converted,
661                                 units[unit]);
662         }
663
664         if (!update) {
665                 pb_log("%s: failed to allocate new status\n", __func__);
666         } else {
667                 device_handler_status_info(handler, "%s\n", update);
668                 talloc_free(update);
669         }
670 }
671
672 static void device_handler_plugin_scan_device(struct device_handler *handler,
673                 struct discover_device *dev)
674 {
675         int rc;
676
677         pb_debug("Scanning %s for plugin files\n", dev->device->id);
678
679         rc = process_run_simple(handler, pb_system_apps.pb_plugin,
680                                 "scan", dev->mount_path,
681                                 NULL);
682         if (rc)
683                 pb_log("Error from pb-plugin scan %s\n",
684                                 dev->mount_path);
685 }
686
687 void device_handler_status_download_remove(struct device_handler *handler,
688                 struct process_info *procinfo)
689 {
690         struct progress_info *p, *tmp;
691
692         list_for_each_entry_safe(&handler->progress, p, tmp, list)
693                 if (p->procinfo == procinfo) {
694                         list_remove(&p->list);
695                         talloc_free(p);
696                         handler->n_progress--;
697                 }
698 }
699
700 static void device_handler_boot_status_cb(void *arg, struct status *status)
701 {
702         device_handler_status(arg, status);
703 }
704
705 static void countdown_status(struct device_handler *handler,
706                 struct discover_boot_option *opt, unsigned int sec)
707 {
708         struct status status;
709
710         status.type = STATUS_INFO;
711         status.message = talloc_asprintf(handler,
712                         _("Booting in %d sec: [%s] %s"), sec,
713                         opt->device->device->id, opt->option->name);
714         status.backlog = false;
715
716         device_handler_status(handler, &status);
717
718         talloc_free(status.message);
719 }
720
721 static int default_timeout(void *arg)
722 {
723         struct device_handler *handler = arg;
724         struct discover_boot_option *opt;
725
726         if (!handler->default_boot_option)
727                 return 0;
728
729         if (handler->pending_boot)
730                 return 0;
731
732         opt = handler->default_boot_option;
733
734         if (handler->sec_to_boot) {
735                 countdown_status(handler, opt, handler->sec_to_boot);
736                 handler->sec_to_boot--;
737                 handler->timeout_waiter = waiter_register_timeout(
738                                                 handler->waitset, 1000,
739                                                 default_timeout, handler);
740                 return 0;
741         }
742
743         handler->timeout_waiter = NULL;
744
745         pb_log("Timeout expired, booting default option %s\n", opt->option->id);
746
747         platform_pre_boot();
748
749         handler->pending_boot = boot(handler, handler->default_boot_option,
750                         NULL, handler->dry_run, device_handler_boot_status_cb,
751                         handler);
752         handler->pending_boot_is_default = true;
753         return 0;
754 }
755
756 struct {
757         enum ipmi_bootdev       ipmi_type;
758         enum device_type        device_type;
759 } device_type_map[] = {
760         { IPMI_BOOTDEV_NETWORK, DEVICE_TYPE_NETWORK },
761         { IPMI_BOOTDEV_DISK, DEVICE_TYPE_DISK },
762         { IPMI_BOOTDEV_DISK, DEVICE_TYPE_USB },
763         { IPMI_BOOTDEV_CDROM, DEVICE_TYPE_OPTICAL },
764 };
765
766 static bool ipmi_device_type_matches(enum ipmi_bootdev ipmi_type,
767                 enum device_type device_type)
768 {
769         unsigned int i;
770
771         for (i = 0; i < ARRAY_SIZE(device_type_map); i++) {
772                 if (device_type_map[i].device_type == device_type)
773                         return device_type_map[i].ipmi_type == ipmi_type;
774         }
775
776         return false;
777 }
778
779 static int autoboot_option_priority(const struct config *config,
780                                 struct discover_boot_option *opt)
781 {
782         enum device_type type = opt->device->device->type;
783         const char *uuid = opt->device->uuid;
784         struct autoboot_option *auto_opt;
785         unsigned int i;
786
787         for (i = 0; i < config->n_autoboot_opts; i++) {
788                 auto_opt = &config->autoboot_opts[i];
789                 if (auto_opt->boot_type == BOOT_DEVICE_UUID)
790                         if (!strcmp(auto_opt->uuid, uuid))
791                                 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
792
793                 if (auto_opt->boot_type == BOOT_DEVICE_TYPE)
794                         if (auto_opt->type == type ||
795                             auto_opt->type == DEVICE_TYPE_ANY)
796                                 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
797         }
798
799         return -1;
800 }
801
802 /*
803  * We have different priorities to resolve conflicts between boot options that
804  * report to be the default for their device. This function assigns a priority
805  * for these options.
806  */
807 static enum default_priority default_option_priority(
808                 struct discover_boot_option *opt)
809 {
810         const struct config *config;
811
812         config = config_get();
813
814         /* We give highest priority to IPMI-configured boot options. If
815          * we have an IPMI bootdev configuration set, then we don't allow
816          * any other defaults */
817         if (config->ipmi_bootdev) {
818                 bool ipmi_match = ipmi_device_type_matches(config->ipmi_bootdev,
819                                 opt->device->device->type);
820                 if (ipmi_match)
821                         return DEFAULT_PRIORITY_REMOTE;
822
823                 pb_debug("handler: disabled default priority due to "
824                                 "non-matching IPMI type %x\n",
825                                 config->ipmi_bootdev);
826                 return DEFAULT_PRIORITY_DISABLED;
827         }
828
829         /* Next, try to match the option against the user-defined autoboot
830          * options, either by device UUID or type. */
831         if (config->n_autoboot_opts) {
832                 int boot_match = autoboot_option_priority(config, opt);
833                 if (boot_match > 0)
834                         return boot_match;
835         }
836
837         /* If the option didn't match any entry in the array, it is disabled */
838         pb_debug("handler: disabled default priority due to "
839                         "non-matching UUID or type\n");
840         return DEFAULT_PRIORITY_DISABLED;
841 }
842
843 static void set_default(struct device_handler *handler,
844                 struct discover_boot_option *opt)
845 {
846         enum default_priority cur_prio, new_prio;
847
848         if (!handler->autoboot_enabled)
849                 return;
850
851         pb_debug("handler: new default option: %s\n", opt->option->id);
852
853         new_prio = default_option_priority(opt);
854
855         /* Anything outside our range prevents a default boot */
856         if (new_prio >= DEFAULT_PRIORITY_DISABLED)
857                 return;
858
859         pb_debug("handler: calculated priority %d\n", new_prio);
860
861         /* Resolve any conflicts: if we have a new default option, it only
862          * replaces the current if it has a higher priority. */
863         if (handler->default_boot_option) {
864
865                 cur_prio = handler->default_boot_option_priority;
866
867                 if (new_prio < cur_prio) {
868                         pb_log("handler: new prio %d beats "
869                                         "old prio %d for %s\n",
870                                         new_prio, cur_prio,
871                                         handler->default_boot_option
872                                                 ->option->id);
873                         handler->default_boot_option = opt;
874                         handler->default_boot_option_priority = new_prio;
875                         /* extend the timeout a little, so the user sees some
876                          * indication of the change */
877                         handler->sec_to_boot += 2;
878                 }
879
880                 return;
881         }
882
883         handler->sec_to_boot = config_get()->autoboot_timeout_sec;
884         handler->default_boot_option = opt;
885         handler->default_boot_option_priority = new_prio;
886
887         pb_log("handler: boot option %s set as default, timeout %u sec.\n",
888                opt->option->id, handler->sec_to_boot);
889
890         default_timeout(handler);
891 }
892
893 static bool resource_is_resolved(struct resource *res)
894 {
895         return !res || res->resolved;
896 }
897
898 /* We only use this in an assert, which will disappear if we're compiling
899  * with NDEBUG, so we need the 'used' attribute for these builds */
900 static bool __attribute__((used)) boot_option_is_resolved(
901                 struct discover_boot_option *opt)
902 {
903         return resource_is_resolved(opt->boot_image) &&
904                 resource_is_resolved(opt->initrd) &&
905                 resource_is_resolved(opt->dtb) &&
906                 resource_is_resolved(opt->args_sig_file) &&
907                 resource_is_resolved(opt->icon);
908 }
909
910 static bool resource_resolve(struct resource *res, const char *name,
911                 struct discover_boot_option *opt,
912                 struct device_handler *handler)
913 {
914         struct parser *parser = opt->source;
915
916         if (resource_is_resolved(res))
917                 return true;
918
919         pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
920                         opt->option->id, name, parser->name);
921         parser->resolve_resource(handler, res);
922
923         return res->resolved;
924 }
925
926 static bool boot_option_resolve(struct discover_boot_option *opt,
927                 struct device_handler *handler)
928 {
929         return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
930                 resource_resolve(opt->initrd, "initrd", opt, handler) &&
931                 resource_resolve(opt->dtb, "dtb", opt, handler) &&
932                 resource_resolve(opt->args_sig_file, "args_sig_file", opt,
933                         handler) &&
934                 resource_resolve(opt->icon, "icon", opt, handler);
935 }
936
937 static void boot_option_finalise(struct device_handler *handler,
938                 struct discover_boot_option *opt)
939 {
940         assert(boot_option_is_resolved(opt));
941
942         /* check that the parsers haven't set any of the final data */
943         assert(!opt->option->boot_image_file);
944         assert(!opt->option->initrd_file);
945         assert(!opt->option->dtb_file);
946         assert(!opt->option->icon_file);
947         assert(!opt->option->device_id);
948         assert(!opt->option->args_sig_file);
949
950         if (opt->boot_image)
951                 opt->option->boot_image_file = opt->boot_image->url->full;
952         if (opt->initrd)
953                 opt->option->initrd_file = opt->initrd->url->full;
954         if (opt->dtb)
955                 opt->option->dtb_file = opt->dtb->url->full;
956         if (opt->icon)
957                 opt->option->icon_file = opt->icon->url->full;
958         if (opt->args_sig_file)
959                 opt->option->args_sig_file = opt->args_sig_file->url->full;
960
961         opt->option->device_id = opt->device->device->id;
962
963         if (opt->option->is_default)
964                 set_default(handler, opt);
965 }
966
967 static void notify_boot_option(struct device_handler *handler,
968                 struct discover_boot_option *opt)
969 {
970         struct discover_device *dev = opt->device;
971
972         if (!dev->notified)
973                 discover_server_notify_device_add(handler->server,
974                                                   opt->device->device);
975         dev->notified = true;
976         discover_server_notify_boot_option_add(handler->server, opt->option);
977 }
978
979 static void process_boot_option_queue(struct device_handler *handler)
980 {
981         struct discover_boot_option *opt, *tmp;
982
983         list_for_each_entry_safe(&handler->unresolved_boot_options,
984                         opt, tmp, list) {
985
986                 pb_debug("queue: attempting resolution for %s\n",
987                                 opt->option->id);
988
989                 if (!boot_option_resolve(opt, handler))
990                         continue;
991
992                 pb_debug("\tresolved!\n");
993
994                 list_remove(&opt->list);
995                 list_add_tail(&opt->device->boot_options, &opt->list);
996                 talloc_steal(opt->device, opt);
997                 boot_option_finalise(handler, opt);
998                 notify_boot_option(handler, opt);
999         }
1000 }
1001
1002 struct discover_context *device_handler_discover_context_create(
1003                 struct device_handler *handler,
1004                 struct discover_device *device)
1005 {
1006         struct discover_context *ctx;
1007
1008         ctx = talloc_zero(handler, struct discover_context);
1009         ctx->handler = handler;
1010         ctx->device = device;
1011         list_init(&ctx->boot_options);
1012
1013         return ctx;
1014 }
1015
1016 void device_handler_add_device(struct device_handler *handler,
1017                 struct discover_device *device)
1018 {
1019         handler->n_devices++;
1020         handler->devices = talloc_realloc(handler, handler->devices,
1021                                 struct discover_device *, handler->n_devices);
1022         handler->devices[handler->n_devices - 1] = device;
1023
1024         if (device->device->type == DEVICE_TYPE_NETWORK)
1025                 network_register_device(handler->network, device);
1026 }
1027
1028 void device_handler_add_ramdisk(struct device_handler *handler,
1029                 const char *path)
1030 {
1031         struct ramdisk_device *dev;
1032         unsigned int i;
1033
1034         if (!path)
1035                 return;
1036
1037         for (i = 0; i < handler->n_ramdisks; i++)
1038                 if (!strcmp(handler->ramdisks[i]->path, path))
1039                         return;
1040
1041         dev = talloc_zero(handler, struct ramdisk_device);
1042         if (!dev) {
1043                 pb_log("Failed to allocate memory to track %s\n", path);
1044                 return;
1045         }
1046
1047         dev->path = talloc_strdup(handler, path);
1048
1049         handler->ramdisks = talloc_realloc(handler, handler->ramdisks,
1050                                 struct ramdisk_device *,
1051                                 handler->n_ramdisks + 1);
1052         if (!handler->ramdisks) {
1053                 pb_log("Failed to reallocate memory"
1054                        "- ramdisk tracking inconsistent!\n");
1055                 return;
1056         }
1057
1058         handler->ramdisks[i] = dev;
1059         i = handler->n_ramdisks++;
1060 }
1061
1062 struct ramdisk_device *device_handler_get_ramdisk(
1063                 struct device_handler *handler)
1064 {
1065         unsigned int i;
1066         char *name;
1067         dev_t id;
1068
1069         /* Check if free ramdisk exists */
1070         for (i = 0; i < handler->n_ramdisks; i++)
1071                 if (!handler->ramdisks[i]->snapshot &&
1072                     !handler->ramdisks[i]->origin &&
1073                     !handler->ramdisks[i]->base)
1074                         return handler->ramdisks[i];
1075
1076         /* Otherwise create a new one */
1077         name = talloc_asprintf(handler, "/dev/ram%d",
1078                         handler->n_ramdisks);
1079         if (!name) {
1080                 pb_debug("Failed to allocate memory to name /dev/ram%d",
1081                         handler->n_ramdisks);
1082                 return NULL;
1083         }
1084
1085         id = makedev(1, handler->n_ramdisks);
1086         if (mknod(name, S_IFBLK, id)) {
1087                 if (errno == EEXIST) {
1088                         /* We haven't yet received updates for existing
1089                          * ramdisks - add and use this one */
1090                         pb_debug("Using untracked ramdisk %s\n", name);
1091                 } else {
1092                         pb_log("Failed to create new ramdisk %s: %s\n",
1093                                name, strerror(errno));
1094                         return NULL;
1095                 }
1096         }
1097         device_handler_add_ramdisk(handler, name);
1098         talloc_free(name);
1099
1100         return handler->ramdisks[i];
1101 }
1102
1103 void device_handler_release_ramdisk(struct discover_device *device)
1104 {
1105         struct ramdisk_device *ramdisk = device->ramdisk;
1106
1107         talloc_free(ramdisk->snapshot);
1108         talloc_free(ramdisk->origin);
1109         talloc_free(ramdisk->base);
1110
1111         ramdisk->snapshot = ramdisk->origin = ramdisk->base = NULL;
1112         ramdisk->sectors = 0;
1113
1114         device->ramdisk = NULL;
1115 }
1116
1117 /* Start discovery on a hotplugged device. The device will be in our devices
1118  * array, but has only just been initialised by the hotplug source.
1119  */
1120 int device_handler_discover(struct device_handler *handler,
1121                 struct discover_device *dev)
1122 {
1123         struct discover_context *ctx;
1124         int rc;
1125
1126         device_handler_status_dev_info(handler, dev,
1127                 /*
1128                  * TRANSLATORS: this string will be passed the type of the
1129                  * device (eg "disk" or "network"), which will be translated
1130                  * accordingly.
1131                  */
1132                 _("Processing new %s device"),
1133                 device_type_display_name(dev->device->type));
1134
1135         /* create our context */
1136         ctx = device_handler_discover_context_create(handler, dev);
1137
1138         rc = mount_device(dev);
1139         if (rc)
1140                 goto out;
1141
1142         /* add this device to our system info */
1143         system_info_register_blockdev(dev->device->id, dev->uuid,
1144                         dev->mount_path);
1145
1146         /* run the parsers. This will populate the ctx's boot_option list. */
1147         iterate_parsers(ctx);
1148
1149         /* add discovered stuff to the handler */
1150         device_handler_discover_context_commit(handler, ctx);
1151
1152         process_boot_option_queue(handler);
1153
1154         /* Check this device for pb-plugins */
1155         device_handler_plugin_scan_device(handler, dev);
1156 out:
1157         talloc_unlink(handler, ctx);
1158
1159         return 0;
1160 }
1161
1162 /* Incoming dhcp event */
1163 int device_handler_dhcp(struct device_handler *handler,
1164                 struct discover_device *dev, struct event *event)
1165 {
1166         struct discover_context *ctx;
1167
1168         device_handler_status_dev_info(handler, dev,
1169                         _("Processing DHCP lease response (ip: %s)"),
1170                         event_get_param(event, "ip"));
1171
1172         pending_network_jobs_start();
1173
1174         /* create our context */
1175         ctx = device_handler_discover_context_create(handler, dev);
1176         talloc_steal(ctx, event);
1177         ctx->event = event;
1178
1179         iterate_parsers(ctx);
1180
1181         device_handler_discover_context_commit(handler, ctx);
1182
1183         talloc_unlink(handler, ctx);
1184
1185         return 0;
1186 }
1187
1188 static struct discover_boot_option *find_boot_option_by_id(
1189                 struct device_handler *handler, const char *id)
1190 {
1191         unsigned int i;
1192
1193         for (i = 0; i < handler->n_devices; i++) {
1194                 struct discover_device *dev = handler->devices[i];
1195                 struct discover_boot_option *opt;
1196
1197                 list_for_each_entry(&dev->boot_options, opt, list)
1198                         if (!strcmp(opt->option->id, id))
1199                                 return opt;
1200         }
1201
1202         return NULL;
1203 }
1204
1205 void device_handler_boot(struct device_handler *handler,
1206                 struct boot_command *cmd)
1207 {
1208         struct discover_boot_option *opt = NULL;
1209
1210         if (cmd->option_id && strlen(cmd->option_id))
1211                 opt = find_boot_option_by_id(handler, cmd->option_id);
1212
1213         if (handler->pending_boot)
1214                 boot_cancel(handler->pending_boot);
1215
1216         platform_pre_boot();
1217
1218         handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
1219                         device_handler_boot_status_cb, handler);
1220         handler->pending_boot_is_default = false;
1221 }
1222
1223 void device_handler_cancel_default(struct device_handler *handler)
1224 {
1225         if (handler->timeout_waiter)
1226                 waiter_remove(handler->timeout_waiter);
1227
1228         handler->timeout_waiter = NULL;
1229         handler->autoboot_enabled = false;
1230
1231         /* we only send status if we had a default boot option queued */
1232         if (!handler->default_boot_option)
1233                 return;
1234
1235         pb_log("Cancelling default boot option\n");
1236
1237         if (handler->pending_boot && handler->pending_boot_is_default) {
1238                 boot_cancel(handler->pending_boot);
1239                 handler->pending_boot = NULL;
1240                 handler->pending_boot_is_default = false;
1241         }
1242
1243         handler->default_boot_option = NULL;
1244
1245         device_handler_status_info(handler, _("Default boot cancelled"));
1246 }
1247
1248 void device_handler_update_config(struct device_handler *handler,
1249                 struct config *config)
1250 {
1251         int rc;
1252
1253         rc = config_set(config);
1254         if (rc)
1255                 return;
1256
1257         discover_server_notify_config(handler->server, config);
1258         device_handler_update_lang(config->lang);
1259         device_handler_reinit(handler);
1260 }
1261
1262 static char *device_from_addr(void *ctx, struct pb_url *url)
1263 {
1264         char *ipaddr, *buf, *tok, *dev = NULL;
1265         const char *delim = " ";
1266         struct sockaddr_in *ip;
1267         struct sockaddr_in si;
1268         struct addrinfo *res;
1269         struct process *p;
1270         int rc;
1271
1272         /* Note: IPv4 only */
1273         rc = inet_pton(AF_INET, url->host, &(si.sin_addr));
1274         if (rc > 0) {
1275                 ipaddr = url->host;
1276         } else {
1277                 /* need to turn hostname into a valid IP */
1278                 rc = getaddrinfo(url->host, NULL, NULL, &res);
1279                 if (rc) {
1280                         pb_debug("%s: Invalid URL\n",__func__);
1281                         return NULL;
1282                 }
1283                 ipaddr = talloc_array(ctx,char,INET_ADDRSTRLEN);
1284                 ip = (struct sockaddr_in *) res->ai_addr;
1285                 inet_ntop(AF_INET, &(ip->sin_addr), ipaddr, INET_ADDRSTRLEN);
1286                 freeaddrinfo(res);
1287         }
1288
1289         const char *argv[] = {
1290                 pb_system_apps.ip,
1291                 "route", "show", "to", "match",
1292                 ipaddr,
1293                 NULL
1294         };
1295
1296         p = process_create(ctx);
1297
1298         p->path = pb_system_apps.ip;
1299         p->argv = argv;
1300         p->keep_stdout = true;
1301
1302         rc = process_run_sync(p);
1303
1304         if (rc || p->exit_status) {
1305                 /* ip has complained for some reason; most likely
1306                  * there is no route to the host - bail out */
1307                 pb_debug("%s: `ip` returns non-zero exit status\n", __func__);
1308                 pb_debug("ip buf: %s\n", p->stdout_buf);
1309                 process_release(p);
1310                 return NULL;
1311         }
1312
1313         buf = p->stdout_buf;
1314         /* If a route is found, ip-route output will be of the form
1315          * "... dev DEVNAME ... " */
1316         tok = strtok(buf, delim);
1317         while (tok) {
1318                 if (!strcmp(tok, "dev")) {
1319                         tok = strtok(NULL, delim);
1320                         dev = talloc_strdup(ctx, tok);
1321                         break;
1322                 }
1323                 tok = strtok(NULL, delim);
1324         }
1325
1326         process_release(p);
1327         if (dev)
1328                 pb_debug("%s: Found interface '%s'\n", __func__,dev);
1329         return dev;
1330 }
1331
1332 static void process_url_cb(struct load_url_result *result, void *data)
1333 {
1334         struct device_handler *handler;
1335         struct discover_context *ctx;
1336         struct discover_device *dev;
1337         struct event *event = data;
1338         const char *mac;
1339
1340         if (result->status != LOAD_OK) {
1341                 pb_log("%s: Load failed for %s\n", __func__, result->url->full);
1342                 return;
1343         }
1344
1345         if (!event)
1346                 return;
1347
1348         handler = talloc_parent(event);
1349         if (!handler)
1350                 return;
1351
1352         event->device = device_from_addr(event, result->url);
1353         if (!event->device) {
1354                 pb_log("Downloaded a file but can't find its interface - pretending it was local\n");
1355                 event->device = talloc_asprintf(event, "local");
1356         }
1357
1358         mac = event_get_param(event, "mac");
1359         char *url = talloc_asprintf(event, "file://%s", result->local);
1360         event_set_param(event, "pxeconffile-local", url);
1361
1362         dev = discover_device_create(handler, mac, event->device);
1363         ctx = device_handler_discover_context_create(handler, dev);
1364         talloc_steal(ctx, event);
1365         ctx->event = event;
1366
1367         iterate_parsers(ctx);
1368
1369         device_handler_discover_context_commit(handler, ctx);
1370
1371         talloc_unlink(handler, ctx);
1372 }
1373
1374 void device_handler_process_url(struct device_handler *handler,
1375                 const char *url, const char *mac, const char *ip)
1376 {
1377         struct discover_context *ctx;
1378         struct discover_device *dev;
1379         bool allow_async = false;
1380         struct pb_url *pb_url;
1381         struct event *event;
1382
1383         event = talloc_zero(handler, struct event);
1384         event->type = EVENT_TYPE_USER;
1385         event->action = EVENT_ACTION_URL;
1386
1387         pb_url = pb_url_parse(event, url);
1388         if (!pb_url || (pb_url->scheme != pb_url_file && !pb_url->host)) {
1389                 device_handler_status_err(handler, _("Invalid config URL!"));
1390                 talloc_free(event);
1391                 return;
1392         }
1393
1394         if (url[strlen(url) - 1] == '/') {
1395                 event_set_param(event, "pxepathprefix", url);
1396                 event_set_param(event, "mac", mac);
1397                 event_set_param(event, "ip", ip);
1398                 event->device = device_from_addr(event, pb_url);
1399                 if (!event->device) {
1400                         device_handler_status_err(handler,
1401                                         _("Unable to route to host %s"),
1402                                         pb_url->host);
1403                         talloc_free(event);
1404                         return;
1405                 }
1406         } else {
1407                 event_set_param(event, "pxeconffile", url);
1408                 allow_async = true;
1409         }
1410
1411         if (pb_url->scheme == pb_url_file)
1412                 event->device = talloc_asprintf(event, "local");
1413         else if (allow_async) {
1414                 /* If file is remote load asynchronously before passing to
1415                  * parser. This allows us to wait for network to be available */
1416                 if (!load_url_async(handler, pb_url, process_url_cb, event,
1417                                         NULL, handler)) {
1418                         pb_log("Failed to load url %s\n", pb_url->full);
1419                         device_handler_status_err(handler, _("Failed to load URL!"));
1420                         talloc_free(event);
1421                 }
1422                 return;
1423         }
1424
1425         /* If path is local we can parse straight away */
1426
1427         dev = discover_device_create(handler, mac, event->device);
1428         if (pb_url->scheme == pb_url_file)
1429                 dev->device->type = DEVICE_TYPE_ANY;
1430         ctx = device_handler_discover_context_create(handler, dev);
1431         talloc_steal(ctx, event);
1432         ctx->event = event;
1433
1434         iterate_parsers(ctx);
1435
1436         device_handler_discover_context_commit(handler, ctx);
1437
1438         talloc_unlink(handler, ctx);
1439 }
1440
1441 static void plugin_install_cb(struct process *process)
1442 {
1443         struct device_handler *handler = process->data;
1444
1445         if (!handler) {
1446                 pb_log("%s: Missing data!\n", __func__);
1447                 return;
1448         }
1449
1450         handler->plugin_installing = false;
1451         if (process->exit_status) {
1452                 device_handler_status_err(handler, "Plugin failed to install!");
1453                 pb_log("Failed to install plugin:\n%s\n", process->stdout_buf);
1454         }
1455 }
1456
1457 void device_handler_install_plugin(struct device_handler *handler,
1458                 const char *plugin_file)
1459 {
1460         struct process *p;
1461         int result;
1462
1463         if (handler->plugin_installing) {
1464                 pb_log("Plugin install cancelled - install already running");
1465                 return;
1466         }
1467
1468         p = process_create(handler);
1469         if (!p) {
1470                 pb_log("install_plugin: Failed to create process\n");
1471                 return;
1472         }
1473
1474         const char *argv[] = {
1475                 pb_system_apps.pb_plugin,
1476                 "install",
1477                 "auto",
1478                 plugin_file,
1479                 NULL
1480         };
1481
1482         p->path = pb_system_apps.pb_plugin;
1483         p->argv = argv;
1484         p->exit_cb = plugin_install_cb;
1485         p->data = handler;
1486         p->keep_stdout = true;
1487
1488         result = process_run_async(p);
1489
1490         if (result)
1491                 device_handler_status_err(handler, "Could not install plugin");
1492         else
1493                 handler->plugin_installing = true;
1494 }
1495
1496 #ifndef PETITBOOT_TEST
1497
1498 /**
1499  * context_commit - Commit a temporary discovery context to the handler,
1500  * and notify the clients about any new options / devices
1501  */
1502 void device_handler_discover_context_commit(struct device_handler *handler,
1503                 struct discover_context *ctx)
1504 {
1505         struct discover_device *dev = ctx->device;
1506         struct discover_boot_option *opt, *tmp;
1507
1508         if (!device_lookup_by_uuid(handler, dev->uuid))
1509                 device_handler_add_device(handler, dev);
1510
1511         /* move boot options from the context to the device */
1512         list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
1513                 list_remove(&opt->list);
1514
1515                 /* All boot options need at least a kernel image */
1516                 if (!opt->boot_image || !opt->boot_image->url) {
1517                         pb_log("boot option %s is missing boot image, ignoring\n",
1518                                 opt->option->id);
1519                         talloc_free(opt);
1520                         continue;
1521                 }
1522
1523                 if (boot_option_resolve(opt, handler)) {
1524                         pb_log("boot option %s is resolved, "
1525                                         "sending to clients\n",
1526                                         opt->option->id);
1527                         list_add_tail(&dev->boot_options, &opt->list);
1528                         talloc_steal(dev, opt);
1529                         boot_option_finalise(handler, opt);
1530                         notify_boot_option(handler, opt);
1531                 } else {
1532                         if (!opt->source->resolve_resource) {
1533                                 pb_log("parser %s gave us an unresolved "
1534                                         "resource (%s), but no way to "
1535                                         "resolve it\n",
1536                                         opt->source->name, opt->option->id);
1537                                 talloc_free(opt);
1538                         } else {
1539                                 pb_log("boot option %s is unresolved, "
1540                                                 "adding to queue\n",
1541                                                 opt->option->id);
1542                                 list_add(&handler->unresolved_boot_options,
1543                                                 &opt->list);
1544                                 talloc_steal(handler, opt);
1545                         }
1546                 }
1547         }
1548 }
1549
1550 void device_handler_add_plugin_option(struct device_handler *handler,
1551                 struct plugin_option *opt)
1552 {
1553         struct plugin_option *tmp;
1554         unsigned int i;
1555
1556         for (i = 0; i < handler->n_plugins; i++) {
1557                 tmp = handler->plugins[i];
1558                 /* If both id and version match, ignore */
1559                 if (strncmp(opt->id, tmp->id, strlen(opt->id)) == 0 &&
1560                                 strncmp(opt->version, tmp->version,
1561                                         strlen(opt->version) == 0)) {
1562                         pb_log("discover: Plugin '%s' already exists, ignoring\n",
1563                                         opt->id);
1564                         return;
1565                 }
1566         }
1567
1568         handler->plugins = talloc_realloc(handler, handler->plugins,
1569                         struct plugin_option *, handler->n_plugins + 1);
1570         if (!handler->plugins) {
1571                 pb_log("Failed to allocate memory for new plugin\n");
1572                 handler->n_plugins = 0;
1573                 return;
1574         }
1575
1576         handler->plugins[handler->n_plugins++] = opt;
1577         discover_server_notify_plugin_option_add(handler->server, opt);
1578 }
1579
1580 static void device_handler_update_lang(const char *lang)
1581 {
1582         const char *cur_lang;
1583
1584         if (!lang)
1585                 return;
1586
1587         cur_lang = setlocale(LC_ALL, NULL);
1588         if (cur_lang && !strcmp(cur_lang, lang))
1589                 return;
1590
1591         setlocale(LC_ALL, lang);
1592 }
1593
1594 static int device_handler_init_sources(struct device_handler *handler)
1595 {
1596         /* init our device sources: udev, network and user events */
1597         handler->user_event = user_event_init(handler, handler->waitset);
1598         if (!handler->user_event)
1599                 return -1;
1600
1601         handler->network = network_init(handler, handler->waitset,
1602                         handler->dry_run);
1603         if (!handler->network)
1604                 return -1;
1605
1606         handler->udev = udev_init(handler, handler->waitset);
1607         if (!handler->udev)
1608                 return -1;
1609
1610         return 0;
1611 }
1612
1613 static void device_handler_reinit_sources(struct device_handler *handler)
1614 {
1615         /* if we haven't initialised sources previously (becuase we started in
1616          * safe mode), then init once here. */
1617         if (!(handler->udev || handler->network || handler->user_event)) {
1618                 device_handler_init_sources(handler);
1619                 return;
1620         }
1621
1622         system_info_reinit();
1623
1624         network_shutdown(handler->network);
1625         handler->network = network_init(handler, handler->waitset,
1626                         handler->dry_run);
1627
1628         udev_reinit(handler->udev);
1629 }
1630
1631 static inline const char *get_device_path(struct discover_device *dev)
1632 {
1633         return dev->ramdisk ? dev->ramdisk->snapshot : dev->device_path;
1634 }
1635
1636 static char *check_subvols(struct discover_device *dev)
1637 {
1638         const char *fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1639         struct stat sb;
1640         char *path;
1641         int rc;
1642
1643         if (strncmp(fstype, "btrfs", strlen("btrfs")))
1644                 return dev->mount_path;
1645
1646         /* On btrfs a device's root may be under a subvolume path */
1647         path = join_paths(dev, dev->mount_path, "@");
1648         rc = stat(path, &sb);
1649         if (!rc && S_ISDIR(sb.st_mode)) {
1650                 pb_debug("Using '%s' for btrfs root path\n", path);
1651                 return path;
1652         }
1653
1654         talloc_free(path);
1655         return dev->mount_path;
1656 }
1657
1658 static bool check_existing_mount(struct discover_device *dev)
1659 {
1660         struct stat devstat, mntstat;
1661         const char *device_path;
1662         struct mntent *mnt;
1663         FILE *fp;
1664         int rc;
1665
1666         device_path = get_device_path(dev);
1667
1668         rc = stat(device_path, &devstat);
1669         if (rc) {
1670                 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
1671                 return false;
1672         }
1673
1674         if (!S_ISBLK(devstat.st_mode)) {
1675                 pb_debug("%s: %s isn't a block device?\n", __func__,
1676                                 dev->device_path);
1677                 return false;
1678         }
1679
1680         fp = fopen("/proc/self/mounts", "r");
1681
1682         for (;;) {
1683                 mnt = getmntent(fp);
1684                 if (!mnt)
1685                         break;
1686
1687                 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
1688                         continue;
1689
1690                 rc = stat(mnt->mnt_fsname, &mntstat);
1691                 if (rc)
1692                         continue;
1693
1694                 if (!S_ISBLK(mntstat.st_mode))
1695                         continue;
1696
1697                 if (mntstat.st_rdev == devstat.st_rdev) {
1698                         dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
1699                         dev->root_path = check_subvols(dev);
1700                         dev->mounted_rw = !!hasmntopt(mnt, "rw");
1701                         dev->mounted = true;
1702                         dev->unmount = false;
1703
1704                         pb_debug("%s: %s is already mounted (r%c) at %s\n",
1705                                         __func__, dev->device_path,
1706                                         dev->mounted_rw ? 'w' : 'o',
1707                                         mnt->mnt_dir);
1708                         break;
1709                 }
1710         }
1711
1712         fclose(fp);
1713
1714         return mnt != NULL;
1715 }
1716
1717 /*
1718  * Attempt to mount a filesystem safely, while handling certain filesytem-
1719  * specific options
1720  */
1721 static int try_mount(const char *device_path, const char *mount_path,
1722                              const char *fstype, unsigned long flags,
1723                              bool have_snapshot)
1724 {
1725         const char *fs, *safe_opts;
1726         int rc;
1727
1728         /* Mount ext3 as ext4 instead so 'norecovery' can be used */
1729         if (strncmp(fstype, "ext3", strlen("ext3")) == 0) {
1730                 pb_debug("Mounting ext3 filesystem as ext4\n");
1731                 fs = "ext4";
1732         } else
1733                 fs = fstype;
1734
1735         if (strncmp(fs, "xfs", strlen("xfs")) == 0 ||
1736             strncmp(fs, "ext4", strlen("ext4")) == 0)
1737                 safe_opts = "norecovery";
1738         else
1739                 safe_opts = NULL;
1740
1741         errno = 0;
1742         /* If no snapshot is available don't attempt recovery */
1743         if (!have_snapshot)
1744                 return mount(device_path, mount_path, fs, flags, safe_opts);
1745
1746         rc = mount(device_path, mount_path, fs, flags, NULL);
1747
1748         if (!rc)
1749                 return rc;
1750
1751         /* Mounting failed; some filesystems will fail to mount if a recovery
1752          * journal exists (eg. cross-endian XFS), so try again with norecovery
1753          * where that option is available.
1754          * If mounting read-write just return the error as norecovery is not a
1755          * valid option */
1756         if ((flags & MS_RDONLY) != MS_RDONLY || !safe_opts)
1757                 return rc;
1758
1759         errno = 0;
1760         return mount(device_path, mount_path, fs, flags, safe_opts);
1761 }
1762
1763 static int mount_device(struct discover_device *dev)
1764 {
1765         const char *fstype, *device_path;
1766         int rc;
1767
1768         if (!dev->device_path)
1769                 return -1;
1770
1771         if (dev->mounted)
1772                 return 0;
1773
1774         if (check_existing_mount(dev))
1775                 return 0;
1776
1777         fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1778         if (!fstype)
1779                 return 0;
1780
1781         dev->mount_path = join_paths(dev, mount_base(),
1782                                         dev->device_path);
1783
1784         if (pb_mkdir_recursive(dev->mount_path)) {
1785                 pb_log("couldn't create mount directory %s: %s\n",
1786                                 dev->mount_path, strerror(errno));
1787                 goto err_free;
1788         }
1789
1790         device_path = get_device_path(dev);
1791
1792         pb_log("mounting device %s read-only\n", dev->device_path);
1793         rc = try_mount(device_path, dev->mount_path, fstype,
1794                        MS_RDONLY | MS_SILENT, dev->ramdisk);
1795
1796         /* If mount fails clean up any snapshot and try again */
1797         if (rc && dev->ramdisk) {
1798                 pb_log("couldn't mount snapshot for %s: mount failed: %s\n",
1799                                 device_path, strerror(errno));
1800                 pb_log("falling back to actual device\n");
1801
1802                 devmapper_destroy_snapshot(dev);
1803
1804                 device_path = get_device_path(dev);
1805                 pb_log("mounting device %s read-only\n", dev->device_path);
1806                 rc = try_mount(device_path, dev->mount_path, fstype,
1807                                MS_RDONLY | MS_SILENT, dev->ramdisk);
1808         }
1809
1810         if (!rc) {
1811                 dev->mounted = true;
1812                 dev->mounted_rw = false;
1813                 dev->unmount = true;
1814                 dev->root_path = check_subvols(dev);
1815                 return 0;
1816         }
1817
1818         pb_log("couldn't mount device %s: mount failed: %s\n",
1819                         device_path, strerror(errno));
1820
1821         pb_rmdir_recursive(mount_base(), dev->mount_path);
1822 err_free:
1823         talloc_free(dev->mount_path);
1824         dev->mount_path = NULL;
1825         return -1;
1826 }
1827
1828 static int umount_device(struct discover_device *dev)
1829 {
1830         const char *device_path;
1831         int rc;
1832
1833         if (!dev->mounted || !dev->unmount)
1834                 return 0;
1835
1836         device_path = get_device_path(dev);
1837
1838         pb_log("unmounting device %s\n", device_path);
1839         rc = umount(dev->mount_path);
1840         if (rc)
1841                 return -1;
1842
1843         dev->mounted = false;
1844         devmapper_destroy_snapshot(dev);
1845
1846         pb_rmdir_recursive(mount_base(), dev->mount_path);
1847
1848         talloc_free(dev->mount_path);
1849         dev->mount_path = NULL;
1850         dev->root_path = NULL;
1851
1852         return 0;
1853 }
1854
1855 int device_request_write(struct discover_device *dev, bool *release)
1856 {
1857         const char *fstype, *device_path;
1858         const struct config *config;
1859         int rc;
1860
1861         *release = false;
1862
1863         config = config_get();
1864         if (!config->allow_writes)
1865                 return -1;
1866
1867         if (!dev->mounted)
1868                 return -1;
1869
1870         if (dev->mounted_rw)
1871                 return 0;
1872
1873         fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1874
1875         device_path = get_device_path(dev);
1876
1877         pb_log("remounting device %s read-write\n", device_path);
1878
1879         rc = umount(dev->mount_path);
1880         if (rc) {
1881                 pb_log("Failed to unmount %s: %s\n",
1882                        dev->mount_path, strerror(errno));
1883                 return -1;
1884         }
1885
1886         rc = try_mount(device_path, dev->mount_path, fstype,
1887                        MS_SILENT, dev->ramdisk);
1888         if (rc)
1889                 goto mount_ro;
1890
1891         dev->mounted_rw = true;
1892         *release = true;
1893         return 0;
1894
1895 mount_ro:
1896         pb_log("Unable to remount device %s read-write: %s\n",
1897                device_path, strerror(errno));
1898         rc = try_mount(device_path, dev->mount_path, fstype,
1899                        MS_RDONLY | MS_SILENT, dev->ramdisk);
1900         if (rc)
1901                 pb_log("Unable to recover mount for %s: %s\n",
1902                        device_path, strerror(errno));
1903         return -1;
1904 }
1905
1906 void device_release_write(struct discover_device *dev, bool release)
1907 {
1908         const char *fstype, *device_path;
1909
1910         if (!release)
1911                 return;
1912
1913         device_path = get_device_path(dev);
1914
1915         fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1916
1917         pb_log("remounting device %s read-only\n", device_path);
1918
1919         if (umount(dev->mount_path)) {
1920                 pb_log("Failed to unmount %s\n", dev->mount_path);
1921                 return;
1922         }
1923         dev->mounted_rw = dev->mounted = false;
1924
1925         if (dev->ramdisk) {
1926                 devmapper_merge_snapshot(dev);
1927                 /* device_path becomes stale after merge */
1928                 device_path = get_device_path(dev);
1929         }
1930
1931         if (try_mount(device_path, dev->mount_path, fstype,
1932                        MS_RDONLY | MS_SILENT, dev->ramdisk))
1933                 pb_log("Failed to remount %s read-only: %s\n",
1934                        device_path, strerror(errno));
1935         else
1936                 dev->mounted = true;
1937 }
1938
1939 void device_sync_snapshots(struct device_handler *handler, const char *device)
1940 {
1941         struct discover_device *dev = NULL;
1942         unsigned int i;
1943
1944         if (device) {
1945                 /* Find matching device and sync */
1946                 dev = device_lookup_by_name(handler, device);
1947                 if (!dev) {
1948                         pb_log("%s: device name '%s' unrecognised\n",
1949                                 __func__, device);
1950                         return;
1951                 }
1952                 if (dev->ramdisk)
1953                         device_release_write(dev, true);
1954                 else
1955                         pb_log("%s has no snapshot to merge, skipping\n",
1956                                 dev->device->id);
1957                 return;
1958         }
1959
1960         /* Otherwise sync all relevant devices */
1961         for (i = 0; i < handler->n_devices; i++) {
1962                 dev = handler->devices[i];
1963                 if (dev->device->type != DEVICE_TYPE_DISK &&
1964                         dev->device->type != DEVICE_TYPE_USB)
1965                         continue;
1966                 if (dev->ramdisk)
1967                         device_release_write(dev, true);
1968                 else
1969                         pb_log("%s has no snapshot to merge, skipping\n",
1970                                 dev->device->id);
1971         }
1972 }
1973
1974 #else
1975
1976 void device_handler_discover_context_commit(
1977                 struct device_handler *handler __attribute__((unused)),
1978                 struct discover_context *ctx __attribute__((unused)))
1979 {
1980         pb_log("%s stubbed out for test cases\n", __func__);
1981 }
1982
1983 static void device_handler_update_lang(const char *lang __attribute__((unused)))
1984 {
1985 }
1986
1987 static int device_handler_init_sources(
1988                 struct device_handler *handler __attribute__((unused)))
1989 {
1990         return 0;
1991 }
1992
1993 static void device_handler_reinit_sources(
1994                 struct device_handler *handler __attribute__((unused)))
1995 {
1996 }
1997
1998 static int umount_device(struct discover_device *dev __attribute__((unused)))
1999 {
2000         return 0;
2001 }
2002
2003 static int __attribute__((unused)) mount_device(
2004                 struct discover_device *dev __attribute__((unused)))
2005 {
2006         return 0;
2007 }
2008
2009 int device_request_write(struct discover_device *dev __attribute__((unused)),
2010                 bool *release)
2011 {
2012         *release = true;
2013         return 0;
2014 }
2015
2016 void device_release_write(struct discover_device *dev __attribute__((unused)),
2017         bool release __attribute__((unused)))
2018 {
2019 }
2020
2021 void device_sync_snapshots(
2022                 struct device_handler *handler __attribute__((unused)),
2023                 const char *device __attribute__((unused)))
2024 {
2025 }
2026
2027 #endif