2 * Copyright (c) 2008 The DragonFly Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
16 * Neither the name of the DragonFly Project nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31 * OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Installer Function : Create HAMMER Subpartitions.
45 #define _(String) gettext (String)
47 #define _(String) (String)
50 #include "libaura/mem.h"
51 #include "libaura/buffer.h"
52 #include "libaura/dict.h"
53 #include "libaura/fspred.h"
55 #include "libdfui/dfui.h"
56 #include "libdfui/dump.h"
57 #include "libdfui/system.h"
59 #include "libinstaller/commands.h"
60 #include "libinstaller/diskutil.h"
61 #include "libinstaller/functions.h"
62 #include "libinstaller/uiutil.h"
66 #include "pathnames.h"
68 static int create_subpartitions(struct i_fn_args *);
69 static long default_capacity(struct storage *, const char *);
70 static int check_capacity(struct i_fn_args *);
71 static int check_subpartition_selections(struct dfui_response *, struct i_fn_args *);
72 static void save_subpartition_selections(struct dfui_response *, struct i_fn_args *);
73 static void populate_create_subpartitions_form(struct dfui_form *, struct i_fn_args *);
74 static int warn_subpartition_selections(struct i_fn_args *);
75 static struct dfui_form *make_create_subpartitions_form(struct i_fn_args *);
76 static int show_create_subpartitions_form(struct dfui_form *, struct i_fn_args *);
78 static const char *def_mountpt[] = {"/boot", "swap", "/", NULL};
79 static int expert = 0;
82 * Given a set of subpartitions-to-be in the selected slice,
86 create_subpartitions(struct i_fn_args *a)
88 struct subpartition *sp;
89 struct commands *cmds;
93 cmds = commands_new();
94 if (!is_file("%sinstall.disklabel.%s",
96 slice_get_device_name(storage_get_selected_slice(a->s)))) {
98 * Get a copy of the 'virgin' disklabel.
99 * XXX It might make more sense for this to
100 * happen right after format_slice() instead.
102 command_add(cmds, "%s%s -r %s >%sinstall.disklabel.%s",
103 a->os_root, cmd_name(a, "DISKLABEL64"),
104 slice_get_device_name(storage_get_selected_slice(a->s)),
106 slice_get_device_name(storage_get_selected_slice(a->s)));
110 * Weave together a new disklabel out the of the 'virgin'
111 * disklabel, and the user's subpartition choices.
115 * Take everything from the 'virgin' disklabel up until the
116 * '16 partitions' line.
119 command_add(cmds, "%s%s '$2==\"partitions:\" || cut { cut = 1 } !cut { print $0 }' <%sinstall.disklabel.%s >%sinstall.disklabel",
120 a->os_root, cmd_name(a, "AWK"),
122 slice_get_device_name(storage_get_selected_slice(a->s)),
127 * # size offset fstype
128 * c: 16383969 0 unused # 7999.985MB
131 command_add(cmds, "%s%s '%d partitions:' >>%sinstall.disklabel",
132 a->os_root, cmd_name(a, "ECHO"), num_partitions ,a->tmp);
133 command_add(cmds, "%s%s '%s' >>%sinstall.disklabel",
134 a->os_root, cmd_name(a, "ECHO"),
135 "# size offset fstype",
139 for (sp = slice_subpartition_first(storage_get_selected_slice(a->s));
140 sp != NULL; sp = subpartition_next(sp)) {
141 command_add(cmds, "%s%s 'mountpoint: %s device: %s'",
142 a->os_root, cmd_name(a, "ECHO"),
143 subpartition_get_mountpoint(sp),
144 subpartition_get_device_name(sp));
149 * Write a line for each subpartition the user wants.
151 for (sp = slice_subpartition_first(storage_get_selected_slice(a->s));
152 sp != NULL; sp = subpartition_next(sp)) {
153 if (subpartition_is_mfsbacked(sp)) {
156 if (subpartition_is_swap(sp)) {
157 command_add(cmds, "%s%s ' %c:\t%s\t*\tswap' >>%sinstall.disklabel",
158 a->os_root, cmd_name(a, "ECHO"),
159 subpartition_get_letter(sp),
160 capacity_to_string(subpartition_get_capacity(sp)),
162 } else if (strcmp(subpartition_get_mountpoint(sp), "/boot") == 0) {
163 command_add(cmds, "%s%s ' %c:\t%s\t0\t4.2BSD' >>%sinstall.disklabel",
164 a->os_root, cmd_name(a, "ECHO"),
165 subpartition_get_letter(sp),
166 capacity_to_string(subpartition_get_capacity(sp)),
169 command_add(cmds, "%s%s ' %c:\t%s\t*\tHAMMER' >>%sinstall.disklabel",
170 a->os_root, cmd_name(a, "ECHO"),
171 subpartition_get_letter(sp),
172 capacity_to_string(subpartition_get_capacity(sp)),
176 temp_file_add(a, "install.disklabel");
179 * Label the slice from the disklabel we just wove together.
181 command_add(cmds, "%s%s -R -B -r %s %sinstall.disklabel",
182 a->os_root, cmd_name(a, "DISKLABEL64"),
183 slice_get_device_name(storage_get_selected_slice(a->s)),
187 * Create a snapshot of the disklabel we just created
188 * for debugging inspection in the log.
190 command_add(cmds, "%s%s %s",
191 a->os_root, cmd_name(a, "DISKLABEL64"),
192 slice_get_device_name(storage_get_selected_slice(a->s)));
195 * Create filesystems on the newly-created subpartitions.
197 for (sp = slice_subpartition_first(storage_get_selected_slice(a->s));
198 sp != NULL; sp = subpartition_next(sp)) {
199 if (subpartition_is_swap(sp) || subpartition_is_mfsbacked(sp))
202 if (strcmp(subpartition_get_mountpoint(sp), "/boot") == 0) {
203 command_add(cmds, "%s%s %sdev/%s",
204 a->os_root, cmd_name(a, "NEWFS"),
206 subpartition_get_device_name(sp));
208 command_add(cmds, "%s%s -f -L ROOT %sdev/%s",
209 a->os_root, cmd_name(a, "NEWFS_HAMMER"),
211 subpartition_get_device_name(sp));
215 result = commands_execute(a, cmds);
221 default_capacity(struct storage *s, const char *mtpt)
224 unsigned long capacity;
227 capacity = slice_get_capacity(storage_get_selected_slice(s));
228 mem = storage_get_memsize(s);
230 if (mem > (capacity / 2) || capacity < 4096)
237 if (capacity < DISK_MIN) {
239 * For the purposes of this installer:
240 * can't be done. Sorry.
243 } else if (strcmp(mtpt, "/boot") == 0) {
245 } else if (strcmp(mtpt, "swap") == 0) {
247 } else if (strcmp(mtpt, "/") == 0) {
250 /* shouldn't ever happen */
255 check_capacity(struct i_fn_args *a)
257 struct subpartition *sp;
258 unsigned long min_capacity[] = {256, 0, DISK_MIN - 256, 0};
259 unsigned long total_capacity = 0;
262 for (sp = slice_subpartition_first(storage_get_selected_slice(a->s));
263 sp != NULL; sp = subpartition_next(sp)) {
264 if (subpartition_get_capacity(sp) == -1)
267 total_capacity += subpartition_get_capacity(sp);
268 for (mtpt = 0; def_mountpt[mtpt] != NULL; mtpt++) {
269 if (strcmp(subpartition_get_mountpoint(sp), def_mountpt[mtpt]) == 0 &&
270 min_capacity[mtpt] > 0 &&
271 subpartition_get_capacity(sp) < min_capacity[mtpt]) {
272 inform(a->c, _("WARNING: the %s subpartition should "
273 "be at least %dM in size or you will "
274 "risk running out of space during "
275 "the installation."),
276 subpartition_get_mountpoint(sp), min_capacity[mtpt]);
279 if (strcmp(subpartition_get_mountpoint(sp), "/") == 0 &&
280 subpartition_get_capacity(sp) < HAMMER_MIN) {
281 inform(a->c, _("WARNING: HAMMER file systems"
282 "less than 50G are not recommended! You may"
283 "have to run 'hammer prune-everything' and 'hammer reblock'"
284 "quite often, even if using a nohistory mount."));
288 if (total_capacity > slice_get_capacity(storage_get_selected_slice(a->s))) {
289 inform(a->c, _("The space allocated to all of your selected "
290 "subpartitions (%dM) exceeds the total "
291 "capacity of the selected primary partition "
292 "(%dM). Remove some subpartitions or choose "
293 "a smaller size for them and try again."),
294 total_capacity, slice_get_capacity(storage_get_selected_slice(a->s)));
302 check_subpartition_selections(struct dfui_response *r, struct i_fn_args *a)
304 struct dfui_dataset *ds;
305 struct dfui_dataset *star_ds = NULL;
307 const char *mountpoint, *capstring;
312 d = aura_dict_new(1, AURA_DICT_LIST);
314 if ((ds = dfui_response_dataset_get_first(r)) == NULL) {
315 inform(a->c, _("Please set up at least one subpartition."));
319 for (ds = dfui_response_dataset_get_first(r); valid && ds != NULL;
320 ds = dfui_dataset_get_next(ds)) {
322 dfui_dataset_dump(ds);
324 mountpoint = dfui_dataset_get_value(ds, "mountpoint");
325 capstring = dfui_dataset_get_value(ds, "capacity");
327 if (aura_dict_exists(d, mountpoint, strlen(mountpoint) + 1)) {
328 inform(a->c, _("The same mount point cannot be specified "
329 "for two different subpartitions."));
333 if (strcmp(mountpoint, "/") == 0)
336 if (strcmp(capstring, "*") == 0) {
337 if (star_ds != NULL) {
338 inform(a->c, _("You cannot have more than one subpartition "
339 "with a '*' capacity (meaning 'use the remainder "
340 "of the primary partition'.)"));
347 if (!(!strcasecmp(mountpoint, "swap") || mountpoint[0] == '/')) {
348 inform(a->c, _("Mount point must be either 'swap', or it must "
349 "start with a '/'."));
353 if (strpbrk(mountpoint, " \\\"'`") != NULL) {
354 inform(a->c, _("Mount point may not contain the following "
355 "characters: blank space, backslash, or "
356 "single, double, or back quotes."));
360 if (strlen(capstring) == 0) {
361 inform(a->c, _("A capacity must be specified."));
365 if (!string_to_capacity(capstring, &capacity)) {
366 inform(a->c, _("Capacity must be either a '*' symbol to indicate "
367 "'use the rest of the primary partition', or it "
368 "must be a series of decimal digits ending with a "
369 "'M' (indicating megabytes) or a 'G' (indicating "
374 if ((strcasecmp(mountpoint, "swap") == 0) && (capacity > 8192)) {
375 inform(a->c, _("Swap capacity is limited to 8G."));
380 * If we made it through that obstacle course, all is well.
384 aura_dict_store(d, mountpoint, strlen(mountpoint) + 1, "", 1);
388 inform(a->c, _("You must include a / (root) subpartition."));
392 if (aura_dict_size(d) > 16) {
393 inform(a->c, _("You cannot have more than 16 subpartitions "
394 "on a single primary partition. Remove some "
405 save_subpartition_selections(struct dfui_response *r, struct i_fn_args *a)
407 struct dfui_dataset *ds;
408 const char *mountpoint, *capstring;
412 subpartitions_free(storage_get_selected_slice(a->s));
414 for (ds = dfui_response_dataset_get_first(r); valid && ds != NULL;
415 ds = dfui_dataset_get_next(ds)) {
416 mountpoint = dfui_dataset_get_value(ds, "mountpoint");
417 capstring = dfui_dataset_get_value(ds, "capacity");
419 if (string_to_capacity(capstring, &capacity)) {
420 subpartition_new_hammer(storage_get_selected_slice(a->s),
421 mountpoint, capacity);
427 populate_create_subpartitions_form(struct dfui_form *f, struct i_fn_args *a)
429 struct subpartition *sp;
430 struct dfui_dataset *ds;
434 if (slice_subpartition_first(storage_get_selected_slice(a->s)) != NULL) {
436 * The user has already given us their subpartition
437 * preferences, so use them here.
439 for (sp = slice_subpartition_first(storage_get_selected_slice(a->s));
440 sp != NULL; sp = subpartition_next(sp)) {
441 ds = dfui_dataset_new();
442 dfui_dataset_celldata_add(ds, "mountpoint",
443 subpartition_get_mountpoint(sp));
444 dfui_dataset_celldata_add(ds, "capacity",
445 capacity_to_string(subpartition_get_capacity(sp)));
446 dfui_form_dataset_add(f, ds);
450 * Otherwise, populate the form with datasets representing
451 * reasonably-calculated defaults. The defaults are chosen
452 * based on the slice's total capacity and the machine's
453 * total physical memory (for swap.)
455 for (i = 0; def_mountpt[i] != NULL; i++) {
456 capacity = default_capacity(a->s, def_mountpt[i]);
457 ds = dfui_dataset_new();
458 dfui_dataset_celldata_add(ds, "mountpoint",
460 dfui_dataset_celldata_add(ds, "capacity",
461 capacity_to_string(capacity));
462 dfui_form_dataset_add(f, ds);
468 warn_subpartition_selections(struct i_fn_args *a)
472 if (subpartition_find(storage_get_selected_slice(a->s), "/boot") == NULL) {
473 inform(a->c, _("The /boot partition must not be omitted."));
474 } else if (subpartition_find(storage_get_selected_slice(a->s), "/home") != NULL ||
475 subpartition_find(storage_get_selected_slice(a->s), "/tmp") != NULL ||
476 subpartition_find(storage_get_selected_slice(a->s), "/usr") != NULL ||
477 subpartition_find(storage_get_selected_slice(a->s), "/usr/obj") != NULL ||
478 subpartition_find(storage_get_selected_slice(a->s), "/var") != NULL ||
479 subpartition_find(storage_get_selected_slice(a->s), "/var/crash") != NULL ||
480 subpartition_find(storage_get_selected_slice(a->s), "/var/tmp") != NULL) {
481 inform(a->c, _("Pseudo filesystems will automatically be created "
482 "for /home, /tmp, /usr, /usr/obj, /var, /var/crash "
483 "and /var/tmp and must not be specified."));
485 valid = check_capacity(a);
491 static struct dfui_form *
492 make_create_subpartitions_form(struct i_fn_args *a)
495 char msg_buf[1][1024];
497 snprintf(msg_buf[0], sizeof(msg_buf[0]),
498 _("Subpartitions further divide a primary partition for "
499 "use with %s. Some reasons you may want "
500 "a set of subpartitions are:\n\n"
501 "- you want to restrict how much data can be written "
502 "to certain parts of the primary partition, to quell "
503 "denial-of-service attacks; and\n"
504 "- you want to speed up access to data on the disk."
505 ""), OPERATING_SYSTEM_NAME);
507 f = dfui_form_create(
508 "create_subpartitions",
509 _("Create Subpartitions"),
510 _("Set up the subpartitions (also known as just `partitions' "
511 "in BSD tradition) you want to have on this primary "
512 "partition. In most cases you should be fine with "
513 "the default settings.\n\n"
514 "For Capacity, use 'M' to indicate megabytes, 'G' to "
515 "indicate gigabytes, or a single '*' to indicate "
516 "'use the remaining space on the primary partition'."),
520 "p", "special", "dfinstaller_create_subpartitions",
521 "p", "minimum_width","64",
523 "f", "mountpoint", _("Mountpoint"), "", "",
524 "f", "capacity", _("Capacity"), "", "",
526 "a", "ok", _("Accept and Create"), "", "",
528 (disk_get_formatted(storage_get_selected_disk(a->s)) ?
529 _("Return to Select Disk") :
530 _("Return to Select Primary Partition")), "", "",
531 "p", "accelerator", "ESC",
536 dfui_form_set_multiple(f, 1);
537 dfui_form_set_extensible(f, 1);
539 * Remove ATM until HAMMER installer support is better
540 * dfui_form_set_extensible(f, 1);
544 fi = dfui_form_field_add(f, "softupdates",
545 dfui_info_new(_("Softupdates"), "", ""));
546 dfui_field_property_set(fi, "control", "checkbox");
548 fi = dfui_form_field_add(f, "mfsbacked",
549 dfui_info_new(_("MFS"), "", ""));
550 dfui_field_property_set(fi, "control", "checkbox");
552 fi = dfui_form_field_add(f, "fsize",
553 dfui_info_new(_("Frag Sz"), "", ""));
555 fi = dfui_form_field_add(f, "bsize",
556 dfui_info_new(_("Block Sz"), "", ""));
558 dfui_form_action_add(f, "switch",
559 dfui_info_new(_("Switch to Normal Mode"), "", ""));
561 dfui_form_action_add(f, "switch",
562 dfui_info_new(_("Switch to Expert Mode"), "", ""));
570 * -1 = the form should be redisplayed
571 * 0 = failure, function is over
572 * 1 = success, function is over
575 show_create_subpartitions_form(struct dfui_form *f, struct i_fn_args *a)
577 struct dfui_dataset *ds;
578 struct dfui_response *r;
581 if (dfui_form_dataset_get_first(f) == NULL)
582 populate_create_subpartitions_form(f, a);
584 if (!dfui_be_present(a->c, f, &r))
587 if (strcmp(dfui_response_get_action_id(r), "cancel") == 0) {
588 dfui_response_free(r);
590 } else if (strcmp(dfui_response_get_action_id(r), "switch") == 0) {
591 if (check_subpartition_selections(r, a)) {
592 save_subpartition_selections(r, a);
593 expert = expert ? 0 : 1;
594 dfui_response_free(r);
598 if (check_subpartition_selections(r, a)) {
599 save_subpartition_selections(r, a);
600 if (!warn_subpartition_selections(a)) {
601 if (!create_subpartitions(a)) {
602 inform(a->c, _("The subpartitions you chose were "
603 "not correctly created, and the "
604 "primary partition may "
605 "now be in an inconsistent state. "
606 "We recommend re-formatting it "
607 "before proceeding."));
608 dfui_response_free(r);
611 dfui_response_free(r);
618 dfui_form_datasets_free(f);
619 /* dfui_form_datasets_add_from_response(f, r); */
620 for (ds = dfui_response_dataset_get_first(r); ds != NULL;
621 ds = dfui_dataset_get_next(ds)) {
622 dfui_form_dataset_add(f, dfui_dataset_dup(ds));
628 * fn_create_subpartitions_hammer: let the user specify what subpartitions they
629 * want on the disk, how large each should be, and where it should be mounted.
632 fn_create_subpartitions_hammer(struct i_fn_args *a)
639 f = make_create_subpartitions_form(a);
640 switch (show_create_subpartitions_form(f, a)) {