xref: /freebsd/usr.bin/mkimg/scheme.c (revision 1d386b48a555f61cb7325543adbbb5c3f3407a66)
1a5eb4ea3SMarcel Moolenaar /*-
2a5eb4ea3SMarcel Moolenaar  * Copyright (c) 2013,2014 Juniper Networks, Inc.
3a5eb4ea3SMarcel Moolenaar  * All rights reserved.
4a5eb4ea3SMarcel Moolenaar  *
5a5eb4ea3SMarcel Moolenaar  * Redistribution and use in source and binary forms, with or without
6a5eb4ea3SMarcel Moolenaar  * modification, are permitted provided that the following conditions
7a5eb4ea3SMarcel Moolenaar  * are met:
8a5eb4ea3SMarcel Moolenaar  * 1. Redistributions of source code must retain the above copyright
9a5eb4ea3SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer.
10a5eb4ea3SMarcel Moolenaar  * 2. Redistributions in binary form must reproduce the above copyright
11a5eb4ea3SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer in the
12a5eb4ea3SMarcel Moolenaar  *    documentation and/or other materials provided with the distribution.
13a5eb4ea3SMarcel Moolenaar  *
14a5eb4ea3SMarcel Moolenaar  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15a5eb4ea3SMarcel Moolenaar  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16a5eb4ea3SMarcel Moolenaar  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17a5eb4ea3SMarcel Moolenaar  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18a5eb4ea3SMarcel Moolenaar  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19a5eb4ea3SMarcel Moolenaar  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20a5eb4ea3SMarcel Moolenaar  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21a5eb4ea3SMarcel Moolenaar  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22a5eb4ea3SMarcel Moolenaar  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23a5eb4ea3SMarcel Moolenaar  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24a5eb4ea3SMarcel Moolenaar  * SUCH DAMAGE.
25a5eb4ea3SMarcel Moolenaar  */
26a5eb4ea3SMarcel Moolenaar 
27a5eb4ea3SMarcel Moolenaar #include <sys/cdefs.h>
28a5eb4ea3SMarcel Moolenaar #include <sys/stat.h>
29aba885c9SMarcel Moolenaar #include <assert.h>
30a5eb4ea3SMarcel Moolenaar #include <errno.h>
31aba885c9SMarcel Moolenaar #include <limits.h>
32a5eb4ea3SMarcel Moolenaar #include <stdlib.h>
33a5eb4ea3SMarcel Moolenaar #include <string.h>
34a5eb4ea3SMarcel Moolenaar #include <unistd.h>
35a5eb4ea3SMarcel Moolenaar 
36f0e9dcedSMarcel Moolenaar #include "image.h"
37a5eb4ea3SMarcel Moolenaar #include "mkimg.h"
38a5eb4ea3SMarcel Moolenaar #include "scheme.h"
39a5eb4ea3SMarcel Moolenaar 
40a5eb4ea3SMarcel Moolenaar static struct {
41a5eb4ea3SMarcel Moolenaar 	const char *name;
42a5eb4ea3SMarcel Moolenaar 	enum alias alias;
43a5eb4ea3SMarcel Moolenaar } scheme_alias[] = {
44a5eb4ea3SMarcel Moolenaar 	{ "ebr", ALIAS_EBR },
45a5eb4ea3SMarcel Moolenaar 	{ "efi", ALIAS_EFI },
46a4c8dbbdSEd Maste 	{ "fat16b", ALIAS_FAT16B },
47a5eb4ea3SMarcel Moolenaar 	{ "fat32", ALIAS_FAT32 },
48*d98a4eb8SJose Luis Duran 	{ "fat32lba", ALIAS_FAT32LBA },
49a5eb4ea3SMarcel Moolenaar 	{ "freebsd", ALIAS_FREEBSD },
50a5eb4ea3SMarcel Moolenaar 	{ "freebsd-boot", ALIAS_FREEBSD_BOOT },
51a5eb4ea3SMarcel Moolenaar 	{ "freebsd-nandfs", ALIAS_FREEBSD_NANDFS },
52a5eb4ea3SMarcel Moolenaar 	{ "freebsd-swap", ALIAS_FREEBSD_SWAP },
53a5eb4ea3SMarcel Moolenaar 	{ "freebsd-ufs", ALIAS_FREEBSD_UFS },
54a5eb4ea3SMarcel Moolenaar 	{ "freebsd-vinum", ALIAS_FREEBSD_VINUM },
55a5eb4ea3SMarcel Moolenaar 	{ "freebsd-zfs", ALIAS_FREEBSD_ZFS },
56a5eb4ea3SMarcel Moolenaar 	{ "mbr", ALIAS_MBR },
578adccff3SMarcel Moolenaar 	{ "ntfs", ALIAS_NTFS },
584224509aSWarner Losh 	{ "prepboot", ALIAS_PPCBOOT },
59a5eb4ea3SMarcel Moolenaar 	{ NULL, ALIAS_NONE }		/* Keep last! */
60a5eb4ea3SMarcel Moolenaar };
61a5eb4ea3SMarcel Moolenaar 
625a1302abSMarcel Moolenaar static struct mkimg_scheme *first;
63a5eb4ea3SMarcel Moolenaar static struct mkimg_scheme *scheme;
64a5eb4ea3SMarcel Moolenaar static void *bootcode;
65a5eb4ea3SMarcel Moolenaar 
66a5eb4ea3SMarcel Moolenaar static enum alias
scheme_parse_alias(const char * name)67a5eb4ea3SMarcel Moolenaar scheme_parse_alias(const char *name)
68a5eb4ea3SMarcel Moolenaar {
69a5eb4ea3SMarcel Moolenaar 	u_int idx;
70a5eb4ea3SMarcel Moolenaar 
71a5eb4ea3SMarcel Moolenaar 	idx = 0;
72a5eb4ea3SMarcel Moolenaar 	while (scheme_alias[idx].name != NULL) {
73a5eb4ea3SMarcel Moolenaar 		if (strcasecmp(scheme_alias[idx].name, name) == 0)
74a5eb4ea3SMarcel Moolenaar 			return (scheme_alias[idx].alias);
75a5eb4ea3SMarcel Moolenaar 		idx++;
76a5eb4ea3SMarcel Moolenaar 	}
77a5eb4ea3SMarcel Moolenaar 	return (ALIAS_NONE);
78a5eb4ea3SMarcel Moolenaar }
79a5eb4ea3SMarcel Moolenaar 
805a1302abSMarcel Moolenaar struct mkimg_scheme *
scheme_iterate(struct mkimg_scheme * s)815a1302abSMarcel Moolenaar scheme_iterate(struct mkimg_scheme *s)
825a1302abSMarcel Moolenaar {
835a1302abSMarcel Moolenaar 
845a1302abSMarcel Moolenaar 	return ((s == NULL) ? first : s->next);
855a1302abSMarcel Moolenaar }
865a1302abSMarcel Moolenaar 
875a1302abSMarcel Moolenaar void
scheme_register(struct mkimg_scheme * s)885a1302abSMarcel Moolenaar scheme_register(struct mkimg_scheme *s)
895a1302abSMarcel Moolenaar {
905a1302abSMarcel Moolenaar 	s->next = first;
915a1302abSMarcel Moolenaar 	first = s;
925a1302abSMarcel Moolenaar }
935a1302abSMarcel Moolenaar 
94a5eb4ea3SMarcel Moolenaar int
scheme_select(const char * spec)95a5eb4ea3SMarcel Moolenaar scheme_select(const char *spec)
96a5eb4ea3SMarcel Moolenaar {
975a1302abSMarcel Moolenaar 	struct mkimg_scheme *s;
98a5eb4ea3SMarcel Moolenaar 
995a1302abSMarcel Moolenaar 	s = NULL;
1005a1302abSMarcel Moolenaar 	while ((s = scheme_iterate(s)) != NULL) {
101a5eb4ea3SMarcel Moolenaar 		if (strcasecmp(spec, s->name) == 0) {
102a5eb4ea3SMarcel Moolenaar 			scheme = s;
103a5eb4ea3SMarcel Moolenaar 			return (0);
104a5eb4ea3SMarcel Moolenaar 		}
105a5eb4ea3SMarcel Moolenaar 	}
106a5eb4ea3SMarcel Moolenaar 	return (EINVAL);
107a5eb4ea3SMarcel Moolenaar }
108a5eb4ea3SMarcel Moolenaar 
109a5eb4ea3SMarcel Moolenaar struct mkimg_scheme *
scheme_selected(void)110a5eb4ea3SMarcel Moolenaar scheme_selected(void)
111a5eb4ea3SMarcel Moolenaar {
112a5eb4ea3SMarcel Moolenaar 
113a5eb4ea3SMarcel Moolenaar 	return (scheme);
114a5eb4ea3SMarcel Moolenaar }
115a5eb4ea3SMarcel Moolenaar 
116a5eb4ea3SMarcel Moolenaar int
scheme_bootcode(int fd)117a5eb4ea3SMarcel Moolenaar scheme_bootcode(int fd)
118a5eb4ea3SMarcel Moolenaar {
119a5eb4ea3SMarcel Moolenaar 	struct stat sb;
120a5eb4ea3SMarcel Moolenaar 
121aba885c9SMarcel Moolenaar 	if (scheme == NULL || scheme->bootcode == 0)
122a5eb4ea3SMarcel Moolenaar 		return (ENXIO);
123a5eb4ea3SMarcel Moolenaar 
124a5138187SMarcel Moolenaar 	if (fstat(fd, &sb) == -1)
125a5138187SMarcel Moolenaar 		return (errno);
126a5eb4ea3SMarcel Moolenaar 	if (sb.st_size > scheme->bootcode)
127a5eb4ea3SMarcel Moolenaar 		return (EFBIG);
128a5eb4ea3SMarcel Moolenaar 
129a5eb4ea3SMarcel Moolenaar 	bootcode = malloc(scheme->bootcode);
130a5eb4ea3SMarcel Moolenaar 	if (bootcode == NULL)
131a5eb4ea3SMarcel Moolenaar 		return (ENOMEM);
132a5eb4ea3SMarcel Moolenaar 	memset(bootcode, 0, scheme->bootcode);
133a5eb4ea3SMarcel Moolenaar 	if (read(fd, bootcode, sb.st_size) != sb.st_size) {
134a5eb4ea3SMarcel Moolenaar 		free(bootcode);
135a5eb4ea3SMarcel Moolenaar 		bootcode = NULL;
136a5eb4ea3SMarcel Moolenaar 		return (errno);
137a5eb4ea3SMarcel Moolenaar 	}
138a5eb4ea3SMarcel Moolenaar 	return (0);
139a5eb4ea3SMarcel Moolenaar }
140a5eb4ea3SMarcel Moolenaar 
141a5eb4ea3SMarcel Moolenaar int
scheme_check_part(struct part * p)142a5eb4ea3SMarcel Moolenaar scheme_check_part(struct part *p)
143a5eb4ea3SMarcel Moolenaar {
144a5eb4ea3SMarcel Moolenaar 	struct mkimg_alias *iter;
145a5eb4ea3SMarcel Moolenaar 	enum alias alias;
146a5eb4ea3SMarcel Moolenaar 
147aba885c9SMarcel Moolenaar 	assert(scheme != NULL);
148aba885c9SMarcel Moolenaar 
149a5eb4ea3SMarcel Moolenaar 	/* Check the partition type alias */
150a5eb4ea3SMarcel Moolenaar 	alias = scheme_parse_alias(p->alias);
151a5eb4ea3SMarcel Moolenaar 	if (alias == ALIAS_NONE)
152a5eb4ea3SMarcel Moolenaar 		return (EINVAL);
153a5eb4ea3SMarcel Moolenaar 
154a5eb4ea3SMarcel Moolenaar 	iter = scheme->aliases;
155a5eb4ea3SMarcel Moolenaar 	while (iter->alias != ALIAS_NONE) {
156a5eb4ea3SMarcel Moolenaar 		if (alias == iter->alias)
157a5eb4ea3SMarcel Moolenaar 			break;
158a5eb4ea3SMarcel Moolenaar 		iter++;
159a5eb4ea3SMarcel Moolenaar 	}
160a5eb4ea3SMarcel Moolenaar 	if (iter->alias == ALIAS_NONE)
161a5eb4ea3SMarcel Moolenaar 		return (EINVAL);
162a5eb4ea3SMarcel Moolenaar 	p->type = iter->type;
163a5eb4ea3SMarcel Moolenaar 
164a5eb4ea3SMarcel Moolenaar 	/* Validate the optional label. */
165a5eb4ea3SMarcel Moolenaar 	if (p->label != NULL) {
166a5eb4ea3SMarcel Moolenaar 		if (strlen(p->label) > scheme->labellen)
167a5eb4ea3SMarcel Moolenaar 			return (EINVAL);
168a5eb4ea3SMarcel Moolenaar 	}
169a5eb4ea3SMarcel Moolenaar 
170a5eb4ea3SMarcel Moolenaar 	return (0);
171a5eb4ea3SMarcel Moolenaar }
172a5eb4ea3SMarcel Moolenaar 
173a5eb4ea3SMarcel Moolenaar u_int
scheme_max_parts(void)174a5eb4ea3SMarcel Moolenaar scheme_max_parts(void)
175a5eb4ea3SMarcel Moolenaar {
176a5eb4ea3SMarcel Moolenaar 
177aba885c9SMarcel Moolenaar 	return ((scheme == NULL) ? 0 : scheme->nparts);
178a5eb4ea3SMarcel Moolenaar }
179a5eb4ea3SMarcel Moolenaar 
180a5eb4ea3SMarcel Moolenaar u_int
scheme_max_secsz(void)181a5eb4ea3SMarcel Moolenaar scheme_max_secsz(void)
182a5eb4ea3SMarcel Moolenaar {
183a5eb4ea3SMarcel Moolenaar 
184aba885c9SMarcel Moolenaar 	return ((scheme == NULL) ? INT_MAX+1U : scheme->maxsecsz);
185a5eb4ea3SMarcel Moolenaar }
186a5eb4ea3SMarcel Moolenaar 
187a5eb4ea3SMarcel Moolenaar lba_t
scheme_metadata(u_int where,lba_t start)188a5eb4ea3SMarcel Moolenaar scheme_metadata(u_int where, lba_t start)
189a5eb4ea3SMarcel Moolenaar {
190a5eb4ea3SMarcel Moolenaar 
191aba885c9SMarcel Moolenaar 	return ((scheme == NULL) ? start : scheme->metadata(where, start));
192a5eb4ea3SMarcel Moolenaar }
193a5eb4ea3SMarcel Moolenaar 
194a5eb4ea3SMarcel Moolenaar int
scheme_write(lba_t end)195f0e9dcedSMarcel Moolenaar scheme_write(lba_t end)
196a5eb4ea3SMarcel Moolenaar {
197a5eb4ea3SMarcel Moolenaar 
198aba885c9SMarcel Moolenaar 	return ((scheme == NULL) ? 0 : scheme->write(end, bootcode));
199a5eb4ea3SMarcel Moolenaar }
200