summaryrefslogtreecommitdiffstats
path: root/discover/grub2/script.c
blob: f52168157cfb03aa3e3eb49e5ff3fd00039e66f2 (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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520

#include <sys/types.h>
#include <string.h>
#include <stdlib.h>

#include <log/log.h>
#include <types/types.h>
#include <talloc/talloc.h>

#include "grub2.h"

#define to_stmt_simple(stmt) \
	container_of(stmt, struct grub2_statement_simple, st)
#define to_stmt_block(stmt) \
	container_of(stmt, struct grub2_statement_block, st)
#define to_stmt_if(stmt) \
	container_of(stmt, struct grub2_statement_if, st)
#define to_stmt_menuentry(stmt) \
	container_of(stmt, struct grub2_statement_menuentry, st)
#define to_stmt_function(stmt) \
	container_of(stmt, struct grub2_statement_function, st)
#define to_stmt_for(stmt) \
	container_of(stmt, struct grub2_statement_for, st)
#define to_stmt_conditional(stmt) \
	container_of(stmt, struct grub2_statement_conditional, st)

struct env_entry {
	char			*name;
	char			*value;
	struct list_item	list;
};

struct grub2_symtab_entry {
	const char		*name;
	grub2_function		fn;
	void			*data;
	struct list_item	list;
};

static const char *default_prefix = "/boot/grub";

static struct grub2_symtab_entry *script_lookup_function(
		struct grub2_script *script, const char *name)
{
	struct grub2_symtab_entry *entry;

	list_for_each_entry(&script->symtab, entry, list) {
		if (!strcmp(entry->name, name))
			return entry;
	}

	return NULL;
}

const char *script_env_get(struct grub2_script *script, const char *name)
{
	struct env_entry *entry;

	list_for_each_entry(&script->environment, entry, list)
		if (!strcmp(entry->name, name))
			return entry->value;

	return NULL;
}

void script_env_set(struct grub2_script *script,
		const char *name, const char *value)
{
	struct env_entry *e, *entry = NULL;

	list_for_each_entry(&script->environment, e, list) {
		if (!strcmp(e->name, name)) {
			entry = e;
			break;
		}
	}

	if (!entry) {
		entry = talloc(script, struct env_entry);
		entry->name = talloc_strdup(entry, name);
		list_add(&script->environment, &entry->list);
	} else {
		talloc_free(entry->value);
	}

	entry->value = talloc_strdup(entry, value);
}

static char *expand_var(struct grub2_script *script, struct grub2_word *word)
{
	const char *val;

	val = script_env_get(script, word->name);
	if (!val)
		val = "";

	return talloc_strdup(script, val);
}

static bool is_delim(char c)
{
	return c == ' ' || c == '\t';
}

static bool option_is_default(struct grub2_script *script,
		struct discover_boot_option *opt, const char *id)
{
	unsigned int default_idx;
	const char *var;
	char *end;

	var = script_env_get(script, "default");
	if (!var)
		return false;

	default_idx = strtoul(var, &end, 10);
	if (end != var && *end == '\0')
		return default_idx == script->n_options;

	/* if we don't have an explicit id for this option, fall back to
	 * the name */
	if (!id)
		id = opt->option->name;

	return !strcmp(id, var);
}

static void append_text_to_current_arg(struct grub2_argv *argv,
		const char *text, int len)
{
	char *cur = argv->argv[argv->argc - 1];

	if (cur) {
		int curlen = strlen(cur);
		cur = talloc_realloc(argv->argv, cur, char, len + curlen + 1);
		memcpy(cur + curlen, text, len);
		cur[len + curlen] = '\0';

	} else {
		cur = talloc_strndup(argv->argv, text, len);
	}

	argv->argv[argv->argc-1] = cur;
}

/* Add a word to the argv array. Depending on the word type, and presence of
 * delimiter characters, we may add multiple items to the array.
 */
static void append_word_to_argv(struct grub2_script *script,
		struct grub2_argv *argv, struct grub2_word *word)
{
	const char *text, *pos;
	int i, len;

	/* If it's a variable, perform substitution */
	if (word->type == GRUB2_WORD_VAR)
		text = expand_var(script, word);
	else
		text = word->text;

	len = strlen(text);

	/* If we have no text, we leave the current word as-is. The caller
	 * has allocated an empty string for the case where this is the
	 * first text token */
	if (!len)
		return;

	/* If we're not splitting, we just add the entire block to the
	 * current argv item */
	if (!word->split) {
		append_text_to_current_arg(argv, text, len);
		return;
	}

	/* Scan for delimiters. If we find a word-end boundary, add the word
	 * to the argv array, and start a new argv item */
	pos = !is_delim(text[0]) ? text : NULL;
	for (i = 0; i < len; i++) {

		/* first delimiter after a word: add the accumulated word to
		 * argv */
		if (pos && is_delim(text[i])) {
			append_text_to_current_arg(argv, pos,
					text + i - pos);
			pos = NULL;

		/* first non-delimeter after a delimiter: record the starting
		 * position, and create another argv item */
		} else if (!pos && !is_delim(text[i])) {
			pos = text + i;
			argv->argc++;
			argv->argv = talloc_realloc(argv, argv->argv, char *,
					argv->argc);
			argv->argv[argv->argc - 1] = NULL;
		}
	}

	/* add remaining word characters */
	if (pos)
		append_text_to_current_arg(argv, pos, text + len - pos);
}

/* Transform an argv word-token list (returned from the parser) into an
 * expanded argv array (as used by the script execution code). We do this by
 * iterating through the words in an argv_list, looking for GRUB2_WORD_VAR
 * expansions.
 */
static void process_expansions(struct grub2_script *script,
		struct grub2_argv *argv)
{
	struct grub2_word *top_word, *word;

	argv->argc = 0;
	argv->argv = NULL;

	list_for_each_entry(&argv->words, top_word, argv_list) {
		argv->argc++;
		argv->argv = talloc_realloc(argv, argv->argv, char *,
				argv->argc);
		/* because we've parsed a separate word here, we know that
		 * we need at least an empty string */
		argv->argv[argv->argc - 1] = talloc_strdup(argv->argv, "");

		for (word = top_word; word; word = word->next)
			append_word_to_argv(script, argv, word);
	}

	/* we may have allocated an extra argv element but not populated it */
	if (!argv->argv[argv->argc - 1])
		argv->argc--;
}

static int statements_execute(struct grub2_script *script,
		struct grub2_statements *stmts)
{
	struct grub2_statement *stmt;
	int rc = 0;

	list_for_each_entry(&stmts->list, stmt, list) {
		if (stmt->exec)
			rc = stmt->exec(script, stmt);
	}
	return rc;
}

int statement_simple_execute(struct grub2_script *script,
		struct grub2_statement *statement)
{
	struct grub2_statement_simple *st = to_stmt_simple(statement);
	struct grub2_symtab_entry *entry;
	char *pos;
	int rc;

	if (!st->argv)
		return 0;

	process_expansions(script, st->argv);

	if (!st->argv->argc)
		return 0;

	/* is this a var=value assignment? */
	pos = strchr(st->argv->argv[0], '=');
	if (pos) {
		char *name, *value;
		name = st->argv->argv[0];
		name = talloc_strndup(st, name, pos - name);
		value = pos + 1;
		script_env_set(script, name, value);
		return 0;
	}

	entry = script_lookup_function(script, st->argv->argv[0]);
	if (!entry) {
		pb_log("grub2: undefined function '%s'\n", st->argv->argv[0]);
		return 1;
	}

	rc = entry->fn(script, entry->data, st->argv->argc, st->argv->argv);

	return rc;
}

int statement_block_execute(struct grub2_script *script,
		struct grub2_statement *statement)
{
	struct grub2_statement_block *st = to_stmt_block(statement);
	return statements_execute(script, st->statements);
}

/* returns 0 if the statement was executed, 1 otherwise */
static int statement_conditional_execute(struct grub2_script *script,
		struct grub2_statement *statement, bool *executed)
{
	struct grub2_statement_conditional *st = to_stmt_conditional(statement);
	int rc;

	rc = st->condition->exec(script, st->condition);
	*executed = (!rc);
	if (*executed)
		rc = statements_execute(script, st->statements);

	return rc;
}

int statement_if_execute(struct grub2_script *script,
		struct grub2_statement *statement)
{
	struct grub2_statement_if *st = to_stmt_if(statement);
	struct grub2_statement *conditional;
	bool executed = false;
	int rc = 0;

	list_for_each_entry(&st->conditionals->list, conditional, list) {
		rc = statement_conditional_execute(script,
				conditional, &executed);
		if (executed)
			break;
	}

	if (!executed && st->else_case)
		rc = statements_execute(script, st->else_case);

	return rc;
}

int statement_menuentry_execute(struct grub2_script *script,
		struct grub2_statement *statement)
{
	struct grub2_statement_menuentry *st = to_stmt_menuentry(statement);
	struct discover_boot_option *opt;
	const char *id = NULL;
	int i;

	process_expansions(script, st->argv);

	opt = discover_boot_option_create(script->ctx, script->ctx->device);

	/* XXX: --options=values need to be parsed properly; this is a simple
	 * implementation to get --id= working.
	 */
	for (i = 1; i < st->argv->argc; ++i) {
		if (strncmp("--id=", st->argv->argv[i], 5) == 0) {
			id = st->argv->argv[i] + 5;
			break;
		}
	}
	if (st->argv->argc > 0)
		opt->option->name = talloc_strdup(opt, st->argv->argv[0]);
	else
		opt->option->name = talloc_strdup(opt, "(unknown)");

	opt->option->id = talloc_asprintf(opt->option, "%s#%s",
			script->ctx->device->device->id,
			id ? id : opt->option->name);

	script->opt = opt;

	statements_execute(script, st->statements);

	if (!opt->boot_image)
		return -1;

	opt->option->is_default = option_is_default(script, opt, id);

	list_add_tail(&script->options, &opt->list);
	script->n_options++;
	script->opt = NULL;

	return 0;
}

static int function_invoke(struct grub2_script *script,
		void *data, int argc, char **argv)
{
	struct grub2_statement_function *fn = data;
	char *name;
	int i;

	/* set positional parameters */
	for (i = 0; i < argc; i++) {
		name = talloc_asprintf(script, "$%d", i);
		script_env_set(script, name, argv[i]);
	}

	return statements_execute(script, fn->body);
}

int statement_function_execute(struct grub2_script *script,
		struct grub2_statement *statement)
{
	struct grub2_statement_function *st = to_stmt_function(statement);
	const char *name;

	if (st->name->type == GRUB2_WORD_VAR)
		name = expand_var(script, st->name);
	else
		name = st->name->text;

	script_register_function(script, name, function_invoke, st);

	return 0;
}

int statement_for_execute(struct grub2_script *script,
		struct grub2_statement *statement)
{
	struct grub2_statement_for *st = to_stmt_for(statement);
	const char *varname;
	int i, rc = 0;

	if (st->var->type == GRUB2_WORD_VAR)
		expand_var(script, st->var);
	varname = st->var->text;

	process_expansions(script, st->list);

	for (i = 0; i < st->list->argc; ++i) {
		script_env_set(script, varname, st->list->argv[i]);
		rc = statements_execute(script, st->body);
	}

	return rc;
}

static void init_env(struct grub2_script *script)
{
	struct env_entry *env;
	char *prefix, *sep;

	list_init(&script->environment);

	/* use location of the parsed config file to determine the prefix */
	env = talloc(script, struct env_entry);

	prefix = NULL;
	if (script->filename) {
		sep = strrchr(script->filename, '/');
		if (sep)
			prefix = talloc_strndup(env, script->filename,
					sep - script->filename);
	}

	script_env_set(script, "prefix", prefix ? : default_prefix);
	if (prefix)
		talloc_free(prefix);

	/* establish feature settings */
	script_env_set(script, "feature_menuentry_id", "y");
}

void script_register_function(struct grub2_script *script,
		const char *name, grub2_function fn,
		void *data)
{
	struct grub2_symtab_entry *entry;

	entry = talloc(script, struct grub2_symtab_entry);
	entry->fn = fn;
	entry->name = name;
	entry->data = data;
	list_add(&script->symtab, &entry->list);
}

static void set_fallback_default(struct grub2_script *script)
{
	struct discover_boot_option *opt, *first = NULL;
	bool have_default = false;

	list_for_each_entry(&script->options, opt, list) {
		if (!first)
			first = opt;
		have_default = have_default || opt->option->is_default;
	}

	if (!have_default && first) {
		const char *env = script_env_get(script, "default");

		pb_log("grub: no explicit default (env default=%s), "
				"falling back to first option (%s)\n",
				env ?: "unset", first->option->name);

		first->option->is_default = true;
	}
}

void script_execute(struct grub2_script *script)
{
	struct discover_boot_option *opt, *tmp;

	init_env(script);
	statements_execute(script, script->statements);

	set_fallback_default(script);

	list_for_each_entry_safe(&script->options, opt, tmp, list)
		discover_context_add_boot_option(script->ctx, opt);

	/* Our option list will be invalid, as we've added all options to the
	 * discover context */
	list_init(&script->options);
}

struct grub2_script *create_script(struct grub2_parser *parser,
		struct discover_context *ctx)
{
	struct grub2_script *script;

	script = talloc_zero(parser, struct grub2_script);

	script->ctx = ctx;

	list_init(&script->symtab);
	list_init(&script->options);
	register_builtins(script);

	return script;
}

OpenPOWER on IntegriCloud