aboutsummaryrefslogtreecommitdiff
path: root/ubi-utils/src/ubimkvol.c
blob: 04b7fb5f58d337c5b5faed1cfa42fbbf31c43932 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/*
 * Copyright (c) International Business Machines Corp., 2006
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
 * the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * An utility to create UBI volumes.
 *
 * Author: Artem B. Bityutskiy <dedekind@linutronix.de>
 *         Frank Haverkamp <haver@vnet.ibm.com>
 *
 * 1.0 Initial release
 * 1.1 Does not support erase blocks anymore. This is replaced by
 *     the number of bytes.
 * 1.2 Reworked the user-interface to use argp.
 */

#include <argp.h>
#include <stdio.h>
#include <stdint.h>
#include <getopt.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>

#include <config.h>
#include <libubi.h>

#define PROGRAM_VERSION "1.2"

/*
 * The variables below	are set by command line arguments.
 */
struct args {
	int devn;
	int vol_id;
	int vol_type;
	long long bytes;
	int alignment;
	char *name;
	int nlen;

	/* special stuff needed to get additional arguments */
	char *arg1;
	char **options;		/* [STRING...] */
};

static struct args myargs = {
	.vol_type = UBI_DYNAMIC_VOLUME,
	.devn = -1,
	.bytes = 0,
	.alignment = 1,
	.vol_id = UBI_VOL_NUM_AUTO,
	.name = NULL,
	.nlen = 0,
};

static int param_sanity_check(struct args *args, ubi_lib_t lib);
static error_t parse_opt(int key, char *optarg, struct argp_state *state);

const char *argp_program_version = PROGRAM_VERSION;
const char *argp_program_bug_address = PACKAGE_BUGREPORT;

static char doc[] = "\nVersion: " PROGRAM_VERSION "\n\t"
	BUILD_OS" "BUILD_CPU" at "__DATE__" "__TIME__"\n"
	"\nMake UBI Volume.\n";

static struct argp_option options[] = {
	{ .name = "devn",
	  .key = 'd',
	  .arg = "<devn>",
	  .flags = 0,
	  .doc = "UBI device",
	  .group = OPTION_ARG_OPTIONAL },

	{ .name = "vol_id",
	  .key = 'n',
	  .arg = "<volume id>",
	  .flags = 0,
	  .doc = "UBI volume id, if not specified, the volume ID will be "
		 "assigned automatically",
	  .group = OPTION_ARG_OPTIONAL },

	{ .name = "type",
	  .key = 't',
	  .arg = "<static|dynamic>",
	  .flags = 0,
	  .doc = "volume type (dynamic, static), default is dynamic",
	  .group = OPTION_ARG_OPTIONAL },

	{ .name = "size",
	  .key = 's',
	  .arg = "<bytes>",
	  .flags = 0,
	  .doc = "volume size volume size in bytes, "
	  "kilobytes (KiB) or megabytes (MiB)",
	  .group = OPTION_ARG_OPTIONAL },

	{ .name = "name",
	  .key = 'N',
	  .arg = "<name>",
	  .flags = 0,
	  .doc = "volume name",
	  .group = OPTION_ARG_OPTIONAL },

	{ .name = "alignment",
	  .key = 'a',
	  .arg = "<alignment>",
	  .flags = 0,
	  .doc = "volume alignment (default is 1)",
	  .group = OPTION_ARG_OPTIONAL },

	{ .name = NULL, .key = 0, .arg = NULL, .flags = 0,
	  .doc = NULL, .group = 0 },
};

static struct argp argp = {
	.options = options,
	.parser = parse_opt,
	.args_doc = 0,
	.doc =	doc,
	.children = NULL,
	.help_filter = NULL,
	.argp_domain = NULL,
};

/*
 * @brief Parse the arguments passed into the test case.
 *
 * @param key		 The parameter.
 * @param arg		 Argument passed to parameter.
 * @param state		 Location to put information on parameters.
 *
 * @return error
 *
 * Get the `input' argument from `argp_parse', which we know is a
 * pointer to our arguments structure.
 */
