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