xref: /openbmc/linux/scripts/kconfig/symbol.c (revision 54f514a0)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
4  */
5 
6 #include <sys/types.h>
7 #include <ctype.h>
8 #include <stdlib.h>
9 #include <string.h>
10 #include <regex.h>
11 
12 #include "lkc.h"
13 
14 struct symbol symbol_yes = {
15 	.name = "y",
16 	.type = S_TRISTATE,
17 	.curr = { "y", yes },
18 	.flags = SYMBOL_CONST|SYMBOL_VALID,
19 };
20 
21 struct symbol symbol_mod = {
22 	.name = "m",
23 	.type = S_TRISTATE,
24 	.curr = { "m", mod },
25 	.flags = SYMBOL_CONST|SYMBOL_VALID,
26 };
27 
28 struct symbol symbol_no = {
29 	.name = "n",
30 	.type = S_TRISTATE,
31 	.curr = { "n", no },
32 	.flags = SYMBOL_CONST|SYMBOL_VALID,
33 };
34 
35 static struct symbol symbol_empty = {
36 	.name = "",
37 	.curr = { "", no },
38 	.flags = SYMBOL_VALID,
39 };
40 
41 struct symbol *modules_sym;
42 static tristate modules_val;
43 
44 enum symbol_type sym_get_type(struct symbol *sym)
45 {
46 	enum symbol_type type = sym->type;
47 
48 	if (type == S_TRISTATE) {
49 		if (sym_is_choice_value(sym) && sym->visible == yes)
50 			type = S_BOOLEAN;
51 		else if (modules_val == no)
52 			type = S_BOOLEAN;
53 	}
54 	return type;
55 }
56 
57 const char *sym_type_name(enum symbol_type type)
58 {
59 	switch (type) {
60 	case S_BOOLEAN:
61 		return "bool";
62 	case S_TRISTATE:
63 		return "tristate";
64 	case S_INT:
65 		return "integer";
66 	case S_HEX:
67 		return "hex";
68 	case S_STRING:
69 		return "string";
70 	case S_UNKNOWN:
71 		return "unknown";
72 	}
73 	return "???";
74 }
75 
76 struct property *sym_get_choice_prop(struct symbol *sym)
77 {
78 	struct property *prop;
79 
80 	for_all_choices(sym, prop)
81 		return prop;
82 	return NULL;
83 }
84 
85 static struct property *sym_get_default_prop(struct symbol *sym)
86 {
87 	struct property *prop;
88 
89 	for_all_defaults(sym, prop) {
90 		prop->visible.tri = expr_calc_value(prop->visible.expr);
91 		if (prop->visible.tri != no)
92 			return prop;
93 	}
94 	return NULL;
95 }
96 
97 struct property *sym_get_range_prop(struct symbol *sym)
98 {
99 	struct property *prop;
100 
101 	for_all_properties(sym, prop, P_RANGE) {
102 		prop->visible.tri = expr_calc_value(prop->visible.expr);
103 		if (prop->visible.tri != no)
104 			return prop;
105 	}
106 	return NULL;
107 }
108 
109 static long long sym_get_range_val(struct symbol *sym, int base)
110 {
111 	sym_calc_value(sym);
112 	switch (sym->type) {
113 	case S_INT:
114 		base = 10;
115 		break;
116 	case S_HEX:
117 		base = 16;
118 		break;
119 	default:
120 		break;
121 	}
122 	return strtoll(sym->curr.val, NULL, base);
123 }
124 
125 static void sym_validate_range(struct symbol *sym)
126 {
127 	struct property *prop;
128 	struct symbol *range_sym;
129 	int base;
130 	long long val, val2;
131 
132 	switch (sym->type) {
133 	case S_INT:
134 		base = 10;
135 		break;
136 	case S_HEX:
137 		base = 16;
138 		break;
139 	default:
140 		return;
141 	}
142 	prop = sym_get_range_prop(sym);
143 	if (!prop)
144 		return;
145 	val = strtoll(sym->curr.val, NULL, base);
146 	range_sym = prop->expr->left.sym;
147 	val2 = sym_get_range_val(range_sym, base);
148 	if (val >= val2) {
149 		range_sym = prop->expr->right.sym;
150 		val2 = sym_get_range_val(range_sym, base);
151 		if (val <= val2)
152 			return;
153 	}
154 	sym->curr.val = range_sym->curr.val;
155 }
156 
157 static void sym_set_changed(struct symbol *sym)
158 {
159 	struct property *prop;
160 
161 	sym->flags |= SYMBOL_CHANGED;
162 	for (prop = sym->prop; prop; prop = prop->next) {
163 		if (prop->menu)
164 			prop->menu->flags |= MENU_CHANGED;
165 	}
166 }
167 
168 static void sym_set_all_changed(void)
169 {
170 	struct symbol *sym;
171 	int i;
172 
173 	for_all_symbols(i, sym)
174 		sym_set_changed(sym);
175 }
176 
177 static void sym_calc_visibility(struct symbol *sym)
178 {
179 	struct property *prop;
180 	struct symbol *choice_sym = NULL;
181 	tristate tri;
182 
183 	/* any prompt visible? */
184 	tri = no;
185 
186 	if (sym_is_choice_value(sym))
187 		choice_sym = prop_get_symbol(sym_get_choice_prop(sym));
188 
189 	for_all_prompts(sym, prop) {
190 		prop->visible.tri = expr_calc_value(prop->visible.expr);
191 		/*
192 		 * Tristate choice_values with visibility 'mod' are
193 		 * not visible if the corresponding choice's value is
194 		 * 'yes'.
195 		 */
196 		if (choice_sym && sym->type == S_TRISTATE &&
197 		    prop->visible.tri == mod && choice_sym->curr.tri == yes)
198 			prop->visible.tri = no;
199 
200 		tri = EXPR_OR(tri, prop->visible.tri);
201 	}
202 	if (tri == mod && (sym->type != S_TRISTATE || modules_val == no))
203 		tri = yes;
204 	if (sym->visible != tri) {
205 		sym->visible = tri;
206 		sym_set_changed(sym);
207 	}
208 	if (sym_is_choice_value(sym))
209 		return;
210 	/* defaulting to "yes" if no explicit "depends on" are given */
211 	tri = yes;
212 	if (sym->dir_dep.expr)
213 		tri = expr_calc_value(sym->dir_dep.expr);
214 	if (tri == mod && sym_get_type(sym) == S_BOOLEAN)
215 		tri = yes;
216 	if (sym->dir_dep.tri != tri) {
217 		sym->dir_dep.tri = tri;
218 		sym_set_changed(sym);
219 	}
220 	tri = no;
221 	if (sym->rev_dep.expr)
222 		tri = expr_calc_value(sym->rev_dep.expr);
223 	if (tri == mod && sym_get_type(sym) == S_BOOLEAN)
224 		tri = yes;
225 	if (sym->rev_dep.tri != tri) {
226 		sym->rev_dep.tri = tri;
227 		sym_set_changed(sym);
228 	}
229 	tri = no;
230 	if (sym->implied.expr)
231 		tri = expr_calc_value(sym->implied.expr);
232 	if (tri == mod && sym_get_type(sym) == S_BOOLEAN)
233 		tri = yes;
234 	if (sym->implied.tri != tri) {
235 		sym->implied.tri = tri;
236 		sym_set_changed(sym);
237 	}
238 }
239 
240 /*
241  * Find the default symbol for a choice.
242  * First try the default values for the choice symbol
243  * Next locate the first visible choice value
244  * Return NULL if none was found
245  */
246 struct symbol *sym_choice_default(struct symbol *sym)
247 {
248 	struct symbol *def_sym;
249 	struct property *prop;
250 	struct expr *e;
251 
252 	/* any of the defaults visible? */
253 	for_all_defaults(sym, prop) {
254 		prop->visible.tri = expr_calc_value(prop->visible.expr);
255 		if (prop->visible.tri == no)
256 			continue;
257 		def_sym = prop_get_symbol(prop);
258 		if (def_sym->visible != no)
259 			return def_sym;
260 	}
261 
262 	/* just get the first visible value */
263 	prop = sym_get_choice_prop(sym);
264 	expr_list_for_each_sym(prop->expr, e, def_sym)
265 		if (def_sym->visible != no)
266 			return def_sym;
267 
268 	/* failed to locate any defaults */
269 	return NULL;
270 }
271 
272 static struct symbol *sym_calc_choice(struct symbol *sym)
273 {
274 	struct symbol *def_sym;
275 	struct property *prop;
276 	struct expr *e;
277 	int flags;
278 
279 	/* first calculate all choice values' visibilities */
280 	flags = sym->flags;
281 	prop = sym_get_choice_prop(sym);
282 	expr_list_for_each_sym(prop->expr, e, def_sym) {
283 		sym_calc_visibility(def_sym);
284 		if (def_sym->visible != no)
285 			flags &= def_sym->flags;
286 	}
287 
288 	sym->flags &= flags | ~SYMBOL_DEF_USER;
289 
290 	/* is the user choice visible? */
291 	def_sym = sym->def[S_DEF_USER].val;
292 	if (def_sym && def_sym->visible != no)
293 		return def_sym;
294 
295 	def_sym = sym_choice_default(sym);
296 
297 	if (def_sym == NULL)
298 		/* no choice? reset tristate value */
299 		sym->curr.tri = no;
300 
301 	return def_sym;
302 }
303 
304 static void sym_warn_unmet_dep(struct symbol *sym)
305 {
306 	struct gstr gs = str_new();
307 
308 	str_printf(&gs,
309 		   "\nWARNING: unmet direct dependencies detected for %s\n",
310 		   sym->name);
311 	str_printf(&gs,
312 		   "  Depends on [%c]: ",
313 		   sym->dir_dep.tri == mod ? 'm' : 'n');
314 	expr_gstr_print(sym->dir_dep.expr, &gs);
315 	str_printf(&gs, "\n");
316 
317 	expr_gstr_print_revdep(sym->rev_dep.expr, &gs, yes,
318 			       "  Selected by [y]:\n");
319 	expr_gstr_print_revdep(sym->rev_dep.expr, &gs, mod,
320 			       "  Selected by [m]:\n");
321 
322 	fputs(str_get(&gs), stderr);
323 }
324 
325 void sym_calc_value(struct symbol *sym)
326 {
327 	struct symbol_value newval, oldval;
328 	struct property *prop;
329 	struct expr *e;
330 
331 	if (!sym)
332 		return;
333 
334 	if (sym->flags & SYMBOL_VALID)
335 		return;
336 
337 	if (sym_is_choice_value(sym) &&
338 	    sym->flags & SYMBOL_NEED_SET_CHOICE_VALUES) {
339 		sym->flags &= ~SYMBOL_NEED_SET_CHOICE_VALUES;
340 		prop = sym_get_choice_prop(sym);
341 		sym_calc_value(prop_get_symbol(prop));
342 	}
343 
344 	sym->flags |= SYMBOL_VALID;
345 
346 	oldval = sym->curr;
347 
348 	switch (sym->type) {
349 	case S_INT:
350 	case S_HEX:
351 	case S_STRING:
352 		newval = symbol_empty.curr;
353 		break;
354 	case S_BOOLEAN:
355 	case S_TRISTATE:
356 		newval = symbol_no.curr;
357 		break;
358 	default:
359 		sym->curr.val = sym->name;
360 		sym->curr.tri = no;
361 		return;
362 	}
363 	sym->flags &= ~SYMBOL_WRITE;
364 
365 	sym_calc_visibility(sym);
366 
367 	if (sym->visible != no)
368 		sym->flags |= SYMBOL_WRITE;
369 
370 	/* set default if recursively called */
371 	sym->curr = newval;
372 
373 	switch (sym_get_type(sym)) {
374 	case S_BOOLEAN:
375 	case S_TRISTATE:
376 		if (sym_is_choice_value(sym) && sym->visible == yes) {
377 			prop = sym_get_choice_prop(sym);
378 			newval.tri = (prop_get_symbol(prop)->curr.val == sym) ? yes : no;
379 		} else {
380 			if (sym->visible != no) {
381 				/* if the symbol is visible use the user value
382 				 * if available, otherwise try the default value
383 				 */
384 				if (sym_has_value(sym)) {
385 					newval.tri = EXPR_AND(sym->def[S_DEF_USER].tri,
386 							      sym->visible);
387 					goto calc_newval;
388 				}
389 			}
390 			if (sym->rev_dep.tri != no)
391 				sym->flags |= SYMBOL_WRITE;
392 			if (!sym_is_choice(sym)) {
393 				prop = sym_get_default_prop(sym);
394 				if (prop) {
395 					newval.tri = EXPR_AND(expr_calc_value(prop->expr),
396 							      prop->visible.tri);
397 					if (newval.tri != no)
398 						sym->flags |= SYMBOL_WRITE;
399 				}
400 				if (sym->implied.tri != no) {
401 					sym->flags |= SYMBOL_WRITE;
402 					newval.tri = EXPR_OR(newval.tri, sym->implied.tri);
403 					newval.tri = EXPR_AND(newval.tri,
404 							      sym->dir_dep.tri);
405 				}
406 			}
407 		calc_newval:
408 			if (sym->dir_dep.tri < sym->rev_dep.tri)
409 				sym_warn_unmet_dep(sym);
410 			newval.tri = EXPR_OR(newval.tri, sym->rev_dep.tri);
411 		}
412 		if (newval.tri == mod && sym_get_type(sym) == S_BOOLEAN)
413 			newval.tri = yes;
414 		break;
415 	case S_STRING:
416 	case S_HEX:
417 	case S_INT:
418 		if (sym->visible != no && sym_has_value(sym)) {
419 			newval.val = sym->def[S_DEF_USER].val;
420 			break;
421 		}
422 		prop = sym_get_default_prop(sym);
423 		if (prop) {
424 			struct symbol *ds = prop_get_symbol(prop);
425 			if (ds) {
426 				sym->flags |= SYMBOL_WRITE;
427 				sym_calc_value(ds);
428 				newval.val = ds->curr.val;
429 			}
430 		}
431 		break;
432 	default:
433 		;
434 	}
435 
436 	sym->curr = newval;
437 	if (sym_is_choice(sym) && newval.tri == yes)
438 		sym->curr.val = sym_calc_choice(sym);
439 	sym_validate_range(sym);
440 
441 	if (memcmp(&oldval, &sym->curr, sizeof(oldval))) {
442 		sym_set_changed(sym);
443 		if (modules_sym == sym) {
444 			sym_set_all_changed();
445 			modules_val = modules_sym->curr.tri;
446 		}
447 	}
448 
449 	if (sym_is_choice(sym)) {
450 		struct symbol *choice_sym;
451 
452 		prop = sym_get_choice_prop(sym);
453 		expr_list_for_each_sym(prop->expr, e, choice_sym) {
454 			if ((sym->flags & SYMBOL_WRITE) &&
455 			    choice_sym->visible != no)
456 				choice_sym->flags |= SYMBOL_WRITE;
457 			if (sym->flags & SYMBOL_CHANGED)
458 				sym_set_changed(choice_sym);
459 		}
460 	}
461 
462 	if (sym->flags & SYMBOL_NO_WRITE)
463 		sym->flags &= ~SYMBOL_WRITE;
464 
465 	if (sym->flags & SYMBOL_NEED_SET_CHOICE_VALUES)
466 		set_all_choice_values(sym);
467 }
468 
469 void sym_clear_all_valid(void)
470 {
471 	struct symbol *sym;
472 	int i;
473 
474 	for_all_symbols(i, sym)
475 		sym->flags &= ~SYMBOL_VALID;
476 	conf_set_changed(true);
477 	sym_calc_value(modules_sym);
478 }
479 
480 bool sym_tristate_within_range(struct symbol *sym, tristate val)
481 {
482 	int type = sym_get_type(sym);
483 
484 	if (sym->visible == no)
485 		return false;
486 
487 	if (type != S_BOOLEAN && type != S_TRISTATE)
488 		return false;
489 
490 	if (type == S_BOOLEAN && val == mod)
491 		return false;
492 	if (sym->visible <= sym->rev_dep.tri)
493 		return false;
494 	if (sym_is_choice_value(sym) && sym->visible == yes)
495 		return val == yes;
496 	return val >= sym->rev_dep.tri && val <= sym->visible;
497 }
498 
499 bool sym_set_tristate_value(struct symbol *sym, tristate val)
500 {
501 	tristate oldval = sym_get_tristate_value(sym);
502 
503 	if (oldval != val && !sym_tristate_within_range(sym, val))
504 		return false;
505 
506 	if (!(sym->flags & SYMBOL_DEF_USER)) {
507 		sym->flags |= SYMBOL_DEF_USER;
508 		sym_set_changed(sym);
509 	}
510 	/*
511 	 * setting a choice value also resets the new flag of the choice
512 	 * symbol and all other choice values.
513 	 */
514 	if (sym_is_choice_value(sym) && val == yes) {
515 		struct symbol *cs = prop_get_symbol(sym_get_choice_prop(sym));
516 		struct property *prop;
517 		struct expr *e;
518 
519 		cs->def[S_DEF_USER].val = sym;
520 		cs->flags |= SYMBOL_DEF_USER;
521 		prop = sym_get_choice_prop(cs);
522 		for (e = prop->expr; e; e = e->left.expr) {
523 			if (e->right.sym->visible != no)
524 				e->right.sym->flags |= SYMBOL_DEF_USER;
525 		}
526 	}
527 
528 	sym->def[S_DEF_USER].tri = val;
529 	if (oldval != val)
530 		sym_clear_all_valid();
531 
532 	return true;
533 }
534 
535 tristate sym_toggle_tristate_value(struct symbol *sym)
536 {
537 	tristate oldval, newval;
538 
539 	oldval = newval = sym_get_tristate_value(sym);
540 	do {
541 		switch (newval) {
542 		case no:
543 			newval = mod;
544 			break;
545 		case mod:
546 			newval = yes;
547 			break;
548 		case yes:
549 			newval = no;
550 			break;
551 		}
552 		if (sym_set_tristate_value(sym, newval))
553 			break;
554 	} while (oldval != newval);
555 	return newval;
556 }
557 
558 bool sym_string_valid(struct symbol *sym, const char *str)
559 {
560 	signed char ch;
561 
562 	switch (sym->type) {
563 	case S_STRING:
564 		return true;
565 	case S_INT:
566 		ch = *str++;
567 		if (ch == '-')
568 			ch = *str++;
569 		if (!isdigit(ch))
570 			return false;
571 		if (ch == '0' && *str != 0)
572 			return false;
573 		while ((ch = *str++)) {
574 			if (!isdigit(ch))
575 				return false;
576 		}
577 		return true;
578 	case S_HEX:
579 		if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
580 			str += 2;
581 		ch = *str++;
582 		do {
583 			if (!isxdigit(ch))
584 				return false;
585 		} while ((ch = *str++));
586 		return true;
587 	case S_BOOLEAN:
588 	case S_TRISTATE:
589 		switch (str[0]) {
590 		case 'y': case 'Y':
591 		case 'm': case 'M':
592 		case 'n': case 'N':
593 			return true;
594 		}
595 		return false;
596 	default:
597 		return false;
598 	}
599 }
600 
601 bool sym_string_within_range(struct symbol *sym, const char *str)
602 {
603 	struct property *prop;
604 	long long val;
605 
606 	switch (sym->type) {
607 	case S_STRING:
608 		return sym_string_valid(sym, str);
609 	case S_INT:
610 		if (!sym_string_valid(sym, str))
611 			return false;
612 		prop = sym_get_range_prop(sym);
613 		if (!prop)
614 			return true;
615 		val = strtoll(str, NULL, 10);
616 		return val >= sym_get_range_val(prop->expr->left.sym, 10) &&
617 		       val <= sym_get_range_val(prop->expr->right.sym, 10);
618 	case S_HEX:
619 		if (!sym_string_valid(sym, str))
620 			return false;
621 		prop = sym_get_range_prop(sym);
622 		if (!prop)
623 			return true;
624 		val = strtoll(str, NULL, 16);
625 		return val >= sym_get_range_val(prop->expr->left.sym, 16) &&
626 		       val <= sym_get_range_val(prop->expr->right.sym, 16);
627 	case S_BOOLEAN:
628 	case S_TRISTATE:
629 		switch (str[0]) {
630 		case 'y': case 'Y':
631 			return sym_tristate_within_range(sym, yes);
632 		case 'm': case 'M':
633 			return sym_tristate_within_range(sym, mod);
634 		case 'n': case 'N':
635 			return sym_tristate_within_range(sym, no);
636 		}
637 		return false;
638 	default:
639 		return false;
640 	}
641 }
642 
643 bool sym_set_string_value(struct symbol *sym, const char *newval)
644 {
645 	const char *oldval;
646 	char *val;
647 	int size;
648 
649 	switch (sym->type) {
650 	case S_BOOLEAN:
651 	case S_TRISTATE:
652 		switch (newval[0]) {
653 		case 'y': case 'Y':
654 			return sym_set_tristate_value(sym, yes);
655 		case 'm': case 'M':
656 			return sym_set_tristate_value(sym, mod);
657 		case 'n': case 'N':
658 			return sym_set_tristate_value(sym, no);
659 		}
660 		return false;
661 	default:
662 		;
663 	}
664 
665 	if (!sym_string_within_range(sym, newval))
666 		return false;
667 
668 	if (!(sym->flags & SYMBOL_DEF_USER)) {
669 		sym->flags |= SYMBOL_DEF_USER;
670 		sym_set_changed(sym);
671 	}
672 
673 	oldval = sym->def[S_DEF_USER].val;
674 	size = strlen(newval) + 1;
675 	if (sym->type == S_HEX && (newval[0] != '0' || (newval[1] != 'x' && newval[1] != 'X'))) {
676 		size += 2;
677 		sym->def[S_DEF_USER].val = val = xmalloc(size);
678 		*val++ = '0';
679 		*val++ = 'x';
680 	} else if (!oldval || strcmp(oldval, newval))
681 		sym->def[S_DEF_USER].val = val = xmalloc(size);
682 	else
683 		return true;
684 
685 	strcpy(val, newval);
686 	free((void *)oldval);
687 	sym_clear_all_valid();
688 
689 	return true;
690 }
691 
692 /*
693  * Find the default value associated to a symbol.
694  * For tristate symbol handle the modules=n case
695  * in which case "m" becomes "y".
696  * If the symbol does not have any default then fallback
697  * to the fixed default values.
698  */
699 const char *sym_get_string_default(struct symbol *sym)
700 {
701 	struct property *prop;
702 	struct symbol *ds;
703 	const char *str;
704 	tristate val;
705 
706 	sym_calc_visibility(sym);
707 	sym_calc_value(modules_sym);
708 	val = symbol_no.curr.tri;
709 	str = symbol_empty.curr.val;
710 
711 	/* If symbol has a default value look it up */
712 	prop = sym_get_default_prop(sym);
713 	if (prop != NULL) {
714 		switch (sym->type) {
715 		case S_BOOLEAN:
716 		case S_TRISTATE:
717 			/* The visibility may limit the value from yes => mod */
718 			val = EXPR_AND(expr_calc_value(prop->expr), prop->visible.tri);
719 			break;
720 		default:
721 			/*
722 			 * The following fails to handle the situation
723 			 * where a default value is further limited by
724 			 * the valid range.
725 			 */
726 			ds = prop_get_symbol(prop);
727 			if (ds != NULL) {
728 				sym_calc_value(ds);
729 				str = (const char *)ds->curr.val;
730 			}
731 		}
732 	}
733 
734 	/* Handle select statements */
735 	val = EXPR_OR(val, sym->rev_dep.tri);
736 
737 	/* transpose mod to yes if modules are not enabled */
738 	if (val == mod)
739 		if (!sym_is_choice_value(sym) && modules_sym->curr.tri == no)
740 			val = yes;
741 
742 	/* transpose mod to yes if type is bool */
743 	if (sym->type == S_BOOLEAN && val == mod)
744 		val = yes;
745 
746 	/* adjust the default value if this symbol is implied by another */
747 	if (val < sym->implied.tri)
748 		val = sym->implied.tri;
749 
750 	switch (sym->type) {
751 	case S_BOOLEAN:
752 	case S_TRISTATE:
753 		switch (val) {
754 		case no: return "n";
755 		case mod: return "m";
756 		case yes: return "y";
757 		}
758 	case S_INT:
759 	case S_HEX:
760 		return str;
761 	case S_STRING:
762 		return str;
763 	case S_UNKNOWN:
764 		break;
765 	}
766 	return "";
767 }
768 
769 const char *sym_get_string_value(struct symbol *sym)
770 {
771 	tristate val;
772 
773 	switch (sym->type) {
774 	case S_BOOLEAN:
775 	case S_TRISTATE:
776 		val = sym_get_tristate_value(sym);
777 		switch (val) {
778 		case no:
779 			return "n";
780 		case mod:
781 			return "m";
782 		case yes:
783 			return "y";
784 		}
785 		break;
786 	default:
787 		;
788 	}
789 	return (const char *)sym->curr.val;
790 }
791 
792 bool sym_is_changeable(struct symbol *sym)
793 {
794 	return sym->visible > sym->rev_dep.tri;
795 }
796 
797 static unsigned strhash(const char *s)
798 {
799 	/* fnv32 hash */
800 	unsigned hash = 2166136261U;
801 	for (; *s; s++)
802 		hash = (hash ^ *s) * 0x01000193;
803 	return hash;
804 }
805 
806 struct symbol *sym_lookup(const char *name, int flags)
807 {
808 	struct symbol *symbol;
809 	char *new_name;
810 	int hash;
811 
812 	if (name) {
813 		if (name[0] && !name[1]) {
814 			switch (name[0]) {
815 			case 'y': return &symbol_yes;
816 			case 'm': return &symbol_mod;
817 			case 'n': return &symbol_no;
818 			}
819 		}
820 		hash = strhash(name) % SYMBOL_HASHSIZE;
821 
822 		for (symbol = symbol_hash[hash]; symbol; symbol = symbol->next) {
823 			if (symbol->name &&
824 			    !strcmp(symbol->name, name) &&
825 			    (flags ? symbol->flags & flags
826 				   : !(symbol->flags & (SYMBOL_CONST|SYMBOL_CHOICE))))
827 				return symbol;
828 		}
829 		new_name = xstrdup(name);
830 	} else {
831 		new_name = NULL;
832 		hash = 0;
833 	}
834 
835 	symbol = xmalloc(sizeof(*symbol));
836 	memset(symbol, 0, sizeof(*symbol));
837 	symbol->name = new_name;
838 	symbol->type = S_UNKNOWN;
839 	symbol->flags = flags;
840 
841 	symbol->next = symbol_hash[hash];
842 	symbol_hash[hash] = symbol;
843 
844 	return symbol;
845 }
846 
847 struct symbol *sym_find(const char *name)
848 {
849 	struct symbol *symbol = NULL;
850 	int hash = 0;
851 
852 	if (!name)
853 		return NULL;
854 
855 	if (name[0] && !name[1]) {
856 		switch (name[0]) {
857 		case 'y': return &symbol_yes;
858 		case 'm': return &symbol_mod;
859 		case 'n': return &symbol_no;
860 		}
861 	}
862 	hash = strhash(name) % SYMBOL_HASHSIZE;
863 
864 	for (symbol = symbol_hash[hash]; symbol; symbol = symbol->next) {
865 		if (symbol->name &&
866 		    !strcmp(symbol->name, name) &&
867 		    !(symbol->flags & SYMBOL_CONST))
868 				break;
869 	}
870 
871 	return symbol;
872 }
873 
874 struct sym_match {
875 	struct symbol	*sym;
876 	off_t		so, eo;
877 };
878 
879 /* Compare matched symbols as thus:
880  * - first, symbols that match exactly
881  * - then, alphabetical sort
882  */
883 static int sym_rel_comp(const void *sym1, const void *sym2)
884 {
885 	const struct sym_match *s1 = sym1;
886 	const struct sym_match *s2 = sym2;
887 	int exact1, exact2;
888 
889 	/* Exact match:
890 	 * - if matched length on symbol s1 is the length of that symbol,
891 	 *   then this symbol should come first;
892 	 * - if matched length on symbol s2 is the length of that symbol,
893 	 *   then this symbol should come first.
894 	 * Note: since the search can be a regexp, both symbols may match
895 	 * exactly; if this is the case, we can't decide which comes first,
896 	 * and we fallback to sorting alphabetically.
897 	 */
898 	exact1 = (s1->eo - s1->so) == strlen(s1->sym->name);
899 	exact2 = (s2->eo - s2->so) == strlen(s2->sym->name);
900 	if (exact1 && !exact2)
901 		return -1;
902 	if (!exact1 && exact2)
903 		return 1;
904 
905 	/* As a fallback, sort symbols alphabetically */
906 	return strcmp(s1->sym->name, s2->sym->name);
907 }
908 
909 struct symbol **sym_re_search(const char *pattern)
910 {
911 	struct symbol *sym, **sym_arr = NULL;
912 	struct sym_match *sym_match_arr = NULL;
913 	int i, cnt, size;
914 	regex_t re;
915 	regmatch_t match[1];
916 
917 	cnt = size = 0;
918 	/* Skip if empty */
919 	if (strlen(pattern) == 0)
920 		return NULL;
921 	if (regcomp(&re, pattern, REG_EXTENDED|REG_ICASE))
922 		return NULL;
923 
924 	for_all_symbols(i, sym) {
925 		if (sym->flags & SYMBOL_CONST || !sym->name)
926 			continue;
927 		if (regexec(&re, sym->name, 1, match, 0))
928 			continue;
929 		if (cnt >= size) {
930 			void *tmp;
931 			size += 16;
932 			tmp = realloc(sym_match_arr, size * sizeof(struct sym_match));
933 			if (!tmp)
934 				goto sym_re_search_free;
935 			sym_match_arr = tmp;
936 		}
937 		sym_calc_value(sym);
938 		/* As regexec returned 0, we know we have a match, so
939 		 * we can use match[0].rm_[se]o without further checks
940 		 */
941 		sym_match_arr[cnt].so = match[0].rm_so;
942 		sym_match_arr[cnt].eo = match[0].rm_eo;
943 		sym_match_arr[cnt++].sym = sym;
944 	}
945 	if (sym_match_arr) {
946 		qsort(sym_match_arr, cnt, sizeof(struct sym_match), sym_rel_comp);
947 		sym_arr = malloc((cnt+1) * sizeof(struct symbol *));
948 		if (!sym_arr)
949 			goto sym_re_search_free;
950 		for (i = 0; i < cnt; i++)
951 			sym_arr[i] = sym_match_arr[i].sym;
952 		sym_arr[cnt] = NULL;
953 	}
954 sym_re_search_free:
955 	/* sym_match_arr can be NULL if no match, but free(NULL) is OK */
956 	free(sym_match_arr);
957 	regfree(&re);
958 
959 	return sym_arr;
960 }
961 
962 /*
963  * When we check for recursive dependencies we use a stack to save
964  * current state so we can print out relevant info to user.
965  * The entries are located on the call stack so no need to free memory.
966  * Note insert() remove() must always match to properly clear the stack.
967  */
968 static struct dep_stack {
969 	struct dep_stack *prev, *next;
970 	struct symbol *sym;
971 	struct property *prop;
972 	struct expr **expr;
973 } *check_top;
974 
975 static void dep_stack_insert(struct dep_stack *stack, struct symbol *sym)
976 {
977 	memset(stack, 0, sizeof(*stack));
978 	if (check_top)
979 		check_top->next = stack;
980 	stack->prev = check_top;
981 	stack->sym = sym;
982 	check_top = stack;
983 }
984 
985 static void dep_stack_remove(void)
986 {
987 	check_top = check_top->prev;
988 	if (check_top)
989 		check_top->next = NULL;
990 }
991 
992 /*
993  * Called when we have detected a recursive dependency.
994  * check_top point to the top of the stact so we use
995  * the ->prev pointer to locate the bottom of the stack.
996  */
997 static void sym_check_print_recursive(struct symbol *last_sym)
998 {
999 	struct dep_stack *stack;
1000 	struct symbol *sym, *next_sym;
1001 	struct menu *menu = NULL;
1002 	struct property *prop;
1003 	struct dep_stack cv_stack;
1004 
1005 	if (sym_is_choice_value(last_sym)) {
1006 		dep_stack_insert(&cv_stack, last_sym);
1007 		last_sym = prop_get_symbol(sym_get_choice_prop(last_sym));
1008 	}
1009 
1010 	for (stack = check_top; stack != NULL; stack = stack->prev)
1011 		if (stack->sym == last_sym)
1012 			break;
1013 	if (!stack) {
1014 		fprintf(stderr, "unexpected recursive dependency error\n");
1015 		return;
1016 	}
1017 
1018 	for (; stack; stack = stack->next) {
1019 		sym = stack->sym;
1020 		next_sym = stack->next ? stack->next->sym : last_sym;
1021 		prop = stack->prop;
1022 		if (prop == NULL)
1023 			prop = stack->sym->prop;
1024 
1025 		/* for choice values find the menu entry (used below) */
1026 		if (sym_is_choice(sym) || sym_is_choice_value(sym)) {
1027 			for (prop = sym->prop; prop; prop = prop->next) {
1028 				menu = prop->menu;
1029 				if (prop->menu)
1030 					break;
1031 			}
1032 		}
1033 		if (stack->sym == last_sym)
1034 			fprintf(stderr, "%s:%d:error: recursive dependency detected!\n",
1035 				prop->file->name, prop->lineno);
1036 
1037 		if (sym_is_choice(sym)) {
1038 			fprintf(stderr, "%s:%d:\tchoice %s contains symbol %s\n",
1039 				menu->file->name, menu->lineno,
1040 				sym->name ? sym->name : "<choice>",
1041 				next_sym->name ? next_sym->name : "<choice>");
1042 		} else if (sym_is_choice_value(sym)) {
1043 			fprintf(stderr, "%s:%d:\tsymbol %s is part of choice %s\n",
1044 				menu->file->name, menu->lineno,
1045 				sym->name ? sym->name : "<choice>",
1046 				next_sym->name ? next_sym->name : "<choice>");
1047 		} else if (stack->expr == &sym->dir_dep.expr) {
1048 			fprintf(stderr, "%s:%d:\tsymbol %s depends on %s\n",
1049 				prop->file->name, prop->lineno,
1050 				sym->name ? sym->name : "<choice>",
1051 				next_sym->name ? next_sym->name : "<choice>");
1052 		} else if (stack->expr == &sym->rev_dep.expr) {
1053 			fprintf(stderr, "%s:%d:\tsymbol %s is selected by %s\n",
1054 				prop->file->name, prop->lineno,
1055 				sym->name ? sym->name : "<choice>",
1056 				next_sym->name ? next_sym->name : "<choice>");
1057 		} else if (stack->expr == &sym->implied.expr) {
1058 			fprintf(stderr, "%s:%d:\tsymbol %s is implied by %s\n",
1059 				prop->file->name, prop->lineno,
1060 				sym->name ? sym->name : "<choice>",
1061 				next_sym->name ? next_sym->name : "<choice>");
1062 		} else if (stack->expr) {
1063 			fprintf(stderr, "%s:%d:\tsymbol %s %s value contains %s\n",
1064 				prop->file->name, prop->lineno,
1065 				sym->name ? sym->name : "<choice>",
1066 				prop_get_type_name(prop->type),
1067 				next_sym->name ? next_sym->name : "<choice>");
1068 		} else {
1069 			fprintf(stderr, "%s:%d:\tsymbol %s %s is visible depending on %s\n",
1070 				prop->file->name, prop->lineno,
1071 				sym->name ? sym->name : "<choice>",
1072 				prop_get_type_name(prop->type),
1073 				next_sym->name ? next_sym->name : "<choice>");
1074 		}
1075 	}
1076 
1077 	fprintf(stderr,
1078 		"For a resolution refer to Documentation/kbuild/kconfig-language.rst\n"
1079 		"subsection \"Kconfig recursive dependency limitations\"\n"
1080 		"\n");
1081 
1082 	if (check_top == &cv_stack)
1083 		dep_stack_remove();
1084 }
1085 
1086 static struct symbol *sym_check_expr_deps(struct expr *e)
1087 {
1088 	struct symbol *sym;
1089 
1090 	if (!e)
1091 		return NULL;
1092 	switch (e->type) {
1093 	case E_OR:
1094 	case E_AND:
1095 		sym = sym_check_expr_deps(e->left.expr);
1096 		if (sym)
1097 			return sym;
1098 		return sym_check_expr_deps(e->right.expr);
1099 	case E_NOT:
1100 		return sym_check_expr_deps(e->left.expr);
1101 	case E_EQUAL:
1102 	case E_GEQ:
1103 	case E_GTH:
1104 	case E_LEQ:
1105 	case E_LTH:
1106 	case E_UNEQUAL:
1107 		sym = sym_check_deps(e->left.sym);
1108 		if (sym)
1109 			return sym;
1110 		return sym_check_deps(e->right.sym);
1111 	case E_SYMBOL:
1112 		return sym_check_deps(e->left.sym);
1113 	default:
1114 		break;
1115 	}
1116 	fprintf(stderr, "Oops! How to check %d?\n", e->type);
1117 	return NULL;
1118 }
1119 
1120 /* return NULL when dependencies are OK */
1121 static struct symbol *sym_check_sym_deps(struct symbol *sym)
1122 {
1123 	struct symbol *sym2;
1124 	struct property *prop;
1125 	struct dep_stack stack;
1126 
1127 	dep_stack_insert(&stack, sym);
1128 
1129 	stack.expr = &sym->dir_dep.expr;
1130 	sym2 = sym_check_expr_deps(sym->dir_dep.expr);
1131 	if (sym2)
1132 		goto out;
1133 
1134 	stack.expr = &sym->rev_dep.expr;
1135 	sym2 = sym_check_expr_deps(sym->rev_dep.expr);
1136 	if (sym2)
1137 		goto out;
1138 
1139 	stack.expr = &sym->implied.expr;
1140 	sym2 = sym_check_expr_deps(sym->implied.expr);
1141 	if (sym2)
1142 		goto out;
1143 
1144 	stack.expr = NULL;
1145 
1146 	for (prop = sym->prop; prop; prop = prop->next) {
1147 		if (prop->type == P_CHOICE || prop->type == P_SELECT ||
1148 		    prop->type == P_IMPLY)
1149 			continue;
1150 		stack.prop = prop;
1151 		sym2 = sym_check_expr_deps(prop->visible.expr);
1152 		if (sym2)
1153 			break;
1154 		if (prop->type != P_DEFAULT || sym_is_choice(sym))
1155 			continue;
1156 		stack.expr = &prop->expr;
1157 		sym2 = sym_check_expr_deps(prop->expr);
1158 		if (sym2)
1159 			break;
1160 		stack.expr = NULL;
1161 	}
1162 
1163 out:
1164 	dep_stack_remove();
1165 
1166 	return sym2;
1167 }
1168 
1169 static struct symbol *sym_check_choice_deps(struct symbol *choice)
1170 {
1171 	struct symbol *sym, *sym2;
1172 	struct property *prop;
1173 	struct expr *e;
1174 	struct dep_stack stack;
1175 
1176 	dep_stack_insert(&stack, choice);
1177 
1178 	prop = sym_get_choice_prop(choice);
1179 	expr_list_for_each_sym(prop->expr, e, sym)
1180 		sym->flags |= (SYMBOL_CHECK | SYMBOL_CHECKED);
1181 
1182 	choice->flags |= (SYMBOL_CHECK | SYMBOL_CHECKED);
1183 	sym2 = sym_check_sym_deps(choice);
1184 	choice->flags &= ~SYMBOL_CHECK;
1185 	if (sym2)
1186 		goto out;
1187 
1188 	expr_list_for_each_sym(prop->expr, e, sym) {
1189 		sym2 = sym_check_sym_deps(sym);
1190 		if (sym2)
1191 			break;
1192 	}
1193 out:
1194 	expr_list_for_each_sym(prop->expr, e, sym)
1195 		sym->flags &= ~SYMBOL_CHECK;
1196 
1197 	if (sym2 && sym_is_choice_value(sym2) &&
1198 	    prop_get_symbol(sym_get_choice_prop(sym2)) == choice)
1199 		sym2 = choice;
1200 
1201 	dep_stack_remove();
1202 
1203 	return sym2;
1204 }
1205 
1206 struct symbol *sym_check_deps(struct symbol *sym)
1207 {
1208 	struct symbol *sym2;
1209 	struct property *prop;
1210 
1211 	if (sym->flags & SYMBOL_CHECK) {
1212 		sym_check_print_recursive(sym);
1213 		return sym;
1214 	}
1215 	if (sym->flags & SYMBOL_CHECKED)
1216 		return NULL;
1217 
1218 	if (sym_is_choice_value(sym)) {
1219 		struct dep_stack stack;
1220 
1221 		/* for choice groups start the check with main choice symbol */
1222 		dep_stack_insert(&stack, sym);
1223 		prop = sym_get_choice_prop(sym);
1224 		sym2 = sym_check_deps(prop_get_symbol(prop));
1225 		dep_stack_remove();
1226 	} else if (sym_is_choice(sym)) {
1227 		sym2 = sym_check_choice_deps(sym);
1228 	} else {
1229 		sym->flags |= (SYMBOL_CHECK | SYMBOL_CHECKED);
1230 		sym2 = sym_check_sym_deps(sym);
1231 		sym->flags &= ~SYMBOL_CHECK;
1232 	}
1233 
1234 	return sym2;
1235 }
1236 
1237 struct symbol *prop_get_symbol(struct property *prop)
1238 {
1239 	if (prop->expr && (prop->expr->type == E_SYMBOL ||
1240 			   prop->expr->type == E_LIST))
1241 		return prop->expr->left.sym;
1242 	return NULL;
1243 }
1244 
1245 const char *prop_get_type_name(enum prop_type type)
1246 {
1247 	switch (type) {
1248 	case P_PROMPT:
1249 		return "prompt";
1250 	case P_COMMENT:
1251 		return "comment";
1252 	case P_MENU:
1253 		return "menu";
1254 	case P_DEFAULT:
1255 		return "default";
1256 	case P_CHOICE:
1257 		return "choice";
1258 	case P_SELECT:
1259 		return "select";
1260 	case P_IMPLY:
1261 		return "imply";
1262 	case P_RANGE:
1263 		return "range";
1264 	case P_SYMBOL:
1265 		return "symbol";
1266 	case P_UNKNOWN:
1267 		break;
1268 	}
1269 	return "unknown";
1270 }
1271