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
)
237 if (capacity
< DISK_MIN
) {
239 * For the purposes of this installer:
240 * can't be done. Sorry.
243 } else if (capacity
< 1024) {
245 case MTPT_ROOT
: return(-1);
246 case MTPT_SWAP
: return(swap
);
247 case MTPT_VAR
: return(256);
248 case MTPT_TMP
: return(256);
249 case MTPT_USR
: return(3072);
253 case MTPT_ROOT
: return(-1);
254 case MTPT_SWAP
: return(swap
);
255 case MTPT_VAR
: return(256);
256 case MTPT_TMP
: return(256);
257 case MTPT_USR
: return(8192);
260 /* shouldn't ever happen */
265 check_capacity(struct i_fn_args
*a
)
267 struct subpartition
*sp
;
268 unsigned long min_capacity
[7] = {128, 128,0, 8, 0, 174, 0};
269 unsigned long total_capacity
= 0;
272 if (subpartition_find(storage_get_selected_slice(a
->s
), "/usr") == NULL
)
273 min_capacity
[MTPT_ROOT
] += min_capacity
[MTPT_USR
];
275 for (sp
= slice_subpartition_first(storage_get_selected_slice(a
->s
));
276 sp
!= NULL
; sp
= subpartition_next(sp
)) {
277 if (subpartition_get_capacity(sp
) == -1)
280 total_capacity
+= subpartition_get_capacity(sp
);
281 for (mtpt
= 0; def_mountpt
[mtpt
] != NULL
; mtpt
++) {
282 if (strcmp(subpartition_get_mountpoint(sp
), def_mountpt
[mtpt
]) == 0 &&
283 min_capacity
[mtpt
] > 0 &&
284 subpartition_get_capacity(sp
) < min_capacity
[mtpt
]) {
285 inform(a
->c
, _("WARNING: the %s subpartition should "
286 "be at least %dM in size or you will "
287 "risk running out of space during "
288 "the installation."),
289 subpartition_get_mountpoint(sp
), min_capacity
[mtpt
]);
292 if (strcmp(subpartition_get_mountpoint(sp
), "/") == 0 &&
293 subpartition_get_capacity(sp
) < HAMMER_MIN
) {
294 inform(a
->c
, _("WARNING: HAMMER file systems"
295 "less than 50G are not recommended! You may"
296 "have to run 'hammer prune-everything' and 'hammer reblock'"
297 "quite often, even if using a nohistory mount."));
301 if (total_capacity
> slice_get_capacity(storage_get_selected_slice(a
->s
))) {
302 inform(a
->c
, _("The space allocated to all of your selected "
303 "subpartitions (%dM) exceeds the total "
304 "capacity of the selected primary partition "
305 "(%dM). Remove some subpartitions or choose "
306 "a smaller size for them and try again."),
307 total_capacity
, slice_get_capacity(storage_get_selected_slice(a
->s
)));
315 check_subpartition_selections(struct dfui_response
*r
, struct i_fn_args
*a
)
317 struct dfui_dataset
*ds
;
318 struct dfui_dataset
*star_ds
= NULL
;
320 const char *mountpoint
, *capstring
;
326 d
= aura_dict_new(1, AURA_DICT_LIST
);
328 if ((ds
= dfui_response_dataset_get_first(r
)) == NULL
) {
329 inform(a
->c
, _("Please set up at least one subpartition."));
333 for (ds
= dfui_response_dataset_get_first(r
); valid
&& ds
!= NULL
;
334 ds
= dfui_dataset_get_next(ds
)) {
336 dfui_dataset_dump(ds
);
338 mountpoint
= dfui_dataset_get_value(ds
, "mountpoint");
339 capstring
= dfui_dataset_get_value(ds
, "capacity");
343 (strcmp(dfui_dataset_get_value(ds
, "softupdates"), "Y") == 0);
344 fsize
= atol(dfui_dataset_get_value(ds
, "fsize"));
345 bsize
= atol(dfui_dataset_get_value(ds
, "bsize"));
346 mfsbacked
= (strcmp(dfui_dataset_get_value(ds
, "mfsbacked"), "Y") == 0);
348 softupdates
= (strcmp(mountpoint
, "/") == 0 ? 0 : 1);
349 mfsbacked
= (strcmp(mountpoint
, "/tmp") == 0 ? 0 : 1);
354 if (aura_dict_exists(d
, mountpoint
, strlen(mountpoint
) + 1)) {
355 inform(a
->c
, _("The same mount point cannot be specified "
356 "for two different subpartitions."));
360 if (strcmp(mountpoint
, "/") == 0)
363 if (strcmp(capstring
, "*") == 0) {
364 if (star_ds
!= NULL
) {
365 inform(a
->c
, _("You cannot have more than one subpartition "
366 "with a '*' capacity (meaning 'use the remainder "
367 "of the primary partition'.)"));
374 if (!(!strcasecmp(mountpoint
, "swap") || mountpoint
[0] == '/')) {
375 inform(a
->c
, _("Mount point must be either 'swap', or it must "
376 "start with a '/'."));
380 if (strpbrk(mountpoint
, " \\\"'`") != NULL
) {
381 inform(a
->c
, _("Mount point may not contain the following "
382 "characters: blank space, backslash, or "
383 "single, double, or back quotes."));
387 if (strlen(capstring
) == 0) {
388 inform(a
->c
, _("A capacity must be specified."));
392 if (!string_to_capacity(capstring
, &capacity
)) {
393 inform(a
->c
, _("Capacity must be either a '*' symbol to indicate "
394 "'use the rest of the primary partition', or it "
395 "must be a series of decimal digits ending with a "
396 "'M' (indicating megabytes) or a 'G' (indicating "
402 * If we made it through that obstacle course, all is well.
406 aura_dict_store(d
, mountpoint
, strlen(mountpoint
) + 1, "", 1);
410 inform(a
->c
, _("You must include a / (root) subpartition."));
414 if (aura_dict_size(d
) > 16) {
415 inform(a
->c
, _("You cannot have more than 16 subpartitions "
416 "on a single primary partition. Remove some "
427 save_subpartition_selections(struct dfui_response
*r
, struct i_fn_args
*a
)
429 struct dfui_dataset
*ds
;
431 const char *mountpoint
, *capstring
;
436 subpartitions_free(storage_get_selected_slice(a
->s
));
438 for (ds
= dfui_response_dataset_get_first(r
); valid
&& ds
!= NULL
;
439 ds
= dfui_dataset_get_next(ds
)) {
440 mountpoint
= dfui_dataset_get_value(ds
, "mountpoint");
441 capstring
= dfui_dataset_get_value(ds
, "capacity");
445 (strcmp(dfui_dataset_get_value(ds
, "softupdates"), "Y") == 0);
446 fsize
= atol(dfui_dataset_get_value(ds
, "fsize"));
447 bsize
= atol(dfui_dataset_get_value(ds
, "bsize"));
448 mfsbacked
= (strcmp(dfui_dataset_get_value(ds
, "msfbacked"), "Y") == 0);
450 softupdates
= (strcmp(mountpoint
, "/") == 0 ? 0 : 1);
456 if (string_to_capacity(capstring
, &capacity
)) {
457 subpartition_new_hammer(storage_get_selected_slice(a
->s
),
458 mountpoint
, capacity
);
464 populate_create_subpartitions_form(struct dfui_form
*f
, struct i_fn_args
*a
)
466 struct subpartition
*sp
;
467 struct dfui_dataset
*ds
;
472 if (slice_subpartition_first(storage_get_selected_slice(a
->s
)) != NULL
) {
474 * The user has already given us their subpartition
475 * preferences, so use them here.
477 for (sp
= slice_subpartition_first(storage_get_selected_slice(a
->s
));
478 sp
!= NULL
; sp
= subpartition_next(sp
)) {
479 ds
= dfui_dataset_new();
480 dfui_dataset_celldata_add(ds
, "mountpoint",
481 subpartition_get_mountpoint(sp
));
482 dfui_dataset_celldata_add(ds
, "capacity",
483 capacity_to_string(subpartition_get_capacity(sp
)));
484 dfui_form_dataset_add(f
, ds
);
488 * Otherwise, populate the form with datasets representing
489 * reasonably-calculated defaults. The defaults are chosen
490 * based on the slice's total capacity and the machine's
491 * total physical memory (for swap.)
493 for (mtpt
= 0; def_mountpt
[mtpt
] != NULL
; mtpt
++) {
494 /* XXX matthias. skip them for now */
495 if (mtpt
!= MTPT_ROOT
&& mtpt
!= MTPT_SWAP
)
497 capacity
= default_capacity(a
->s
, mtpt
);
498 ds
= dfui_dataset_new();
499 dfui_dataset_celldata_add(ds
, "mountpoint",
501 dfui_dataset_celldata_add(ds
, "capacity",
502 capacity_to_string(capacity
));
503 dfui_form_dataset_add(f
, ds
);
509 warn_subpartition_selections(struct i_fn_args
*a
)
512 struct aura_buffer
*omit
, *consequences
;
514 omit
= aura_buffer_new(2048);
515 consequences
= aura_buffer_new(2048);
517 valid
= check_capacity(a
);
520 * Should we add an information here, that we created /usr, /var, /home
524 if (subpartition_find(storage_get_selected_slice(a
->s
), "/var") == NULL
) {
525 aura_buffer_cat(omit
, "/var ");
526 aura_buffer_cat(consequences
, _("/var will be a plain dir in /\n"));
528 if (subpartition_find(storage_get_selected_slice(a
->s
), "/usr") == NULL
) {
529 aura_buffer_cat(omit
, "/usr ");
530 aura_buffer_cat(consequences
, _("/usr will be a plain dir in /\n"));
532 if (subpartition_find(storage_get_selected_slice(a
->s
), "/tmp") == NULL
) {
533 aura_buffer_cat(omit
, "/tmp ");
534 aura_buffer_cat(consequences
, _("/tmp will be symlinked to /var/tmp\n"));
536 if (subpartition_find(storage_get_selected_slice(a
->s
), "/home") == NULL
) {
537 aura_buffer_cat(omit
, "/home ");
538 aura_buffer_cat(consequences
, _("/home will be symlinked to /usr/home\n"));
541 if (valid
&& aura_buffer_len(omit
) > 0) {
542 switch (dfui_be_present_dialog(a
->c
, _("Really omit?"),
543 _("Omit Subpartition(s)|Return to Create Subpartitions"),
544 _("You have elected to not have the following "
545 "subpartition(s):\n\n%s\n\n"
546 "The ramifications of these subpartition(s) being "
547 "missing will be:\n\n%s\n"
548 "Is this really what you want to do?"),
549 aura_buffer_buf(omit
), aura_buffer_buf(consequences
))) {
561 aura_buffer_free(omit
);
562 aura_buffer_free(consequences
);
567 static struct dfui_form
*
568 make_create_subpartitions_form(struct i_fn_args
*a
)
570 struct dfui_field
*fi
;
572 char msg_buf
[1][1024];
574 snprintf(msg_buf
[0], sizeof(msg_buf
[0]),
575 _("Subpartitions further divide a primary partition for "
576 "use with %s. Some reasons you may want "
577 "a set of subpartitions are:\n\n"
578 "- you want to restrict how much data can be written "
579 "to certain parts of the primary partition, to quell "
580 "denial-of-service attacks; and\n"
581 "- you want to speed up access to data on the disk."
582 ""), OPERATING_SYSTEM_NAME
);
584 f
= dfui_form_create(
585 "create_subpartitions",
586 _("Create Subpartitions"),
587 _("Set up the subpartitions (also known as just `partitions' "
588 "in BSD tradition) you want to have on this primary "
590 "For Capacity, use 'M' to indicate megabytes, 'G' to "
591 "indicate gigabytes, or a single '*' to indicate "
592 "'use the remaining space on the primary partition'."),
596 "p", "special", "dfinstaller_create_subpartitions",
597 "p", "minimum_width","64",
599 "f", "mountpoint", _("Mountpoint"), "", "",
600 "f", "capacity", _("Capacity"), "", "",
602 "a", "ok", _("Accept and Create"), "", "",
604 (disk_get_formatted(storage_get_selected_disk(a
->s
)) ?
605 _("Return to Select Disk") :
606 _("Return to Select Primary Partition")), "", "",
607 "p", "accelerator", "ESC",
612 dfui_form_set_multiple(f
, 1);
613 dfui_form_set_extensible(f
, 1);
615 * Remove ATM until HAMMER installer support is better
616 * dfui_form_set_extensible(f, 1);
620 fi
= dfui_form_field_add(f
, "softupdates",
621 dfui_info_new(_("Softupdates"), "", ""));
622 dfui_field_property_set(fi
, "control", "checkbox");
624 fi
= dfui_form_field_add(f
, "mfsbacked",
625 dfui_info_new(_("MFS"), "", ""));
626 dfui_field_property_set(fi
, "control", "checkbox");
628 fi
= dfui_form_field_add(f
, "fsize",
629 dfui_info_new(_("Frag Sz"), "", ""));
631 fi
= dfui_form_field_add(f
, "bsize",
632 dfui_info_new(_("Block Sz"), "", ""));
634 dfui_form_action_add(f
, "switch",
635 dfui_info_new(_("Switch to Normal Mode"), "", ""));
637 dfui_form_action_add(f
, "switch",
638 dfui_info_new(_("Switch to Expert Mode"), "", ""));
646 * -1 = the form should be redisplayed
647 * 0 = failure, function is over
648 * 1 = success, function is over
651 show_create_subpartitions_form(struct dfui_form
*f
, struct i_fn_args
*a
)
653 struct dfui_dataset
*ds
;
654 struct dfui_response
*r
;
657 if (dfui_form_dataset_get_first(f
) == NULL
)
658 populate_create_subpartitions_form(f
, a
);
660 if (!dfui_be_present(a
->c
, f
, &r
))
663 if (strcmp(dfui_response_get_action_id(r
), "cancel") == 0) {
664 dfui_response_free(r
);
666 } else if (strcmp(dfui_response_get_action_id(r
), "switch") == 0) {
667 if (check_subpartition_selections(r
, a
)) {
668 save_subpartition_selections(r
, a
);
669 expert
= expert
? 0 : 1;
670 dfui_response_free(r
);
674 if (check_subpartition_selections(r
, a
)) {
675 save_subpartition_selections(r
, a
);
676 if (!warn_subpartition_selections(a
)) {
677 if (!create_subpartitions(a
)) {
678 inform(a
->c
, _("The subpartitions you chose were "
679 "not correctly created, and the "
680 "primary partition may "
681 "now be in an inconsistent state. "
682 "We recommend re-formatting it "
683 "before proceeding."));
684 dfui_response_free(r
);
687 dfui_response_free(r
);
694 dfui_form_datasets_free(f
);
695 /* dfui_form_datasets_add_from_response(f, r); */
696 for (ds
= dfui_response_dataset_get_first(r
); ds
!= NULL
;
697 ds
= dfui_dataset_get_next(ds
)) {
698 dfui_form_dataset_add(f
, dfui_dataset_dup(ds
));
704 * fn_create_subpartitions_hammer: let the user specify what subpartitions they
705 * want on the disk, how large each should be, and where it should be mounted.
708 fn_create_subpartitions_hammer(struct i_fn_args
*a
)
715 f
= make_create_subpartitions_form(a
);
716 switch (show_create_subpartitions_form(f
, a
)) {