static error_t
parse_opt(int key, char *optarg, struct argp_state *state)
{
	char *endp;
	struct args *args = state->input;

	switch (key) {
	case 't':
		if (!strcmp(optarg, "dynamic"))
			args->vol_type = UBI_DYNAMIC_VOLUME;
		else if (!strcmp(optarg, "static"))
			args->vol_type = UBI_STATIC_VOLUME;
		else {
			fprintf(stderr, "Bad volume type: \"%s\"\n",
				optarg);
			goto out;
		}
		break;
	case 's':
		args->bytes = strtoull(optarg, &endp, 0);
		if (endp == optarg || args->bytes < 0) {
			fprintf(stderr, "Bad volume size: \"%s\"\n",
				optarg);
			goto out;
		}
		if (endp != '\0') {
			if (strcmp(endp, "KiB") == 0)
				args->bytes *= 1024;
			else if (strcmp(endp, "MiB") == 0)
				args->bytes *= 1024*1024;
		}
		break;
	case 'a':
		args->alignment = strtoul(optarg, &endp, 0);
		if (*endp != '\0' || endp == optarg ||
		    args->alignment <= 0) {
			fprintf(stderr, "Bad volume alignment: "
				"\"%s\"\n", optarg);
			goto out;
		}
		break;
	case 'd': /* --devn=<device number> */
		args->devn = strtoul(optarg, &endp, 0);
		if (*endp != '\0' || endp == optarg || args->devn < 0) {
			fprintf(stderr, "Bad UBI device number: "
				"\"%s\"\n", optarg);
			goto out;
		}
		break;
	case 'n': /* --volid=<volume id> */
		args->vol_id = strtoul(optarg, &endp, 0);
		if (*endp != '\0' || endp == optarg ||
		    (args->vol_id < 0 && args->vol_id != UBI_DYNAMIC_VOLUME)) {
			fprintf(stderr, "Bad volume ID: "
				"\"%s\"\n", optarg);
			goto out;
		}
		break;
	case 'N':
		args->name = optarg;
		args->nlen = strlen(args->name);
		break;

	case ':':
		fprintf(stderr, "Parameter is missing\n");
		goto out;

	case ARGP_KEY_NO_ARGS:
		/* argp_usage(state); */
		break;

	case ARGP_KEY_ARG:
		args->arg1 = optarg;
		/* Now we consume all the rest of the arguments.
		   `state->next' is the index in `state->argv' of the
		   next argument to be parsed, which is the first STRING
		   we're interested in, so we can just use
		   `&state->argv[state->next]' as the value for
		   arguments->strings.

		   _In addition_, by setting `state->next' to the end
		   of the arguments, we can force argp to stop parsing
		   here and return. */

		args->options = &state->argv[state->next];
		state->next = state->argc;
		break;

	case ARGP_KEY_END:
		/* argp_usage(state); */
		break;

	default:
		return(ARGP_ERR_UNKNOWN);
	}

	return 0;
 out:
	return(ARGP_ERR_UNKNOWN);
}

static int param_sanity_check(struct args *args, ubi_lib_t lib)
{
	int err, len;
	struct ubi_info ubi;

	if (args->bytes == 0) {
		fprintf(stderr, "Volume size was not specified\n");
		goto out;
	}

	if (args->name == NULL) {
		fprintf(stderr, "Volume name was not specified\n");
		goto out;
	}

	err = ubi_get_info(lib, &ubi);
	if (err)
		return -1;

	if (args->devn >= (int)ubi.dev_count) {
		fprintf(stderr, "Device %d does not exist\n", args->devn);
		goto out;
	}

	len = strlen(args->name);
	if (len > UBI_MAX_VOLUME_NAME) {
		fprintf(stderr, "Too long name (%d symbols), max is %d\n",
			len, UBI_MAX_VOLUME_NAME);
		goto out;
	}

	return 0;
out:
	errno = EINVAL;
	return -1;
}

int main(int argc, char * const argv[])
{
	int err;
	ubi_lib_t lib;

	err = argp_parse(&argp, argc, (char **)argv, ARGP_IN_ORDER, 0,
			 &myargs);
	if (err) {
		fprintf(stderr, "Wrong options ...\n");
		return err == 1 ? 0 : -1;
	}

	if (myargs.devn == -1) {
		fprintf(stderr, "Device number was not specified\n");
		fprintf(stderr, "Use -h option for help\n");
		return -1;
	}

	err = ubi_open(&lib);
	if (err) {
		perror("Cannot open libubi");
		return -1;
	}

	err = param_sanity_check(&myargs, lib);
	if (err) {
		perror("Input parameters check");
		fprintf(stderr, "Use -h option for help\n");
		goto out_libubi;
	}

	err = ubi_mkvol(lib, myargs.devn, myargs.vol_id, myargs.vol_type,
			myargs.bytes, myargs.alignment, myargs.name);
	if (err < 0) {
		perror("Cannot create volume");
		fprintf(stderr, "  err=%d\n", err);
		goto out_libubi;
	}

	/* printf("Created volume %d, %lld bytes, type %s, name %s\n",
	   vol_id, bytes, vol_type == UBI_DYNAMIC_VOLUME ?
	   "dynamic" : "static", name); */

	myargs.vol_id = err;
	ubi_close(&lib);
	return 0;

out_libubi:
	ubi_close(&lib);
	return -1;
}