1 /* grub-setup.c - make GRUB usable */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 1999,2000,2001,2002,2003,2004,2005,2006,2007,2008 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
21 #include <grub/types.h>
22 #include <grub/util/misc.h>
23 #include <grub/device.h>
24 #include <grub/disk.h>
25 #include <grub/file.h>
27 #include <grub/partition.h>
28 #include <grub/pc_partition.h>
29 #include <grub/gpt_partition.h>
31 #include <grub/util/hostdisk.h>
32 #include <grub/machine/boot.h>
33 #include <grub/machine/kernel.h>
34 #include <grub/term.h>
35 #include <grub/util/raid.h>
36 #include <grub/util/lvm.h>
38 static const grub_gpt_part_type_t grub_gpt_partition_type_bios_boot
= GRUB_GPT_PARTITION_TYPE_BIOS_BOOT
;
40 #include <grub_setup_init.h>
46 #include <sys/types.h>
49 #include <grub/util/getroot.h>
54 #define DEFAULT_BOOT_FILE "boot.img"
55 #define DEFAULT_CORE_FILE "core.img"
57 /* This is the blocklist used in the diskboot image. */
62 grub_uint16_t segment
;
63 } __attribute__ ((packed
));
77 struct grub_handler_class grub_term_input_class
;
78 struct grub_handler_class grub_term_output_class
;
87 setup (const char *dir
,
88 const char *boot_file
, const char *core_file
,
89 const char *root
, const char *dest
, int must_embed
, int force
)
91 char *boot_path
, *core_path
, *core_path_dev
;
92 char *boot_img
, *core_img
;
93 size_t boot_size
, core_size
;
94 grub_uint16_t core_sectors
;
95 grub_device_t root_dev
, dest_dev
;
96 const char *dest_partmap
;
97 grub_uint8_t
*boot_drive
, *root_drive
;
98 grub_disk_addr_t
*kernel_sector
;
99 grub_uint16_t
*boot_drive_check
;
100 struct boot_blocklist
*first_block
, *block
;
101 grub_int32_t
*install_dos_part
, *install_bsd_part
;
102 grub_int32_t dos_part
, bsd_part
;
105 grub_disk_addr_t first_sector
;
106 grub_uint16_t current_segment
107 = GRUB_BOOT_MACHINE_KERNEL_SEG
+ (GRUB_DISK_SECTOR_SIZE
>> 4);
108 grub_uint16_t last_length
= GRUB_DISK_SECTOR_SIZE
;
111 struct { grub_uint64_t start
; grub_uint64_t end
; } embed_region
;
112 embed_region
.start
= embed_region
.end
= ~0UL;
114 auto void NESTED_FUNC_ATTR
save_first_sector (grub_disk_addr_t sector
, unsigned offset
,
116 auto void NESTED_FUNC_ATTR
save_blocklists (grub_disk_addr_t sector
, unsigned offset
,
119 auto int NESTED_FUNC_ATTR
find_usable_region_msdos (grub_disk_t disk
,
120 const grub_partition_t p
);
121 int NESTED_FUNC_ATTR
find_usable_region_msdos (grub_disk_t disk
__attribute__ ((unused
)),
122 const grub_partition_t p
)
124 struct grub_pc_partition
*pcdata
= p
->data
;
126 /* There's always an embed region, and it starts right after the MBR. */
127 embed_region
.start
= 1;
129 /* For its end offset, include as many dummy partitions as we can. */
130 if (! grub_pc_partition_is_empty (pcdata
->dos_type
)
131 && ! grub_pc_partition_is_bsd (pcdata
->dos_type
)
132 && embed_region
.end
> p
->start
)
133 embed_region
.end
= p
->start
;
138 auto int NESTED_FUNC_ATTR
find_usable_region_gpt (grub_disk_t disk
,
139 const grub_partition_t p
);
140 int NESTED_FUNC_ATTR
find_usable_region_gpt (grub_disk_t disk
__attribute__ ((unused
)),
141 const grub_partition_t p
)
143 struct grub_gpt_partentry
*gptdata
= p
->data
;
145 /* If there's an embed region, it is in a dedicated partition. */
146 if (! memcmp (&gptdata
->type
, &grub_gpt_partition_type_bios_boot
, 16))
148 embed_region
.start
= p
->start
;
149 embed_region
.end
= p
->start
+ p
->len
;
157 void NESTED_FUNC_ATTR
save_first_sector (grub_disk_addr_t sector
, unsigned offset
,
160 grub_util_info ("the first sector is <%llu,%u,%u>",
161 sector
, offset
, length
);
163 if (offset
!= 0 || length
!= GRUB_DISK_SECTOR_SIZE
)
164 grub_util_error ("The first sector of the core file is not sector-aligned");
166 first_sector
= sector
;
169 void NESTED_FUNC_ATTR
save_blocklists (grub_disk_addr_t sector
, unsigned offset
,
172 struct boot_blocklist
*prev
= block
+ 1;
174 grub_util_info ("saving <%llu,%u,%u> with the segment 0x%x",
175 sector
, offset
, length
, (unsigned) current_segment
);
177 if (offset
!= 0 || last_length
!= GRUB_DISK_SECTOR_SIZE
)
178 grub_util_error ("Non-sector-aligned data is found in the core file");
180 if (block
!= first_block
181 && (grub_le_to_cpu64 (prev
->start
)
182 + grub_le_to_cpu16 (prev
->len
)) == sector
)
183 prev
->len
= grub_cpu_to_le16 (grub_le_to_cpu16 (prev
->len
) + 1);
186 block
->start
= grub_cpu_to_le64 (sector
);
187 block
->len
= grub_cpu_to_le16 (1);
188 block
->segment
= grub_cpu_to_le16 (current_segment
);
192 grub_util_error ("The sectors of the core file are too fragmented");
195 last_length
= length
;
196 current_segment
+= GRUB_DISK_SECTOR_SIZE
>> 4;
199 /* Read the boot image by the OS service. */
200 boot_path
= grub_util_get_path (dir
, boot_file
);
201 boot_size
= grub_util_get_image_size (boot_path
);
202 if (boot_size
!= GRUB_DISK_SECTOR_SIZE
)
203 grub_util_error ("The size of `%s' is not %d",
204 boot_path
, GRUB_DISK_SECTOR_SIZE
);
205 boot_img
= grub_util_read_image (boot_path
);
208 /* Set the addresses of variables in the boot image. */
209 boot_drive
= (grub_uint8_t
*) (boot_img
+ GRUB_BOOT_MACHINE_BOOT_DRIVE
);
210 root_drive
= (grub_uint8_t
*) (boot_img
+ GRUB_BOOT_MACHINE_ROOT_DRIVE
);
211 kernel_sector
= (grub_disk_addr_t
*) (boot_img
212 + GRUB_BOOT_MACHINE_KERNEL_SECTOR
);
213 boot_drive_check
= (grub_uint16_t
*) (boot_img
214 + GRUB_BOOT_MACHINE_DRIVE_CHECK
);
216 core_path
= grub_util_get_path (dir
, core_file
);
217 core_size
= grub_util_get_image_size (core_path
);
218 core_sectors
= ((core_size
+ GRUB_DISK_SECTOR_SIZE
- 1)
219 >> GRUB_DISK_SECTOR_BITS
);
220 if (core_size
< GRUB_DISK_SECTOR_SIZE
)
221 grub_util_error ("The size of `%s' is too small", core_path
);
222 else if (core_size
> 0xFFFF * GRUB_DISK_SECTOR_SIZE
)
223 grub_util_error ("The size of `%s' is too large", core_path
);
225 core_img
= grub_util_read_image (core_path
);
227 /* Have FIRST_BLOCK to point to the first blocklist. */
228 first_block
= (struct boot_blocklist
*) (core_img
229 + GRUB_DISK_SECTOR_SIZE
232 install_dos_part
= (grub_int32_t
*) (core_img
+ GRUB_DISK_SECTOR_SIZE
233 + GRUB_KERNEL_MACHINE_INSTALL_DOS_PART
);
234 install_bsd_part
= (grub_int32_t
*) (core_img
+ GRUB_DISK_SECTOR_SIZE
235 + GRUB_KERNEL_MACHINE_INSTALL_BSD_PART
);
237 /* Open the root device and the destination device. */
238 root_dev
= grub_device_open (root
);
240 grub_util_error ("%s", grub_errmsg
);
242 dest_dev
= grub_device_open (dest
);
244 grub_util_error ("%s", grub_errmsg
);
246 grub_util_info ("setting the root device to `%s'", root
);
247 if (grub_env_set ("root", root
) != GRUB_ERR_NONE
)
248 grub_util_error ("%s", grub_errmsg
);
250 /* Read the original sector from the disk. */
251 tmp_img
= xmalloc (GRUB_DISK_SECTOR_SIZE
);
252 if (grub_disk_read (dest_dev
->disk
, 0, 0, GRUB_DISK_SECTOR_SIZE
, tmp_img
))
253 grub_util_error ("%s", grub_errmsg
);
255 /* Copy the possible DOS BPB. */
256 memcpy (boot_img
+ GRUB_BOOT_MACHINE_BPB_START
,
257 tmp_img
+ GRUB_BOOT_MACHINE_BPB_START
,
258 GRUB_BOOT_MACHINE_BPB_END
- GRUB_BOOT_MACHINE_BPB_START
);
260 /* Copy the possible partition table. */
261 if (dest_dev
->disk
->has_partitions
)
262 memcpy (boot_img
+ GRUB_BOOT_MACHINE_WINDOWS_NT_MAGIC
,
263 tmp_img
+ GRUB_BOOT_MACHINE_WINDOWS_NT_MAGIC
,
264 GRUB_BOOT_MACHINE_PART_END
- GRUB_BOOT_MACHINE_WINDOWS_NT_MAGIC
);
268 /* If DEST_DRIVE is a hard disk, enable the workaround, which is
269 for buggy BIOSes which don't pass boot drive correctly. Instead,
270 they pass 0x00 or 0x01 even when booted from 0x80. */
271 if (dest_dev
->disk
->id
& 0x80)
272 /* Replace the jmp (2 bytes) with double nop's. */
273 *boot_drive_check
= 0x9090;
275 /* If we hardcoded drive as part of prefix, we don't want to
276 override the current setting. */
277 if (*install_dos_part
!= -2)
279 /* Embed information about the installed location. */
280 if (root_dev
->disk
->partition
)
282 if (strcmp (root_dev
->disk
->partition
->partmap
->name
,
283 "pc_partition_map") == 0)
285 struct grub_pc_partition
*pcdata
=
286 root_dev
->disk
->partition
->data
;
287 dos_part
= pcdata
->dos_part
;
288 bsd_part
= pcdata
->bsd_part
;
290 else if (strcmp (root_dev
->disk
->partition
->partmap
->name
,
291 "gpt_partition_map") == 0)
293 dos_part
= root_dev
->disk
->partition
->index
;
297 grub_util_error ("No PC style partitions found");
300 dos_part
= bsd_part
= -1;
304 dos_part
= grub_le_to_cpu32 (*install_dos_part
);
305 bsd_part
= grub_le_to_cpu32 (*install_bsd_part
);
308 grub_util_info ("dos partition is %d, bsd partition is %d",
311 if (! dest_dev
->disk
->has_partitions
)
313 grub_util_warn ("Attempting to install GRUB to a partitionless disk. This is a BAD idea.");
314 goto unable_to_embed
;
317 if (dest_dev
->disk
->partition
)
319 grub_util_warn ("Attempting to install GRUB to a partition instead of the MBR. This is a BAD idea.");
320 goto unable_to_embed
;
323 /* Unlike root_dev, with dest_dev we're interested in the partition map even
324 if dest_dev itself is a whole disk. */
325 auto int NESTED_FUNC_ATTR
identify_partmap (grub_disk_t disk
,
326 const grub_partition_t p
);
327 int NESTED_FUNC_ATTR
identify_partmap (grub_disk_t disk
__attribute__ ((unused
)),
328 const grub_partition_t p
)
330 dest_partmap
= p
->partmap
->name
;
333 grub_partition_iterate (dest_dev
->disk
, identify_partmap
);
335 grub_partition_iterate (dest_dev
->disk
, (strcmp (dest_partmap
, "pc_partition_map") ?
336 find_usable_region_gpt
: find_usable_region_msdos
));
337 if (embed_region
.end
== embed_region
.start
)
339 if (! strcmp (dest_partmap
, "pc_partition_map"))
340 grub_util_warn ("This msdos-style partition label has no post-MBR gap; embedding won't be possible!");
342 grub_util_warn ("This GPT partition label has no BIOS Boot Partition; embedding won't be possible!");
343 goto unable_to_embed
;
346 if ((unsigned long) core_sectors
> embed_region
.end
- embed_region
.start
)
348 if (core_sectors
> 62 * 512)
349 grub_util_warn ("Your core.img is unusually large. It won't fit in the embedding area.");
350 else if (embed_region
.end
- embed_region
.start
< 62 * 512)
351 grub_util_warn ("Your embedding area is unusually small. core.img won't fit in it.");
353 grub_util_warn ("Embedding area is too small for core.img.");
354 goto unable_to_embed
;
358 grub_util_info ("will embed the core image at sector 0x%llx", embed_region
.start
);
360 *install_dos_part
= grub_cpu_to_le32 (dos_part
);
361 *install_bsd_part
= grub_cpu_to_le32 (bsd_part
);
363 /* The first blocklist contains the whole sectors. */
364 first_block
->start
= grub_cpu_to_le64 (embed_region
.start
+ 1);
365 first_block
->len
= grub_cpu_to_le16 (core_sectors
- 1);
367 = grub_cpu_to_le16 (GRUB_BOOT_MACHINE_KERNEL_SEG
368 + (GRUB_DISK_SECTOR_SIZE
>> 4));
370 /* Make sure that the second blocklist is a terminator. */
371 block
= first_block
- 1;
376 /* Write the core image onto the disk. */
377 if (grub_disk_write (dest_dev
->disk
, embed_region
.start
, 0, core_size
, core_img
))
378 grub_util_error ("%s", grub_errmsg
);
380 /* FIXME: can this be skipped? */
384 *kernel_sector
= grub_cpu_to_le64 (embed_region
.start
);
386 /* Write the boot image onto the disk. */
387 if (grub_disk_write (dest_dev
->disk
, 0, 0, GRUB_DISK_SECTOR_SIZE
,
389 grub_util_error ("%s", grub_errmsg
);
396 grub_util_error ("Embedding is not possible, but this is required when "
397 "the root device is on a RAID array or LVM volume.");
399 grub_util_warn ("Embedding is not possible. GRUB can only be installed in this "
400 "setup by using blocklists. However, blocklists are UNRELIABLE and "
401 "its use is discouraged.");
403 grub_util_error ("If you really want blocklists, use --force.");
405 /* Make sure that GRUB reads the identical image as the OS. */
406 tmp_img
= xmalloc (core_size
);
407 core_path_dev
= grub_util_get_path (dir
, core_file
);
409 /* It is a Good Thing to sync two times. */
415 for (i
= 0; i
< MAX_TRIES
; i
++)
417 grub_util_info ("attempting to read the core image `%s' from GRUB%s",
418 core_path_dev
, (i
== 0) ? "" : " again");
420 grub_disk_cache_invalidate_all ();
422 file
= grub_file_open (core_path_dev
);
425 if (grub_file_size (file
) != core_size
)
426 grub_util_info ("succeeded in opening the core image but the size is different (%d != %d)",
427 (int) grub_file_size (file
), (int) core_size
);
428 else if (grub_file_read (file
, tmp_img
, core_size
)
429 != (grub_ssize_t
) core_size
)
430 grub_util_info ("succeeded in opening the core image but cannot read %d bytes",
432 else if (memcmp (core_img
, tmp_img
, core_size
) != 0)
438 dump
= fopen ("dump.img", "wb");
441 fwrite (tmp_img
, 1, core_size
, dump
);
445 dump2
= fopen ("dump2.img", "wb");
448 fwrite (core_img
, 1, core_size
, dump2
);
453 grub_util_info ("succeeded in opening the core image but the data is different");
457 grub_file_close (file
);
461 grub_file_close (file
);
464 grub_util_info ("couldn't open the core image");
467 grub_util_info ("error message = %s", grub_errmsg
);
469 grub_errno
= GRUB_ERR_NONE
;
475 grub_util_error ("Cannot read `%s' correctly", core_path_dev
);
477 /* Clean out the blocklists. */
487 if ((char *) block
<= core_img
)
488 grub_util_error ("No terminator in the core image");
491 /* Now read the core image to determine where the sectors are. */
492 file
= grub_file_open (core_path_dev
);
494 grub_util_error ("%s", grub_errmsg
);
496 file
->read_hook
= save_first_sector
;
497 if (grub_file_read (file
, tmp_img
, GRUB_DISK_SECTOR_SIZE
)
498 != GRUB_DISK_SECTOR_SIZE
)
499 grub_util_error ("Failed to read the first sector of the core image");
502 file
->read_hook
= save_blocklists
;
503 if (grub_file_read (file
, tmp_img
, core_size
- GRUB_DISK_SECTOR_SIZE
)
504 != (grub_ssize_t
) core_size
- GRUB_DISK_SECTOR_SIZE
)
505 grub_util_error ("Failed to read the rest sectors of the core image");
507 grub_file_close (file
);
509 free (core_path_dev
);
512 *kernel_sector
= grub_cpu_to_le64 (first_sector
);
514 /* FIXME: can this be skipped? */
518 *install_dos_part
= grub_cpu_to_le32 (dos_part
);
519 *install_bsd_part
= grub_cpu_to_le32 (bsd_part
);
521 /* Write the first two sectors of the core image onto the disk. */
522 grub_util_info ("opening the core image `%s'", core_path
);
523 fp
= fopen (core_path
, "r+b");
525 grub_util_error ("Cannot open `%s'", core_path
);
527 grub_util_write_image (core_img
, GRUB_DISK_SECTOR_SIZE
* 2, fp
);
530 /* Write the boot image onto the disk. */
531 if (grub_disk_write (dest_dev
->disk
, 0, 0, GRUB_DISK_SECTOR_SIZE
, boot_img
))
532 grub_util_error ("%s", grub_errmsg
);
536 /* Sync is a Good Thing. */
542 grub_device_close (dest_dev
);
543 grub_device_close (root_dev
);
546 static struct option options
[] =
548 {"boot-image", required_argument
, 0, 'b'},
549 {"core-image", required_argument
, 0, 'c'},
550 {"directory", required_argument
, 0, 'd'},
551 {"device-map", required_argument
, 0, 'm'},
552 {"root-device", required_argument
, 0, 'r'},
553 {"force", no_argument
, 0, 'f'},
554 {"help", no_argument
, 0, 'h'},
555 {"version", no_argument
, 0, 'V'},
556 {"verbose", no_argument
, 0, 'v'},
564 fprintf (stderr
, "Try ``grub-setup --help'' for more information.\n");
567 Usage: grub-setup [OPTION]... DEVICE\n\
569 Set up images to boot from DEVICE.\n\
570 DEVICE must be a GRUB device (e.g. ``(hd0,1)'').\n\
572 -b, --boot-image=FILE use FILE as the boot image [default=%s]\n\
573 -c, --core-image=FILE use FILE as the core image [default=%s]\n\
574 -d, --directory=DIR use GRUB files in the directory DIR [default=%s]\n\
575 -m, --device-map=FILE use FILE as the device map [default=%s]\n\
576 -r, --root-device=DEV use DEV as the root device [default=guessed]\n\
577 -f, --force install even if problems are detected\n\
578 -h, --help display this message and exit\n\
579 -V, --version print version information and exit\n\
580 -v, --verbose print verbose messages\n\
582 Report bugs to <%s>.\n\
584 DEFAULT_BOOT_FILE
, DEFAULT_CORE_FILE
, DEFAULT_DIRECTORY
,
585 DEFAULT_DEVICE_MAP
, PACKAGE_BUGREPORT
);
591 get_device_name (char *dev
)
593 size_t len
= strlen (dev
);
595 if (dev
[0] != '(' || dev
[len
- 1] != ')')
603 main (int argc
, char *argv
[])
611 int must_embed
= 0, force
= 0;
613 progname
= "grub-setup";
615 /* Check for options. */
618 int c
= getopt_long (argc
, argv
, "b:c:d:m:r:hVvf", options
, 0);
629 boot_file
= xstrdup (optarg
);
636 core_file
= xstrdup (optarg
);
643 dir
= xstrdup (optarg
);
650 dev_map
= xstrdup (optarg
);
657 root_dev
= xstrdup (optarg
);
669 printf ("grub-setup (%s) %s\n", PACKAGE_NAME
, PACKAGE_VERSION
);
683 grub_env_set ("debug", "all");
685 /* Obtain DEST_DEV. */
688 fprintf (stderr
, "No device is specified.\n");
692 if (optind
+ 1 != argc
)
694 fprintf (stderr
, "Unknown extra argument `%s'.\n", argv
[optind
+ 1]);
698 /* Initialize the emulated biosdisk driver. */
699 grub_util_biosdisk_init (dev_map
? : DEFAULT_DEVICE_MAP
);
701 /* Initialize all modules. */
704 dest_dev
= get_device_name (argv
[optind
]);
707 /* Possibly, the user specified an OS device file. */
708 dest_dev
= grub_util_get_grub_dev (argv
[optind
]);
711 fprintf (stderr
, "Invalid device `%s'.\n", argv
[optind
]);
716 /* For simplicity. */
717 dest_dev
= xstrdup (dest_dev
);
721 char *tmp
= get_device_name (root_dev
);
724 grub_util_error ("Invalid root device `%s'", root_dev
);
732 root_dev
= grub_util_get_grub_dev (grub_guess_root_device (dir
? : DEFAULT_DIRECTORY
));
735 grub_util_info ("guessing the root device failed, because of `%s'",
737 grub_util_error ("Cannot guess the root device. Specify the option ``--root-device''.");
742 if (grub_util_lvm_isvolume (root_dev
))
745 if (root_dev
[0] == 'm' && root_dev
[1] == 'd'
746 && root_dev
[2] >= '0' && root_dev
[2] <= '9')
748 /* FIXME: we can avoid this on RAID1. */
752 if (dest_dev
[0] == 'm' && dest_dev
[1] == 'd'
753 && dest_dev
[2] >= '0' && dest_dev
[2] <= '9')
758 devicelist
= grub_util_raid_getmembers (dest_dev
);
760 for (i
= 0; devicelist
[i
]; i
++)
762 setup (dir
? : DEFAULT_DIRECTORY
,
763 boot_file
? : DEFAULT_BOOT_FILE
,
764 core_file
? : DEFAULT_CORE_FILE
,
765 root_dev
, grub_util_get_grub_dev (devicelist
[i
]), 1, force
);
770 /* Do the real work. */
771 setup (dir
? : DEFAULT_DIRECTORY
,
772 boot_file
? : DEFAULT_BOOT_FILE
,
773 core_file
? : DEFAULT_CORE_FILE
,
774 root_dev
, dest_dev
, must_embed
, force
);
776 /* Free resources. */
778 grub_util_biosdisk_fini ();