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
*, int);
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
[7] = {"/", "swap", "/var", "/tmp", "/usr", "/home", NULL
};
79 static long def_capacity
[7] = {-1, 128, 128, 128, 256, 128, 0};
81 static int expert
= 0;
84 * Given a set of subpartitions-to-be in the selected slice,
88 create_subpartitions(struct i_fn_args
*a
)
90 struct subpartition
*sp
;
91 struct commands
*cmds
;
93 int copied_original
= 0;
96 cmds
= commands_new();
97 if (!is_file("%sinstall.disklabel.%s",
99 slice_get_device_name(storage_get_selected_slice(a
->s
)))) {
101 * Get a copy of the 'virgin' disklabel.
102 * XXX It might make more sense for this to
103 * happen right after format_slice() instead.
105 command_add(cmds
, "%s%s -r %s >%sinstall.disklabel.%s",
106 a
->os_root
, cmd_name(a
, "DISKLABEL64"),
107 slice_get_device_name(storage_get_selected_slice(a
->s
)),
109 slice_get_device_name(storage_get_selected_slice(a
->s
)));
113 * Weave together a new disklabel out the of the 'virgin'
114 * disklabel, and the user's subpartition choices.
118 * Take everything from the 'virgin' disklabel up until the
119 * '16 partitions' line.
122 command_add(cmds
, "%s%s '$2==\"partitions:\" || cut { cut = 1 } !cut { print $0 }' <%sinstall.disklabel.%s >%sinstall.disklabel",
123 a
->os_root
, cmd_name(a
, "AWK"),
125 slice_get_device_name(storage_get_selected_slice(a
->s
)),
130 * # size offset fstype
131 * c: 16383969 0 unused # 7999.985MB
134 command_add(cmds
, "%s%s '%d partitions:' >>%sinstall.disklabel",
135 a
->os_root
, cmd_name(a
, "ECHO"), num_partitions
,a
->tmp
);
136 command_add(cmds
, "%s%s '%s' >>%sinstall.disklabel",
137 a
->os_root
, cmd_name(a
, "ECHO"),
138 "# size offset fstype",
142 for (sp
= slice_subpartition_first(storage_get_selected_slice(a
->s
));
143 sp
!= NULL
; sp
= subpartition_next(sp
)) {
144 command_add(cmds
, "%s%s 'mountpoint: %s device: %s'",
145 a
->os_root
, cmd_name(a
, "ECHO"),
146 subpartition_get_mountpoint(sp
),
147 subpartition_get_device_name(sp
));
152 * Write a line for each subpartition the user wants.
154 for (sp
= slice_subpartition_first(storage_get_selected_slice(a
->s
));
155 sp
!= NULL
; sp
= subpartition_next(sp
)) {
156 if (subpartition_is_mfsbacked(sp
)) {
159 if (subpartition_is_swap(sp
)) {
160 command_add(cmds
, "%s%s ' %c:\t%s\t*\tswap' >>%sinstall.disklabel",
161 a
->os_root
, cmd_name(a
, "ECHO"),
162 subpartition_get_letter(sp
),
163 capacity_to_string(subpartition_get_capacity(sp
)),
166 command_add(cmds
, "%s%s ' %c:\t%s\t%s\tHAMMER' >>%sinstall.disklabel",
167 a
->os_root
, cmd_name(a
, "ECHO"),
168 subpartition_get_letter(sp
),
169 capacity_to_string(subpartition_get_capacity(sp
)),
170 subpartition_get_letter(sp
) == 'a' ? "0" : "*",
174 temp_file_add(a
, "install.disklabel");
177 * Label the slice from the disklabel we just wove together.
179 command_add(cmds
, "%s%s -R -B -r %s %sinstall.disklabel",
180 a
->os_root
, cmd_name(a
, "DISKLABEL64"),
181 slice_get_device_name(storage_get_selected_slice(a
->s
)),
185 * Create a snapshot of the disklabel we just created
186 * for debugging inspection in the log.
188 command_add(cmds
, "%s%s %s",
189 a
->os_root
, cmd_name(a
, "DISKLABEL64"),
190 slice_get_device_name(storage_get_selected_slice(a
->s
)));
193 * Create filesystems on the newly-created subpartitions.
195 for (sp
= slice_subpartition_first(storage_get_selected_slice(a
->s
));
196 sp
!= NULL
; sp
= subpartition_next(sp
)) {
197 if (subpartition_is_swap(sp
) || subpartition_is_mfsbacked(sp
))
201 * Ensure that all the needed device nodes exist.
203 command_add_ensure_dev(a
, cmds
,
204 disk_get_device_name(storage_get_selected_disk(a
->s
)));
205 command_add_ensure_dev(a
, cmds
,
206 slice_get_device_name(storage_get_selected_slice(a
->s
)));
207 command_add_ensure_dev(a
, cmds
,
208 subpartition_get_device_name(sp
));
210 command_add(cmds
, "%s%s -f -L ROOT %sdev/%s",
211 a
->os_root
, cmd_name(a
, "NEWFS_HAMMER"),
213 subpartition_get_device_name(sp
));
216 result
= commands_execute(a
, cmds
);
222 default_capacity(struct storage
*s
, int mtpt
)
225 unsigned long capacity
;
227 if (mtpt
== MTPT_HOME
)
230 capacity
= slice_get_capacity(storage_get_selected_slice(s
));
231 swap
= 2 * storage_get_memsize(s
);
232 if (storage_get_memsize(s
) > (capacity
/ 2) || capacity
< 4096)
233 swap
= storage_get_memsize(s
);
234 if (storage_get_memsize(s
) > capacity
)
239 if (capacity
< DISK_MIN
) {
241 * For the purposes of this installer:
242 * can't be done. Sorry.
245 } else if (capacity
< 1024) {
247 case MTPT_ROOT
: return(-1);
248 case MTPT_SWAP
: return(swap
);
249 case MTPT_VAR
: return(256);
250 case MTPT_TMP
: return(256);
251 case MTPT_USR
: return(3072);
255 case MTPT_ROOT
: return(-1);
256 case MTPT_SWAP
: return(swap
);
257 case MTPT_VAR
: return(256);
258 case MTPT_TMP
: return(256);
259 case MTPT_USR
: return(8192);
262 /* shouldn't ever happen */
267 check_capacity(struct i_fn_args
*a
)
269 struct subpartition
*sp
;
270 unsigned long min_capacity
[7] = {128, 128,0, 8, 0, 174, 0};
271 unsigned long total_capacity
= 0;
274 if (subpartition_find(storage_get_selected_slice(a
->s
), "/usr") == NULL
)
275 min_capacity
[MTPT_ROOT
] += min_capacity
[MTPT_USR
];
277 for (sp
= slice_subpartition_first(storage_get_selected_slice(a
->s
));
278 sp
!= NULL
; sp
= subpartition_next(sp
)) {
279 if (subpartition_get_capacity(sp
) == -1)
282 total_capacity
+= subpartition_get_capacity(sp
);
283 for (mtpt
= 0; def_mountpt
[mtpt
] != NULL
; mtpt
++) {
284 if (strcmp(subpartition_get_mountpoint(sp
), def_mountpt
[mtpt
]) == 0 &&
285 min_capacity
[mtpt
] > 0 &&
286 subpartition_get_capacity(sp
) < min_capacity
[mtpt
]) {
287 inform(a
->c
, _("WARNING: the %s subpartition should "
288 "be at least %dM in size or you will "
289 "risk running out of space during "
290 "the installation."),
291 subpartition_get_mountpoint(sp
), min_capacity
[mtpt
]);
294 if (strcmp(subpartition_get_mountpoint(sp
), "/") == 0 &&
295 subpartition_get_capacity(sp
) < HAMMER_MIN
) {
296 inform(a
->c
, _("WARNING: HAMMER file systems"
297 "less than 50G are not recommended! You may"
298 "have to run 'hammer prune-everything' and 'hammer reblock'"
299 "quite often, even if using a nohistory mount."));
303 if (total_capacity
> slice_get_capacity(storage_get_selected_slice(a
->s
))) {
304 inform(a
->c
, _("The space allocated to all of your selected "
305 "subpartitions (%dM) exceeds the total "
306 "capacity of the selected primary partition "
307 "(%dM). Remove some subpartitions or choose "
308 "a smaller size for them and try again."),
309 total_capacity
, slice_get_capacity(storage_get_selected_slice(a
->s
)));
317 check_subpartition_selections(struct dfui_response
*r
, struct i_fn_args
*a
)
319 struct dfui_dataset
*ds
;
320 struct dfui_dataset
*star_ds
= NULL
;
322 const char *mountpoint
, *capstring
;
328 d
= aura_dict_new(1, AURA_DICT_LIST
);
330 if ((ds
= dfui_response_dataset_get_first(r
)) == NULL
) {
331 inform(a
->c
, _("Please set up at least one subpartition."));
335 for (ds
= dfui_response_dataset_get_first(r
); valid
&& ds
!= NULL
;
336 ds
= dfui_dataset_get_next(ds
)) {
338 dfui_dataset_dump(ds
);
340 mountpoint
= dfui_dataset_get_value(ds
, "mountpoint");
341 capstring
= dfui_dataset_get_value(ds
, "capacity");
345 (strcmp(dfui_dataset_get_value(ds
, "softupdates"), "Y") == 0);
346 fsize
= atol(dfui_dataset_get_value(ds
, "fsize"));
347 bsize
= atol(dfui_dataset_get_value(ds
, "bsize"));
348 mfsbacked
= (strcmp(dfui_dataset_get_value(ds
, "mfsbacked"), "Y") == 0);
350 softupdates
= (strcmp(mountpoint
, "/") == 0 ? 0 : 1);
351 mfsbacked
= (strcmp(mountpoint
, "/tmp") == 0 ? 0 : 1);
356 if (aura_dict_exists(d
, mountpoint
, strlen(mountpoint
) + 1)) {
357 inform(a
->c
, _("The same mount point cannot be specified "
358 "for two different subpartitions."));
362 if (strcmp(mountpoint
, "/") == 0)
365 if (strcmp(capstring
, "*") == 0) {
366 if (star_ds
!= NULL
) {
367 inform(a
->c
, _("You cannot have more than one subpartition "
368 "with a '*' capacity (meaning 'use the remainder "
369 "of the primary partition'.)"));
376 if (!(!strcasecmp(mountpoint
, "swap") || mountpoint
[0] == '/')) {
377 inform(a
->c
, _("Mount point must be either 'swap', or it must "
378 "start with a '/'."));
382 if (strpbrk(mountpoint
, " \\\"'`") != NULL
) {
383 inform(a
->c
, _("Mount point may not contain the following "
384 "characters: blank space, backslash, or "
385 "single, double, or back quotes."));
389 if (strlen(capstring
) == 0) {
390 inform(a
->c
, _("A capacity must be specified."));
394 if (!string_to_capacity(capstring
, &capacity
)) {
395 inform(a
->c
, _("Capacity must be either a '*' symbol to indicate "
396 "'use the rest of the primary partition', or it "
397 "must be a series of decimal digits ending with a "
398 "'M' (indicating megabytes) or a 'G' (indicating "
403 if ((strcasecmp(mountpoint
, "swap") == 0) && (capacity
> 8192)) {
404 inform(a
->c
, _("Swap capacity is limited to 8G."));
409 * If we made it through that obstacle course, all is well.
413 aura_dict_store(d
, mountpoint
, strlen(mountpoint
) + 1, "", 1);
417 inform(a
->c
, _("You must include a / (root) subpartition."));
421 if (aura_dict_size(d
) > 16) {
422 inform(a
->c
, _("You cannot have more than 16 subpartitions "
423 "on a single primary partition. Remove some "
434 save_subpartition_selections(struct dfui_response
*r
, struct i_fn_args
*a
)
436 struct dfui_dataset
*ds
;
438 const char *mountpoint
, *capstring
;
443 subpartitions_free(storage_get_selected_slice(a
->s
));
445 for (ds
= dfui_response_dataset_get_first(r
); valid
&& ds
!= NULL
;
446 ds
= dfui_dataset_get_next(ds
)) {
447 mountpoint
= dfui_dataset_get_value(ds
, "mountpoint");
448 capstring
= dfui_dataset_get_value(ds
, "capacity");
452 (strcmp(dfui_dataset_get_value(ds
, "softupdates"), "Y") == 0);
453 fsize
= atol(dfui_dataset_get_value(ds
, "fsize"));
454 bsize
= atol(dfui_dataset_get_value(ds
, "bsize"));
455 mfsbacked
= (strcmp(dfui_dataset_get_value(ds
, "mfsbacked"), "Y") == 0);
457 softupdates
= (strcmp(mountpoint
, "/") == 0 ? 0 : 1);
463 if (string_to_capacity(capstring
, &capacity
)) {
464 subpartition_new_hammer(storage_get_selected_slice(a
->s
),
465 mountpoint
, capacity
);
471 populate_create_subpartitions_form(struct dfui_form
*f
, struct i_fn_args
*a
)
473 struct subpartition
*sp
;
474 struct dfui_dataset
*ds
;
479 if (slice_subpartition_first(storage_get_selected_slice(a
->s
)) != NULL
) {
481 * The user has already given us their subpartition
482 * preferences, so use them here.
484 for (sp
= slice_subpartition_first(storage_get_selected_slice(a
->s
));
485 sp
!= NULL
; sp
= subpartition_next(sp
)) {
486 ds
= dfui_dataset_new();
487 dfui_dataset_celldata_add(ds
, "mountpoint",
488 subpartition_get_mountpoint(sp
));
489 dfui_dataset_celldata_add(ds
, "capacity",
490 capacity_to_string(subpartition_get_capacity(sp
)));
491 dfui_form_dataset_add(f
, ds
);
495 * Otherwise, populate the form with datasets representing
496 * reasonably-calculated defaults. The defaults are chosen
497 * based on the slice's total capacity and the machine's
498 * total physical memory (for swap.)
500 for (mtpt
= 0; def_mountpt
[mtpt
] != NULL
; mtpt
++) {
501 /* XXX matthias. skip them for now */
502 if (mtpt
!= MTPT_ROOT
&& mtpt
!= MTPT_SWAP
)
504 capacity
= default_capacity(a
->s
, mtpt
);
505 ds
= dfui_dataset_new();
506 dfui_dataset_celldata_add(ds
, "mountpoint",
508 dfui_dataset_celldata_add(ds
, "capacity",
509 capacity_to_string(capacity
));
510 dfui_form_dataset_add(f
, ds
);
516 warn_subpartition_selections(struct i_fn_args
*a
)
519 struct aura_buffer
*omit
, *consequences
;
521 omit
= aura_buffer_new(2048);
522 consequences
= aura_buffer_new(2048);
524 valid
= check_capacity(a
);
527 * Should we add an information here, that we created /usr, /var, /home
531 if (subpartition_find(storage_get_selected_slice(a
->s
), "/var") == NULL
) {
532 aura_buffer_cat(omit
, "/var ");
533 aura_buffer_cat(consequences
, _("/var will be a plain dir in /\n"));
535 if (subpartition_find(storage_get_selected_slice(a
->s
), "/usr") == NULL
) {
536 aura_buffer_cat(omit
, "/usr ");
537 aura_buffer_cat(consequences
, _("/usr will be a plain dir in /\n"));
539 if (subpartition_find(storage_get_selected_slice(a
->s
), "/tmp") == NULL
) {
540 aura_buffer_cat(omit
, "/tmp ");
541 aura_buffer_cat(consequences
, _("/tmp will be symlinked to /var/tmp\n"));
543 if (subpartition_find(storage_get_selected_slice(a
->s
), "/home") == NULL
) {
544 aura_buffer_cat(omit
, "/home ");
545 aura_buffer_cat(consequences
, _("/home will be symlinked to /usr/home\n"));
548 if (valid
&& aura_buffer_len(omit
) > 0) {
549 switch (dfui_be_present_dialog(a
->c
, _("Really omit?"),
550 _("Omit Subpartition(s)|Return to Create Subpartitions"),
551 _("You have elected to not have the following "
552 "subpartition(s):\n\n%s\n\n"
553 "The ramifications of these subpartition(s) being "
554 "missing will be:\n\n%s\n"
555 "Is this really what you want to do?"),
556 aura_buffer_buf(omit
), aura_buffer_buf(consequences
))) {
568 aura_buffer_free(omit
);
569 aura_buffer_free(consequences
);
574 static struct dfui_form
*
575 make_create_subpartitions_form(struct i_fn_args
*a
)
577 struct dfui_field
*fi
;
579 char msg_buf
[1][1024];
581 snprintf(msg_buf
[0], sizeof(msg_buf
[0]),
582 _("Subpartitions further divide a primary partition for "
583 "use with %s. Some reasons you may want "
584 "a set of subpartitions are:\n\n"
585 "- you want to restrict how much data can be written "
586 "to certain parts of the primary partition, to quell "
587 "denial-of-service attacks; and\n"
588 "- you want to speed up access to data on the disk."
589 ""), OPERATING_SYSTEM_NAME
);
591 f
= dfui_form_create(
592 "create_subpartitions",
593 _("Create Subpartitions"),
594 _("Set up the subpartitions (also known as just `partitions' "
595 "in BSD tradition) you want to have on this primary "
596 "partition.\n\nIMPORTANT: "
597 "You have chosen HAMMER as your file system. This means you will "
598 "not need to create separate subpartitions for /home, /usr, /var and "
599 "/tmp. The installer will create them automatically as pseudo-"
600 "filesystems (PFS) for you. In most cases you should be fine with "
601 "the default settings.\n\n"
602 "For Capacity, use 'M' to indicate megabytes, 'G' to "
603 "indicate gigabytes, or a single '*' to indicate "
604 "'use the remaining space on the primary partition'."),
608 "p", "special", "dfinstaller_create_subpartitions",
609 "p", "minimum_width","64",
611 "f", "mountpoint", _("Mountpoint"), "", "",
612 "f", "capacity", _("Capacity"), "", "",
614 "a", "ok", _("Accept and Create"), "", "",
616 (disk_get_formatted(storage_get_selected_disk(a
->s
)) ?
617 _("Return to Select Disk") :
618 _("Return to Select Primary Partition")), "", "",
619 "p", "accelerator", "ESC",
624 dfui_form_set_multiple(f
, 1);
625 dfui_form_set_extensible(f
, 1);
627 * Remove ATM until HAMMER installer support is better
628 * dfui_form_set_extensible(f, 1);
632 fi
= dfui_form_field_add(f
, "softupdates",
633 dfui_info_new(_("Softupdates"), "", ""));
634 dfui_field_property_set(fi
, "control", "checkbox");
636 fi
= dfui_form_field_add(f
, "mfsbacked",
637 dfui_info_new(_("MFS"), "", ""));
638 dfui_field_property_set(fi
, "control", "checkbox");
640 fi
= dfui_form_field_add(f
, "fsize",
641 dfui_info_new(_("Frag Sz"), "", ""));
643 fi
= dfui_form_field_add(f
, "bsize",
644 dfui_info_new(_("Block Sz"), "", ""));
646 dfui_form_action_add(f
, "switch",
647 dfui_info_new(_("Switch to Normal Mode"), "", ""));
649 dfui_form_action_add(f
, "switch",
650 dfui_info_new(_("Switch to Expert Mode"), "", ""));
658 * -1 = the form should be redisplayed
659 * 0 = failure, function is over
660 * 1 = success, function is over
663 show_create_subpartitions_form(struct dfui_form
*f
, struct i_fn_args
*a
)
665 struct dfui_dataset
*ds
;
666 struct dfui_response
*r
;
669 if (dfui_form_dataset_get_first(f
) == NULL
)
670 populate_create_subpartitions_form(f
, a
);
672 if (!dfui_be_present(a
->c
, f
, &r
))
675 if (strcmp(dfui_response_get_action_id(r
), "cancel") == 0) {
676 dfui_response_free(r
);
678 } else if (strcmp(dfui_response_get_action_id(r
), "switch") == 0) {
679 if (check_subpartition_selections(r
, a
)) {
680 save_subpartition_selections(r
, a
);
681 expert
= expert
? 0 : 1;
682 dfui_response_free(r
);
686 if (check_subpartition_selections(r
, a
)) {
687 save_subpartition_selections(r
, a
);
688 if (!warn_subpartition_selections(a
)) {
689 if (!create_subpartitions(a
)) {
690 inform(a
->c
, _("The subpartitions you chose were "
691 "not correctly created, and the "
692 "primary partition may "
693 "now be in an inconsistent state. "
694 "We recommend re-formatting it "
695 "before proceeding."));
696 dfui_response_free(r
);
699 dfui_response_free(r
);
706 dfui_form_datasets_free(f
);
707 /* dfui_form_datasets_add_from_response(f, r); */
708 for (ds
= dfui_response_dataset_get_first(r
); ds
!= NULL
;
709 ds
= dfui_dataset_get_next(ds
)) {
710 dfui_form_dataset_add(f
, dfui_dataset_dup(ds
));
716 * fn_create_subpartitions_hammer: let the user specify what subpartitions they
717 * want on the disk, how large each should be, and where it should be mounted.
720 fn_create_subpartitions_hammer(struct i_fn_args
*a
)
727 f
= make_create_subpartitions_form(a
);
728 switch (show_create_subpartitions_form(f
, a
)) {