Commit | Line | Data |
---|---|---|
104daea1 MY |
1 | // SPDX-License-Identifier: GPL-2.0 |
2 | // | |
3 | // Copyright (C) 2018 Masahiro Yamada <yamada.masahiro@socionext.com> | |
4 | ||
558e78e3 | 5 | #include <ctype.h> |
104daea1 MY |
6 | #include <stdarg.h> |
7 | #include <stdbool.h> | |
8 | #include <stdio.h> | |
9 | #include <stdlib.h> | |
10 | #include <string.h> | |
11 | ||
fbaf242c MY |
12 | #include <array_size.h> |
13 | #include <list.h> | |
a9d83d74 | 14 | #include <xalloc.h> |
4ff7ceae | 15 | #include "internal.h" |
558e78e3 | 16 | #include "lkc.h" |
d3d16228 | 17 | #include "preprocess.h" |
104daea1 | 18 | |
e298f3b4 | 19 | static char *expand_string_with_args(const char *in, int argc, char *argv[]); |
5533397d | 20 | static char *expand_string(const char *in); |
e298f3b4 | 21 | |
104daea1 MY |
22 | static void __attribute__((noreturn)) pperror(const char *format, ...) |
23 | { | |
24 | va_list ap; | |
25 | ||
4ff7ceae | 26 | fprintf(stderr, "%s:%d: ", cur_filename, yylineno); |
104daea1 MY |
27 | va_start(ap, format); |
28 | vfprintf(stderr, format, ap); | |
29 | va_end(ap); | |
30 | fprintf(stderr, "\n"); | |
31 | ||
32 | exit(1); | |
33 | } | |
34 | ||
35 | /* | |
36 | * Environment variables | |
37 | */ | |
38 | static LIST_HEAD(env_list); | |
39 | ||
40 | struct env { | |
41 | char *name; | |
42 | char *value; | |
43 | struct list_head node; | |
44 | }; | |
45 | ||
46 | static void env_add(const char *name, const char *value) | |
47 | { | |
48 | struct env *e; | |
49 | ||
50 | e = xmalloc(sizeof(*e)); | |
51 | e->name = xstrdup(name); | |
52 | e->value = xstrdup(value); | |
53 | ||
54 | list_add_tail(&e->node, &env_list); | |
55 | } | |
56 | ||
57 | static void env_del(struct env *e) | |
58 | { | |
59 | list_del(&e->node); | |
60 | free(e->name); | |
61 | free(e->value); | |
62 | free(e); | |
63 | } | |
64 | ||
65 | /* The returned pointer must be freed when done */ | |
66 | static char *env_expand(const char *name) | |
67 | { | |
68 | struct env *e; | |
69 | const char *value; | |
70 | ||
71 | if (!*name) | |
72 | return NULL; | |
73 | ||
74 | list_for_each_entry(e, &env_list, node) { | |
75 | if (!strcmp(name, e->name)) | |
76 | return xstrdup(e->value); | |
77 | } | |
78 | ||
79 | value = getenv(name); | |
80 | if (!value) | |
81 | return NULL; | |
82 | ||
83 | /* | |
84 | * We need to remember all referenced environment variables. | |
85 | * They will be written out to include/config/auto.conf.cmd | |
86 | */ | |
87 | env_add(name, value); | |
88 | ||
89 | return xstrdup(value); | |
90 | } | |
91 | ||
56e634b0 | 92 | void env_write_dep(struct gstr *s) |
104daea1 MY |
93 | { |
94 | struct env *e, *tmp; | |
95 | ||
96 | list_for_each_entry_safe(e, tmp, &env_list, node) { | |
56e634b0 MY |
97 | str_printf(s, |
98 | "\n" | |
99 | "ifneq \"$(%s)\" \"%s\"\n" | |
100 | "$(autoconfig): FORCE\n" | |
101 | "endif\n", | |
102 | e->name, e->value); | |
104daea1 MY |
103 | env_del(e); |
104 | } | |
105 | } | |
106 | ||
e298f3b4 MY |
107 | /* |
108 | * Built-in functions | |
109 | */ | |
110 | struct function { | |
111 | const char *name; | |
112 | unsigned int min_args; | |
113 | unsigned int max_args; | |
114 | char *(*func)(int argc, char *argv[]); | |
115 | }; | |
116 | ||
1d6272e6 MY |
117 | static char *do_error_if(int argc, char *argv[]) |
118 | { | |
119 | if (!strcmp(argv[0], "y")) | |
120 | pperror("%s", argv[1]); | |
121 | ||
135b4957 | 122 | return xstrdup(""); |
1d6272e6 MY |
123 | } |
124 | ||
a702a617 MY |
125 | static char *do_filename(int argc, char *argv[]) |
126 | { | |
4ff7ceae | 127 | return xstrdup(cur_filename); |
a702a617 MY |
128 | } |
129 | ||
1d6272e6 MY |
130 | static char *do_info(int argc, char *argv[]) |
131 | { | |
132 | printf("%s\n", argv[0]); | |
133 | ||
134 | return xstrdup(""); | |
135 | } | |
136 | ||
a702a617 MY |
137 | static char *do_lineno(int argc, char *argv[]) |
138 | { | |
139 | char buf[16]; | |
140 | ||
141 | sprintf(buf, "%d", yylineno); | |
142 | ||
143 | return xstrdup(buf); | |
144 | } | |
145 | ||
2fd5b09c MY |
146 | static char *do_shell(int argc, char *argv[]) |
147 | { | |
148 | FILE *p; | |
8a4c5b2a | 149 | char buf[4096]; |
2fd5b09c MY |
150 | char *cmd; |
151 | size_t nread; | |
152 | int i; | |
153 | ||
154 | cmd = argv[0]; | |
155 | ||
156 | p = popen(cmd, "r"); | |
157 | if (!p) { | |
158 | perror(cmd); | |
159 | exit(1); | |
160 | } | |
161 | ||
162 | nread = fread(buf, 1, sizeof(buf), p); | |
163 | if (nread == sizeof(buf)) | |
164 | nread--; | |
165 | ||
166 | /* remove trailing new lines */ | |
73d1c580 | 167 | while (nread > 0 && buf[nread - 1] == '\n') |
2fd5b09c MY |
168 | nread--; |
169 | ||
170 | buf[nread] = 0; | |
171 | ||
172 | /* replace a new line with a space */ | |
173 | for (i = 0; i < nread; i++) { | |
174 | if (buf[i] == '\n') | |
175 | buf[i] = ' '; | |
176 | } | |
177 | ||
178 | if (pclose(p) == -1) { | |
179 | perror(cmd); | |
180 | exit(1); | |
181 | } | |
182 | ||
183 | return xstrdup(buf); | |
184 | } | |
185 | ||
1d6272e6 MY |
186 | static char *do_warning_if(int argc, char *argv[]) |
187 | { | |
188 | if (!strcmp(argv[0], "y")) | |
4ff7ceae | 189 | fprintf(stderr, "%s:%d: %s\n", cur_filename, yylineno, argv[1]); |
1d6272e6 MY |
190 | |
191 | return xstrdup(""); | |
192 | } | |
193 | ||
e298f3b4 MY |
194 | static const struct function function_table[] = { |
195 | /* Name MIN MAX Function */ | |
1d6272e6 | 196 | { "error-if", 2, 2, do_error_if }, |
a702a617 | 197 | { "filename", 0, 0, do_filename }, |
1d6272e6 | 198 | { "info", 1, 1, do_info }, |
a702a617 | 199 | { "lineno", 0, 0, do_lineno }, |
2fd5b09c | 200 | { "shell", 1, 1, do_shell }, |
1d6272e6 | 201 | { "warning-if", 2, 2, do_warning_if }, |
e298f3b4 MY |
202 | }; |
203 | ||
204 | #define FUNCTION_MAX_ARGS 16 | |
205 | ||
206 | static char *function_expand(const char *name, int argc, char *argv[]) | |
104daea1 | 207 | { |
e298f3b4 MY |
208 | const struct function *f; |
209 | int i; | |
210 | ||
211 | for (i = 0; i < ARRAY_SIZE(function_table); i++) { | |
212 | f = &function_table[i]; | |
213 | if (strcmp(f->name, name)) | |
214 | continue; | |
215 | ||
216 | if (argc < f->min_args) | |
217 | pperror("too few function arguments passed to '%s'", | |
218 | name); | |
219 | ||
220 | if (argc > f->max_args) | |
221 | pperror("too many function arguments passed to '%s'", | |
222 | name); | |
223 | ||
224 | return f->func(argc, argv); | |
225 | } | |
226 | ||
227 | return NULL; | |
228 | } | |
229 | ||
9ced3bdd MY |
230 | /* |
231 | * Variables (and user-defined functions) | |
232 | */ | |
233 | static LIST_HEAD(variable_list); | |
234 | ||
235 | struct variable { | |
236 | char *name; | |
237 | char *value; | |
1175c025 | 238 | enum variable_flavor flavor; |
915f6490 | 239 | int exp_count; |
9ced3bdd MY |
240 | struct list_head node; |
241 | }; | |
242 | ||
243 | static struct variable *variable_lookup(const char *name) | |
244 | { | |
245 | struct variable *v; | |
246 | ||
247 | list_for_each_entry(v, &variable_list, node) { | |
248 | if (!strcmp(name, v->name)) | |
249 | return v; | |
250 | } | |
251 | ||
252 | return NULL; | |
253 | } | |
254 | ||
255 | static char *variable_expand(const char *name, int argc, char *argv[]) | |
256 | { | |
257 | struct variable *v; | |
1175c025 | 258 | char *res; |
9ced3bdd MY |
259 | |
260 | v = variable_lookup(name); | |
261 | if (!v) | |
262 | return NULL; | |
263 | ||
915f6490 MY |
264 | if (argc == 0 && v->exp_count) |
265 | pperror("Recursive variable '%s' references itself (eventually)", | |
266 | name); | |
267 | ||
268 | if (v->exp_count > 1000) | |
269 | pperror("Too deep recursive expansion"); | |
270 | ||
271 | v->exp_count++; | |
272 | ||
1175c025 MY |
273 | if (v->flavor == VAR_RECURSIVE) |
274 | res = expand_string_with_args(v->value, argc, argv); | |
275 | else | |
276 | res = xstrdup(v->value); | |
277 | ||
915f6490 MY |
278 | v->exp_count--; |
279 | ||
1175c025 | 280 | return res; |
9ced3bdd MY |
281 | } |
282 | ||
1175c025 MY |
283 | void variable_add(const char *name, const char *value, |
284 | enum variable_flavor flavor) | |
9ced3bdd MY |
285 | { |
286 | struct variable *v; | |
ed2a22f2 MY |
287 | char *new_value; |
288 | bool append = false; | |
9ced3bdd MY |
289 | |
290 | v = variable_lookup(name); | |
291 | if (v) { | |
ed2a22f2 MY |
292 | /* For defined variables, += inherits the existing flavor */ |
293 | if (flavor == VAR_APPEND) { | |
294 | flavor = v->flavor; | |
295 | append = true; | |
296 | } else { | |
297 | free(v->value); | |
298 | } | |
9ced3bdd | 299 | } else { |
ed2a22f2 MY |
300 | /* For undefined variables, += assumes the recursive flavor */ |
301 | if (flavor == VAR_APPEND) | |
302 | flavor = VAR_RECURSIVE; | |
303 | ||
9ced3bdd MY |
304 | v = xmalloc(sizeof(*v)); |
305 | v->name = xstrdup(name); | |
915f6490 | 306 | v->exp_count = 0; |
9ced3bdd MY |
307 | list_add_tail(&v->node, &variable_list); |
308 | } | |
309 | ||
1175c025 MY |
310 | v->flavor = flavor; |
311 | ||
312 | if (flavor == VAR_SIMPLE) | |
ed2a22f2 | 313 | new_value = expand_string(value); |
1175c025 | 314 | else |
ed2a22f2 MY |
315 | new_value = xstrdup(value); |
316 | ||
317 | if (append) { | |
318 | v->value = xrealloc(v->value, | |
319 | strlen(v->value) + strlen(new_value) + 2); | |
320 | strcat(v->value, " "); | |
321 | strcat(v->value, new_value); | |
322 | free(new_value); | |
323 | } else { | |
324 | v->value = new_value; | |
325 | } | |
9ced3bdd MY |
326 | } |
327 | ||
328 | static void variable_del(struct variable *v) | |
329 | { | |
330 | list_del(&v->node); | |
331 | free(v->name); | |
332 | free(v->value); | |
333 | free(v); | |
334 | } | |
335 | ||
336 | void variable_all_del(void) | |
337 | { | |
338 | struct variable *v, *tmp; | |
339 | ||
340 | list_for_each_entry_safe(v, tmp, &variable_list, node) | |
341 | variable_del(v); | |
342 | } | |
343 | ||
e298f3b4 MY |
344 | /* |
345 | * Evaluate a clause with arguments. argc/argv are arguments from the upper | |
346 | * function call. | |
347 | * | |
348 | * Returned string must be freed when done | |
349 | */ | |
350 | static char *eval_clause(const char *str, size_t len, int argc, char *argv[]) | |
351 | { | |
9ced3bdd | 352 | char *tmp, *name, *res, *endptr, *prev, *p; |
e298f3b4 MY |
353 | int new_argc = 0; |
354 | char *new_argv[FUNCTION_MAX_ARGS]; | |
355 | int nest = 0; | |
356 | int i; | |
9ced3bdd | 357 | unsigned long n; |
104daea1 MY |
358 | |
359 | tmp = xstrndup(str, len); | |
360 | ||
9ced3bdd MY |
361 | /* |
362 | * If variable name is '1', '2', etc. It is generally an argument | |
363 | * from a user-function call (i.e. local-scope variable). If not | |
364 | * available, then look-up global-scope variables. | |
365 | */ | |
366 | n = strtoul(tmp, &endptr, 10); | |
367 | if (!*endptr && n > 0 && n <= argc) { | |
368 | res = xstrdup(argv[n - 1]); | |
369 | goto free_tmp; | |
370 | } | |
371 | ||
e298f3b4 MY |
372 | prev = p = tmp; |
373 | ||
374 | /* | |
375 | * Split into tokens | |
376 | * The function name and arguments are separated by a comma. | |
377 | * For example, if the function call is like this: | |
378 | * $(foo,$(x),$(y)) | |
379 | * | |
380 | * The input string for this helper should be: | |
381 | * foo,$(x),$(y) | |
382 | * | |
383 | * and split into: | |
384 | * new_argv[0] = 'foo' | |
385 | * new_argv[1] = '$(x)' | |
386 | * new_argv[2] = '$(y)' | |
387 | */ | |
388 | while (*p) { | |
389 | if (nest == 0 && *p == ',') { | |
390 | *p = 0; | |
391 | if (new_argc >= FUNCTION_MAX_ARGS) | |
392 | pperror("too many function arguments"); | |
393 | new_argv[new_argc++] = prev; | |
394 | prev = p + 1; | |
395 | } else if (*p == '(') { | |
396 | nest++; | |
397 | } else if (*p == ')') { | |
398 | nest--; | |
399 | } | |
104daea1 | 400 | |
e298f3b4 MY |
401 | p++; |
402 | } | |
a3b7039b KM |
403 | |
404 | if (new_argc >= FUNCTION_MAX_ARGS) | |
405 | pperror("too many function arguments"); | |
e298f3b4 MY |
406 | new_argv[new_argc++] = prev; |
407 | ||
408 | /* | |
409 | * Shift arguments | |
410 | * new_argv[0] represents a function name or a variable name. Put it | |
411 | * into 'name', then shift the rest of the arguments. This simplifies | |
412 | * 'const' handling. | |
413 | */ | |
414 | name = expand_string_with_args(new_argv[0], argc, argv); | |
415 | new_argc--; | |
416 | for (i = 0; i < new_argc; i++) | |
417 | new_argv[i] = expand_string_with_args(new_argv[i + 1], | |
418 | argc, argv); | |
419 | ||
9ced3bdd MY |
420 | /* Search for variables */ |
421 | res = variable_expand(name, new_argc, new_argv); | |
422 | if (res) | |
423 | goto free; | |
424 | ||
e298f3b4 MY |
425 | /* Look for built-in functions */ |
426 | res = function_expand(name, new_argc, new_argv); | |
104daea1 MY |
427 | if (res) |
428 | goto free; | |
429 | ||
e298f3b4 MY |
430 | /* Last, try environment variable */ |
431 | if (new_argc == 0) { | |
432 | res = env_expand(name); | |
433 | if (res) | |
434 | goto free; | |
435 | } | |
436 | ||
104daea1 MY |
437 | res = xstrdup(""); |
438 | free: | |
e298f3b4 MY |
439 | for (i = 0; i < new_argc; i++) |
440 | free(new_argv[i]); | |
104daea1 | 441 | free(name); |
9ced3bdd | 442 | free_tmp: |
104daea1 MY |
443 | free(tmp); |
444 | ||
445 | return res; | |
446 | } | |
447 | ||
448 | /* | |
449 | * Expand a string that follows '$' | |
450 | * | |
451 | * For example, if the input string is | |
452 | * ($(FOO)$($(BAR)))$(BAZ) | |
453 | * this helper evaluates | |
454 | * $($(FOO)$($(BAR))) | |
455 | * and returns a new string containing the expansion (note that the string is | |
456 | * recursively expanded), also advancing 'str' to point to the next character | |
457 | * after the corresponding closing parenthesis, in this case, *str will be | |
458 | * $(BAR) | |
459 | */ | |
e298f3b4 | 460 | static char *expand_dollar_with_args(const char **str, int argc, char *argv[]) |
104daea1 MY |
461 | { |
462 | const char *p = *str; | |
463 | const char *q; | |
464 | int nest = 0; | |
465 | ||
466 | /* | |
e298f3b4 | 467 | * In Kconfig, variable/function references always start with "$(". |
104daea1 MY |
468 | * Neither single-letter variables as in $A nor curly braces as in ${CC} |
469 | * are supported. '$' not followed by '(' loses its special meaning. | |
470 | */ | |
471 | if (*p != '(') { | |
472 | *str = p; | |
473 | return xstrdup("$"); | |
474 | } | |
475 | ||
476 | p++; | |
477 | q = p; | |
478 | while (*q) { | |
479 | if (*q == '(') { | |
480 | nest++; | |
481 | } else if (*q == ')') { | |
482 | if (nest-- == 0) | |
483 | break; | |
484 | } | |
485 | q++; | |
486 | } | |
487 | ||
488 | if (!*q) | |
489 | pperror("unterminated reference to '%s': missing ')'", p); | |
490 | ||
491 | /* Advance 'str' to after the expanded initial portion of the string */ | |
492 | *str = q + 1; | |
493 | ||
e298f3b4 MY |
494 | return eval_clause(p, q - p, argc, argv); |
495 | } | |
496 | ||
497 | char *expand_dollar(const char **str) | |
498 | { | |
499 | return expand_dollar_with_args(str, 0, NULL); | |
104daea1 MY |
500 | } |
501 | ||
e298f3b4 MY |
502 | static char *__expand_string(const char **str, bool (*is_end)(char c), |
503 | int argc, char *argv[]) | |
104daea1 MY |
504 | { |
505 | const char *in, *p; | |
506 | char *expansion, *out; | |
507 | size_t in_len, out_len; | |
508 | ||
509 | out = xmalloc(1); | |
510 | *out = 0; | |
511 | out_len = 1; | |
512 | ||
513 | p = in = *str; | |
514 | ||
515 | while (1) { | |
516 | if (*p == '$') { | |
517 | in_len = p - in; | |
518 | p++; | |
e298f3b4 | 519 | expansion = expand_dollar_with_args(&p, argc, argv); |
104daea1 MY |
520 | out_len += in_len + strlen(expansion); |
521 | out = xrealloc(out, out_len); | |
522 | strncat(out, in, in_len); | |
523 | strcat(out, expansion); | |
524 | free(expansion); | |
525 | in = p; | |
526 | continue; | |
527 | } | |
528 | ||
529 | if (is_end(*p)) | |
530 | break; | |
531 | ||
532 | p++; | |
533 | } | |
534 | ||
535 | in_len = p - in; | |
536 | out_len += in_len; | |
537 | out = xrealloc(out, out_len); | |
538 | strncat(out, in, in_len); | |
539 | ||
540 | /* Advance 'str' to the end character */ | |
541 | *str = p; | |
542 | ||
543 | return out; | |
544 | } | |
545 | ||
546 | static bool is_end_of_str(char c) | |
547 | { | |
548 | return !c; | |
549 | } | |
550 | ||
551 | /* | |
e298f3b4 | 552 | * Expand variables and functions in the given string. Undefined variables |
104daea1 MY |
553 | * expand to an empty string. |
554 | * The returned string must be freed when done. | |
555 | */ | |
e298f3b4 MY |
556 | static char *expand_string_with_args(const char *in, int argc, char *argv[]) |
557 | { | |
558 | return __expand_string(&in, is_end_of_str, argc, argv); | |
559 | } | |
560 | ||
5533397d | 561 | static char *expand_string(const char *in) |
104daea1 | 562 | { |
e298f3b4 | 563 | return expand_string_with_args(in, 0, NULL); |
104daea1 MY |
564 | } |
565 | ||
566 | static bool is_end_of_token(char c) | |
567 | { | |
f5451582 | 568 | return !(isalnum(c) || c == '_' || c == '-'); |
104daea1 MY |
569 | } |
570 | ||
571 | /* | |
572 | * Expand variables in a token. The parsing stops when a token separater | |
573 | * (in most cases, it is a whitespace) is encountered. 'str' is updated to | |
574 | * point to the next character. | |
575 | * | |
576 | * The returned string must be freed when done. | |
577 | */ | |
578 | char *expand_one_token(const char **str) | |
579 | { | |
e298f3b4 | 580 | return __expand_string(str, is_end_of_token, 0, NULL); |
104daea1 | 581 | } |