util/kconfig/expr.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
   4  */
   5
   6 #ifndef EXPR_H
   7 #define EXPR_H
   8
   9 #ifdef __cplusplus
  10 extern "C" {
  11 #endif
  12
  13 #include <assert.h>
  14 #include <stdio.h>
  15 #include "list.h"
  16 #ifndef __cplusplus
  17 #include <stdbool.h>
  18 #endif
  19
  20 struct file {
  21         struct file *next;
  22         struct file *parent;
  23         const char *name;
  24         int lineno;
  25 };
  26
  27 typedef enum tristate {
  28         no, mod, yes
  29 } tristate;
  30
  31 enum expr_type {
  32         E_NONE, E_OR, E_AND, E_NOT,
  33         E_EQUAL, E_UNEQUAL, E_LTH, E_LEQ, E_GTH, E_GEQ,
  34         E_LIST, E_SYMBOL, E_RANGE
  35 };
  36
  37 union expr_data {
  38         struct expr *expr;
  39         struct symbol *sym;
  40 };
  41
  42 struct expr {
  43         enum expr_type type;
  44         union expr_data left, right;
  45 };
  46
  47 #define EXPR_OR(dep1, dep2)     (((dep1)>(dep2))?(dep1):(dep2))
  48 #define EXPR_AND(dep1, dep2)    (((dep1)<(dep2))?(dep1):(dep2))
  49 #define EXPR_NOT(dep)           (2-(dep))
  50
  51 #define expr_list_for_each_sym(l, e, s) \
  52         for (e = (l); e && (s = e->right.sym); e = e->left.expr)
  53
  54 struct expr_value {
  55         struct expr *expr;
  56         tristate tri;
  57 };
  58
  59 struct symbol_value {
  60         void *val;
  61         tristate tri;
  62 };
  63
  64 enum symbol_type {
  65         S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING
  66 };
  67
  68 /* enum values are used as index to symbol.def[] */
  69 enum {
  70         S_DEF_USER,             /* main user value */
  71         S_DEF_AUTO,             /* values read from auto.conf */
  72         S_DEF_DEF3,             /* Reserved for UI usage */
  73         S_DEF_DEF4,             /* Reserved for UI usage */
  74         S_DEF_COUNT
  75 };
  76
  77 /*
  78  * Represents a configuration symbol.
  79  *
  80  * Choices are represented as a special kind of symbol and have the
  81  * SYMBOL_CHOICE bit set in 'flags'.
  82  */
  83 struct symbol {
  84         /* The next symbol in the same bucket in the symbol hash table */
  85         struct symbol *next;
  86
  87         /* The name of the symbol, e.g. "FOO" for 'config FOO' */
  88         char *name;
  89
  90         /* S_BOOLEAN, S_TRISTATE, ... */
  91         enum symbol_type type;
  92
  93         /*
  94          * The calculated value of the symbol. The SYMBOL_VALID bit is set in
  95          * 'flags' when this is up to date. Note that this value might differ
  96          * from the user value set in e.g. a .config file, due to visibility.
  97          */
  98         struct symbol_value curr;
  99
 100         /*
 101          * Values for the symbol provided from outside. def[S_DEF_USER] holds
 102          * the .config value.
 103          */
 104         struct symbol_value def[S_DEF_COUNT];
 105
 106         /*
 107          * An upper bound on the tristate value the user can set for the symbol
 108          * if it is a boolean or tristate. Calculated from prompt dependencies,
 109          * which also inherit dependencies from enclosing menus, choices, and
 110          * ifs. If 'n', the user value will be ignored.
 111          *
 112          * Symbols lacking prompts always have visibility 'n'.
 113          */
 114         tristate visible;
 115
 116         /* SYMBOL_* flags */
 117         int flags;
 118
 119         /* List of properties. See prop_type. */
 120         struct property *prop;
 121
 122         /* Dependencies from enclosing menus, choices, and ifs */
 123         struct expr_value dir_dep;
 124
 125         /* Reverse dependencies through being selected by other symbols */
 126         struct expr_value rev_dep;
 127
 128         /*
 129          * "Weak" reverse dependencies through being implied by other symbols
 130          */
 131         struct expr_value implied;
 132 };
 133
 134 #define for_all_symbols(i, sym) for (i = 0; i < SYMBOL_HASHSIZE; i++) for (sym = symbol_hash[i]; sym; sym = sym->next)
 135
 136 #define SYMBOL_CONST      0x0001  /* symbol is const */
 137 #define SYMBOL_CHECK      0x0008  /* used during dependency checking */
 138 #define SYMBOL_CHOICE     0x0010  /* start of a choice block (null name) */
 139 #define SYMBOL_CHOICEVAL  0x0020  /* used as a value in a choice block */
 140 #define SYMBOL_VALID      0x0080  /* set when symbol.curr is calculated */
 141 #define SYMBOL_OPTIONAL   0x0100  /* choice is optional - values can be 'n' */
 142 #define SYMBOL_WRITE      0x0200  /* write symbol to file (KCONFIG_CONFIG) */
 143 #define SYMBOL_CHANGED    0x0400  /* ? */
 144 #define SYMBOL_WRITTEN    0x0800  /* track info to avoid double-write to .config */
 145 #define SYMBOL_NO_WRITE   0x1000  /* Symbol for internal use only; it will not be written */
 146 #define SYMBOL_CHECKED    0x2000  /* used during dependency checking */
 147 #define SYMBOL_WARNED     0x8000  /* warning has been issued */
 148
 149 /* Set when symbol.def[] is used */
 150 #define SYMBOL_DEF        0x10000  /* First bit of SYMBOL_DEF */
 151 #define SYMBOL_DEF_USER   0x10000  /* symbol.def[S_DEF_USER] is valid */
 152 #define SYMBOL_DEF_AUTO   0x20000  /* symbol.def[S_DEF_AUTO] is valid */
 153 #define SYMBOL_DEF3       0x40000  /* symbol.def[S_DEF_3] is valid */
 154 #define SYMBOL_DEF4       0x80000  /* symbol.def[S_DEF_4] is valid */
 155
 156 /* choice values need to be set before calculating this symbol value */
 157 #define SYMBOL_NEED_SET_CHOICE_VALUES  0x100000
 158
 159 #define SYMBOL_MAXLENGTH        256
 160 #define SYMBOL_HASHSIZE         9973
 161
 162 /* A property represent the config options that can be associated
 163  * with a config "symbol".
 164  * Sample:
 165  * config FOO
 166  *         default y
 167  *         prompt "foo prompt"
 168  *         select BAR
 169  * config BAZ
 170  *         int "BAZ Value"
 171  *         range 1..255
 172  *
 173  * Please, also check parser.y:print_symbol() when modifying the
 174  * list of property types!
 175  */
 176 enum prop_type {
 177         P_UNKNOWN,
 178         P_PROMPT,   /* prompt "foo prompt" or "BAZ Value" */
 179         P_COMMENT,  /* text associated with a comment */
 180         P_MENU,     /* prompt associated with a menu or menuconfig symbol */
 181         P_DEFAULT,  /* default y */
 182         P_CHOICE,   /* choice value */
 183         P_SELECT,   /* select BAR */
 184         P_IMPLY,    /* imply BAR */
 185         P_RANGE,    /* range 7..100 (for a symbol) */
 186         P_SYMBOL,   /* where a symbol is defined */
 187 };
 188
 189 struct property {
 190         struct property *next;     /* next property - null if last */
 191         enum prop_type type;       /* type of property */
 192         const char *text;          /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
 193         struct expr_value visible;
 194         struct expr *expr;         /* the optional conditional part of the property */
 195         struct menu *menu;         /* the menu the property are associated with
 196                                     * valid for: P_SELECT, P_RANGE, P_CHOICE,
 197                                     * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
 198         struct file *file;         /* what file was this property defined */
 199         int lineno;                /* what lineno was this property defined */
 200 };
 201
 202 #define for_all_properties(sym, st, tok) \
 203         for (st = sym->prop; st; st = st->next) \
 204                 if (st->type == (tok))
 205 #define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
 206 #define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE)
 207 #define for_all_prompts(sym, st) \
 208         for (st = sym->prop; st; st = st->next) \
 209                 if (st->text)
 210
 211 /*
 212  * Represents a node in the menu tree, as seen in e.g. menuconfig (though used
 213  * for all front ends). Each symbol, menu, etc. defined in the Kconfig files
 214  * gets a node. A symbol defined in multiple locations gets one node at each
 215  * location.
 216  */
 217 struct menu {
 218         /* The next menu node at the same level */
 219         struct menu *next;
 220
 221         /* The parent menu node, corresponding to e.g. a menu or choice */
 222         struct menu *parent;
 223
 224         /* The first child menu node, for e.g. menus and choices */
 225         struct menu *list;
 226
 227         /*
 228          * The symbol associated with the menu node. Choices are implemented as
 229          * a special kind of symbol. NULL for menus, comments, and ifs.
 230          */
 231         struct symbol *sym;
 232
 233         /*
 234          * The prompt associated with the node. This holds the prompt for a
 235          * symbol as well as the text for a menu or comment, along with the
 236          * type (P_PROMPT, P_MENU, etc.)
 237          */
 238         struct property *prompt;
 239
 240         /*
 241          * 'visible if' dependencies. If more than one is given, they will be
 242          * ANDed together.
 243          */
 244         struct expr *visibility;
 245
 246         /*
 247          * Ordinary dependencies from e.g. 'depends on' and 'if', ANDed
 248          * together
 249          */
 250         struct expr *dep;
 251
 252         /* MENU_* flags */
 253         unsigned int flags;
 254
 255         /* Any help text associated with the node */
 256         char *help;
 257
 258         /* The location where the menu node appears in the Kconfig files */
 259         struct file *file;
 260         int lineno;
 261
 262         /* For use by front ends that need to store auxiliary data */
 263         void *data;
 264 };
 265
 266 /*
 267  * Set on a menu node when the corresponding symbol changes state in some way.
 268  * Can be checked by front ends.
 269  */
 270 #define MENU_CHANGED            0x0001
 271
 272 #define MENU_ROOT               0x0002
 273
 274 struct jump_key {
 275         struct list_head entries;
 276         size_t offset;
 277         struct menu *target;
 278 };
 279
 280 extern struct file *file_list;
 281 extern struct file *current_file;
 282 struct file *lookup_file(const char *name);
 283
 284 extern struct symbol symbol_yes, symbol_no, symbol_mod;
 285 extern struct symbol *modules_sym;
 286 extern int cdebug;
 287 struct expr *expr_alloc_symbol(struct symbol *sym);
 288 struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
 289 struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
 290 struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
 291 struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
 292 struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
 293 struct expr *expr_copy(const struct expr *org);
 294 void expr_free(struct expr *e);
 295 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
 296 int expr_eq(struct expr *e1, struct expr *e2);
 297 tristate expr_calc_value(struct expr *e);
 298 struct expr *expr_trans_bool(struct expr *e);
 299 struct expr *expr_eliminate_dups(struct expr *e);
 300 struct expr *expr_transform(struct expr *e);
 301 int expr_contains_symbol(struct expr *dep, struct symbol *sym);
 302 bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
 303 struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
 304
 305 void expr_fprint(struct expr *e, FILE *out);
 306 struct gstr; /* forward */
 307 void expr_gstr_print(struct expr *e, struct gstr *gs);
 308 void expr_gstr_print_revdep(struct expr *e, struct gstr *gs,
 309                             tristate pr_type, const char *title);
 310
 311 static inline int expr_is_yes(struct expr *e)
 312 {
 313         return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
 314 }
 315
 316 static inline int expr_is_no(struct expr *e)
 317 {
 318         return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
 319 }
 320
 321 #ifdef __cplusplus
 322 }
 323 #endif
 324
 325 #endif /* EXPR_H */