bootdevice.c

   1 /*
   2  * QEMU Boot Device Implement
   3  *
   4  * Copyright (c) 2014 HUAWEI TECHNOLOGIES CO.,LTD.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "sysemu/sysemu.h"
  26 #include "qapi/visitor.h"
  27 #include "qemu/error-report.h"
  28 #include "hw/hw.h"
  29
  30 typedef struct FWBootEntry FWBootEntry;
  31
  32 struct FWBootEntry {
  33     QTAILQ_ENTRY(FWBootEntry) link;
  34     int32_t bootindex;
  35     DeviceState *dev;
  36     char *suffix;
  37 };
  38
  39 static QTAILQ_HEAD(, FWBootEntry) fw_boot_order =
  40     QTAILQ_HEAD_INITIALIZER(fw_boot_order);
  41 static QEMUBootSetHandler *boot_set_handler;
  42 static void *boot_set_opaque;
  43
  44 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque)
  45 {
  46     boot_set_handler = func;
  47     boot_set_opaque = opaque;
  48 }
  49
  50 void qemu_boot_set(const char *boot_order, Error **errp)
  51 {
  52     Error *local_err = NULL;
  53
  54     if (!boot_set_handler) {
  55         error_setg(errp, "no function defined to set boot device list for"
  56                          " this architecture");
  57         return;
  58     }
  59
  60     validate_bootdevices(boot_order, &local_err);
  61     if (local_err) {
  62         error_propagate(errp, local_err);
  63         return;
  64     }
  65
  66     if (boot_set_handler(boot_set_opaque, boot_order)) {
  67         error_setg(errp, "setting boot device list failed");
  68         return;
  69     }
  70 }
  71
  72 void validate_bootdevices(const char *devices, Error **errp)
  73 {
  74     /* We just do some generic consistency checks */
  75     const char *p;
  76     int bitmap = 0;
  77
  78     for (p = devices; *p != '\0'; p++) {
  79         /* Allowed boot devices are:
  80          * a-b: floppy disk drives
  81          * c-f: IDE disk drives
  82          * g-m: machine implementation dependent drives
  83          * n-p: network devices
  84          * It's up to each machine implementation to check if the given boot
  85          * devices match the actual hardware implementation and firmware
  86          * features.
  87          */
  88         if (*p < 'a' || *p > 'p') {
  89             error_setg(errp, "Invalid boot device '%c'", *p);
  90             return;
  91         }
  92         if (bitmap & (1 << (*p - 'a'))) {
  93             error_setg(errp, "Boot device '%c' was given twice", *p);
  94             return;
  95         }
  96         bitmap |= 1 << (*p - 'a');
  97     }
  98 }
  99
 100 void restore_boot_order(void *opaque)
 101 {
 102     char *normal_boot_order = opaque;
 103     static int first = 1;
 104
 105     /* Restore boot order and remove ourselves after the first boot */
 106     if (first) {
 107         first = 0;
 108         return;
 109     }
 110
 111     qemu_boot_set(normal_boot_order, NULL);
 112
 113     qemu_unregister_reset(restore_boot_order, normal_boot_order);
 114     g_free(normal_boot_order);
 115 }
 116
 117 void check_boot_index(int32_t bootindex, Error **errp)
 118 {
 119     FWBootEntry *i;
 120
 121     if (bootindex >= 0) {
 122         QTAILQ_FOREACH(i, &fw_boot_order, link) {
 123             if (i->bootindex == bootindex) {
 124                 error_setg(errp, "The bootindex %d has already been used",
 125                            bootindex);
 126                 return;
 127             }
 128         }
 129     }
 130 }
 131
 132 void del_boot_device_path(DeviceState *dev, const char *suffix)
 133 {
 134     FWBootEntry *i;
 135
 136     if (dev == NULL) {
 137         return;
 138     }
 139
 140     QTAILQ_FOREACH(i, &fw_boot_order, link) {
 141         if ((!suffix || !g_strcmp0(i->suffix, suffix)) &&
 142              i->dev == dev) {
 143             QTAILQ_REMOVE(&fw_boot_order, i, link);
 144             g_free(i->suffix);
 145             g_free(i);
 146
 147             break;
 148         }
 149     }
 150 }
 151
 152 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
 153                           const char *suffix)
 154 {
 155     FWBootEntry *node, *i;
 156
 157     if (bootindex < 0) {
 158         del_boot_device_path(dev, suffix);
 159         return;
 160     }
 161
 162     assert(dev != NULL || suffix != NULL);
 163
 164     del_boot_device_path(dev, suffix);
 165
 166     node = g_malloc0(sizeof(FWBootEntry));
 167     node->bootindex = bootindex;
 168     node->suffix = g_strdup(suffix);
 169     node->dev = dev;
 170
 171     QTAILQ_FOREACH(i, &fw_boot_order, link) {
 172         if (i->bootindex == bootindex) {
 173             error_report("Two devices with same boot index %d", bootindex);
 174             exit(1);
 175         } else if (i->bootindex < bootindex) {
 176             continue;
 177         }
 178         QTAILQ_INSERT_BEFORE(i, node, link);
 179         return;
 180     }
 181     QTAILQ_INSERT_TAIL(&fw_boot_order, node, link);
 182 }
 183
 184 DeviceState *get_boot_device(uint32_t position)
 185 {
 186     uint32_t counter = 0;
 187     FWBootEntry *i = NULL;
 188     DeviceState *res = NULL;
 189
 190     if (!QTAILQ_EMPTY(&fw_boot_order)) {
 191         QTAILQ_FOREACH(i, &fw_boot_order, link) {
 192             if (counter == position) {
 193                 res = i->dev;
 194                 break;
 195             }
 196             counter++;
 197         }
 198     }
 199     return res;
 200 }
 201
 202 /*
 203  * This function returns null terminated string that consist of new line
 204  * separated device paths.
 205  *
 206  * memory pointed by "size" is assigned total length of the array in bytes
 207  *
 208  */
 209 char *get_boot_devices_list(size_t *size, bool ignore_suffixes)
 210 {
 211     FWBootEntry *i;
 212     size_t total = 0;
 213     char *list = NULL;
 214
 215     QTAILQ_FOREACH(i, &fw_boot_order, link) {
 216         char *devpath = NULL, *bootpath;
 217         size_t len;
 218
 219         if (i->dev) {
 220             devpath = qdev_get_fw_dev_path(i->dev);
 221             assert(devpath);
 222         }
 223
 224         if (i->suffix && !ignore_suffixes && devpath) {
 225             size_t bootpathlen = strlen(devpath) + strlen(i->suffix) + 1;
 226
 227             bootpath = g_malloc(bootpathlen);
 228             snprintf(bootpath, bootpathlen, "%s%s", devpath, i->suffix);
 229             g_free(devpath);
 230         } else if (devpath) {
 231             bootpath = devpath;
 232         } else if (!ignore_suffixes) {
 233             assert(i->suffix);
 234             bootpath = g_strdup(i->suffix);
 235         } else {
 236             bootpath = g_strdup("");
 237         }
 238
 239         if (total) {
 240             list[total-1] = '\n';
 241         }
 242         len = strlen(bootpath) + 1;
 243         list = g_realloc(list, total + len);
 244         memcpy(&list[total], bootpath, len);
 245         total += len;
 246         g_free(bootpath);
 247     }
 248
 249     *size = total;
 250
 251     if (boot_strict && *size > 0) {
 252         list[total-1] = '\n';
 253         list = g_realloc(list, total + 5);
 254         memcpy(&list[total], "HALT", 5);
 255         *size = total + 5;
 256     }
 257     return list;
 258 }
 259
 260 typedef struct {
 261     int32_t *bootindex;
 262     const char *suffix;
 263     DeviceState *dev;
 264 } BootIndexProperty;
 265
 266 static void device_get_bootindex(Object *obj, Visitor *v, void *opaque,
 267                                  const char *name, Error **errp)
 268 {
 269     BootIndexProperty *prop = opaque;
 270     visit_type_int32(v, prop->bootindex, name, errp);
 271 }
 272
 273 static void device_set_bootindex(Object *obj, Visitor *v, void *opaque,
 274                                  const char *name, Error **errp)
 275 {
 276     BootIndexProperty *prop = opaque;
 277     int32_t boot_index;
 278     Error *local_err = NULL;
 279
 280     visit_type_int32(v, &boot_index, name, &local_err);
 281     if (local_err) {
 282         goto out;
 283     }
 284     /* check whether bootindex is present in fw_boot_order list  */
 285     check_boot_index(boot_index, &local_err);
 286     if (local_err) {
 287         goto out;
 288     }
 289     /* change bootindex to a new one */
 290     *prop->bootindex = boot_index;
 291
 292     add_boot_device_path(*prop->bootindex, prop->dev, prop->suffix);
 293
 294 out:
 295     if (local_err) {
 296         error_propagate(errp, local_err);
 297     }
 298 }
 299
 300 static void property_release_bootindex(Object *obj, const char *name,
 301                                        void *opaque)
 302
 303 {
 304     BootIndexProperty *prop = opaque;
 305
 306     del_boot_device_path(prop->dev, prop->suffix);
 307     g_free(prop);
 308 }
 309
 310 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
 311                                    const char *name, const char *suffix,
 312                                    DeviceState *dev, Error **errp)
 313 {
 314     Error *local_err = NULL;
 315     BootIndexProperty *prop = g_malloc0(sizeof(*prop));
 316
 317     prop->bootindex = bootindex;
 318     prop->suffix = suffix;
 319     prop->dev = dev;
 320
 321     object_property_add(obj, name, "int32",
 322                         device_get_bootindex,
 323                         device_set_bootindex,
 324                         property_release_bootindex,
 325                         prop, &local_err);
 326
 327     if (local_err) {
 328         error_propagate(errp, local_err);
 329         g_free(prop);
 330         return;
 331     }
 332     /* initialize devices' bootindex property to -1 */
 333     object_property_set_int(obj, -1, name, NULL);
 334 }