init.c revision 1.146 1 /* $NetBSD: init.c,v 1.146 2021/03/28 08:30:22 rillig Exp $ */
2
3 /*
4 * Copyright (c) 1994, 1995 Jochen Pohl
5 * All Rights Reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Jochen Pohl for
18 * The NetBSD Project.
19 * 4. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #if HAVE_NBTOOL_CONFIG_H
35 #include "nbtool_config.h"
36 #endif
37
38 #include <sys/cdefs.h>
39 #if defined(__RCSID) && !defined(lint)
40 __RCSID("$NetBSD: init.c,v 1.146 2021/03/28 08:30:22 rillig Exp $");
41 #endif
42
43 #include <stdlib.h>
44 #include <string.h>
45
46 #include "lint1.h"
47
48
49 /*
50 * Initialization
51 *
52 * Handles initializations of global or local objects, like in:
53 *
54 * int number = 12345;
55 * int number_with_braces = { 12345 };
56 *
57 * int array_of_unknown_size[] = { 111, 222, 333 };
58 * int array_flat[2][2] = { 11, 12, 21, 22 };
59 * int array_nested[2][2] = { { 11, 12 }, { 21, 22 } };
60 *
61 * struct { int x, y; } point = { 3, 4 };
62 * struct { int x, y; } point = { .y = 4, .x = 3 };
63 *
64 * Any scalar expression in the initializer may be surrounded by arbitrarily
65 * many extra pairs of braces, like in the example 'number_with_braces' (C99
66 * 6.7.8p11).
67 *
68 * For multi-dimensional arrays, the inner braces may be omitted like in
69 * array_flat or spelled out like in array_nested.
70 *
71 * For the initializer, the grammar parser calls these functions:
72 *
73 * begin_initialization
74 * init_lbrace for each '{'
75 * designation_add_name for each '.member' before '='
76 * designation_add_subscript for each '[123]' before '='
77 * init_using_expr for each expression
78 * init_rbrace for each '}'
79 * end_initialization
80 *
81 * Each '{' begins a new brace level, each '}' ends the current brace level.
82 * Each brace level has an associated "current object".
83 *
84 * Most of the time, the topmost level of brace_level contains a scalar type,
85 * and its remaining count toggles between 1 and 0.
86 *
87 * See also:
88 * C99 6.7.8 "Initialization"
89 * d_c99_init.c for more examples
90 */
91
92
93 /*
94 * Describes a single brace level of an ongoing initialization.
95 *
96 * XXX: Since C99, the initializers can be listed in arbitrary order by using
97 * designators to specify the sub-object to be initialized. The member names
98 * of non-leaf structs may thus appear repeatedly, as demonstrated in
99 * d_init_pop_member.c.
100 *
101 * See C99 6.7.8, which spans 6 pages full of tricky details and carefully
102 * selected examples.
103 */
104 struct brace_level {
105
106 /*
107 * The type of the current object that is initialized at this brace
108 * level.
109 *
110 * On the outermost element, this is always NULL since the outermost
111 * initializer-expression may be enclosed in an optional pair of
112 * braces, as of the current implementation.
113 *
114 * FIXME: This approach is wrong. It's not that the outermost
115 * initializer may be enclosed in additional braces, it's every scalar
116 * that may be enclosed in additional braces, as of C99 6.7.8p11.
117 *
118 * Everywhere else it is nonnull.
119 */
120 type_t *bl_type;
121
122 /*
123 * The type that will be initialized at the next initialization level,
124 * usually enclosed by another pair of braces.
125 *
126 * For an array, it is the element type, but without 'const'.
127 *
128 * For a struct or union type, it is one of the member types, but
129 * without 'const'.
130 *
131 * The outermost stack element has no bl_type but nevertheless has
132 * bl_subtype. For example, in 'int var = { 12345 }', initially there
133 * is a brace_level with bl_subtype 'int'. When the '{' is processed,
134 * an element with bl_type 'int' is pushed to the stack. When the
135 * corresponding '}' is processed, the inner element is popped again.
136 *
137 * During initialization, only the top 2 elements of the stack are
138 * looked at.
139 *
140 * XXX: Having bl_subtype here is the wrong approach, it should not be
141 * necessary at all; see bl_type.
142 */
143 type_t *bl_subtype;
144
145 /*
146 * Whether this level of the initializer requires a '}' to be
147 * completed.
148 *
149 * Multidimensional arrays do not need a closing brace to complete
150 * an inner array; for example, { 1, 2, 3, 4 } is a valid initializer
151 * for 'int arr[2][2]'.
152 *
153 * XXX: Double-check whether this is the correct approach at all; see
154 * bl_type.
155 */
156 bool bl_brace: 1;
157
158 /* Whether bl_type is an array of unknown size. */
159 bool bl_array_of_unknown_size: 1;
160
161 /*
162 * XXX: This feels wrong. Whether or not there has been a named
163 * initializer (called 'designation' since C99) should not matter at
164 * all. Even after an initializer with designation, counting of the
165 * remaining elements continues, see C99 6.7.8p17.
166 */
167 bool bl_seen_named_member: 1;
168
169 /*
170 * For structs, the next member to be initialized by a designator-less
171 * initializer.
172 */
173 sym_t *bl_next_member;
174
175 /* TODO: Add bl_next_subscript for arrays. */
176
177 /* TODO: Understand C99 6.7.8p17 and footnote 128 for unions. */
178
179 /*
180 * The number of remaining elements to be used by expressions without
181 * designator.
182 *
183 * This says nothing about which members have been initialized or not
184 * since starting with C99, members may be initialized in arbitrary
185 * order by using designators.
186 *
187 * For an array of unknown size, this is always 0 and thus irrelevant.
188 *
189 * XXX: for scalars?
190 * XXX: for structs?
191 * XXX: for unions?
192 * XXX: for arrays?
193 *
194 * XXX: Having the count of remaining objects should not be necessary.
195 * It is probably clearer to use bl_next_member and bl_next_subscript
196 * for this purpose.
197 */
198 int bl_remaining;
199
200 /*
201 * The initialization state of the enclosing data structure
202 * (struct, union, array).
203 *
204 * XXX: Or for a scalar, for the top-level element, or for expressions
205 * in redundant braces such as '{{{{ 0 }}}}' (not yet implemented as
206 * of 2021-03-25).
207 */
208 struct brace_level *bl_enclosing;
209 };
210
211 /*
212 * A single component on the path to the sub-object that is initialized by an
213 * initializer expression. Either a struct or union member, or an array
214 * subscript.
215 *
216 * See also: C99 6.7.8 "Initialization"
217 */
218 struct designator {
219 const char *name; /* for struct and union */
220 /* TODO: add 'subscript' for arrays */
221 struct designator *next;
222 };
223
224 /*
225 * The optional designation for an initializer, saying which sub-object to
226 * initialize. Examples for designations are '.member' or
227 * '.member[123].member.member[1][1]'.
228 *
229 * See also: C99 6.7.8 "Initialization"
230 */
231 struct designation {
232 struct designator *head;
233 struct designator *tail;
234 };
235
236 struct initialization {
237 /*
238 * is set as soon as a fatal error occurred in the initialization.
239 * The effect is that the rest of the initialization is ignored
240 * (parsed by yacc, expression trees built, but no initialization
241 * takes place).
242 */
243 bool initerr;
244
245 /* The symbol that is to be initialized. */
246 sym_t *initsym;
247
248 /* The innermost brace level. */
249 struct brace_level *brace_level;
250
251 /*
252 * The C99 designator, if any, for the current initialization
253 * expression.
254 */
255 struct designation designation;
256
257 struct initialization *next;
258 };
259
260
261 static struct initialization *init;
262
263 #ifdef DEBUG
264 static int debug_ind = 0;
265 #endif
266
267
268 #ifdef DEBUG
269
270 static void __printflike(1, 2)
271 debug_printf(const char *fmt, ...)
272 {
273 va_list va;
274
275 va_start(va, fmt);
276 vfprintf(stdout, fmt, va);
277 va_end(va);
278 }
279
280 static void
281 debug_indent(void)
282 {
283 debug_printf("%*s", 2 * debug_ind, "");
284 }
285
286 static void
287 debug_enter(const char *func)
288 {
289 printf("%*s+ %s\n", 2 * debug_ind++, "", func);
290 }
291
292 static void __printflike(1, 2)
293 debug_step(const char *fmt, ...)
294 {
295 va_list va;
296
297 debug_indent();
298 va_start(va, fmt);
299 vfprintf(stdout, fmt, va);
300 va_end(va);
301 printf("\n");
302 }
303
304 static void
305 debug_leave(const char *func)
306 {
307 printf("%*s- %s\n", 2 * --debug_ind, "", func);
308 }
309
310 #else
311
312 #define debug_printf(fmt, ...) do { } while (false)
313 #define debug_indent() do { } while (false)
314 #define debug_enter(function) do { } while (false)
315 #define debug_step(fmt, ...) do { } while (false)
316 #define debug_leave(function) do { } while (false)
317
318 #endif
319
320
321 static struct designator *
322 designator_new(const char *name)
323 {
324 struct designator *d = xcalloc(1, sizeof *d);
325 d->name = name;
326 return d;
327 }
328
329 static void
330 designator_free(struct designator *d)
331 {
332 free(d);
333 }
334
335
336 #ifdef DEBUG
337 static void
338 designation_debug(const struct designation *dn)
339 {
340 const struct designator *p;
341
342 if (dn->head == NULL)
343 return;
344
345 debug_indent();
346 debug_printf("designation: ");
347 for (p = dn->head; p != NULL; p = p->next)
348 debug_printf(".%s", p->name);
349 debug_printf("\n");
350 }
351 #else
352 #define designation_debug(dn) do { } while (false)
353 #endif
354
355 static void
356 designation_add(struct designation *dn, struct designator *dr)
357 {
358
359 if (dn->head != NULL) {
360 dn->tail->next = dr;
361 dn->tail = dr;
362 } else {
363 dn->head = dr;
364 dn->tail = dr;
365 }
366
367 designation_debug(dn);
368 }
369
370 /* TODO: add support for array subscripts, not only named members */
371 /*
372 * TODO: This function should not be necessary at all. There is no need to
373 * remove the head of the list.
374 */
375 static void
376 designation_shift_level(struct designation *dn)
377 {
378 lint_assert(dn->head != NULL);
379
380 if (dn->head == dn->tail) {
381 designator_free(dn->head);
382 dn->head = NULL;
383 dn->tail = NULL;
384 } else {
385 struct designator *head = dn->head;
386 dn->head = dn->head->next;
387 designator_free(head);
388 }
389
390 designation_debug(dn);
391 }
392
393
394 #ifdef DEBUG
395 /*
396 * TODO: only log the top of the stack after each modifying operation
397 *
398 * TODO: wrap all write accesses to brace_level in setter functions
399 */
400 static void
401 brace_level_debug(const struct brace_level *level)
402 {
403 if (level->bl_type != NULL)
404 debug_printf("type '%s'", type_name(level->bl_type));
405 if (level->bl_type != NULL && level->bl_subtype != NULL)
406 debug_printf(", ");
407 if (level->bl_subtype != NULL)
408 debug_printf("subtype '%s'", type_name(level->bl_subtype));
409
410 if (level->bl_brace)
411 debug_printf(", needs closing brace");
412 if (level->bl_array_of_unknown_size)
413 debug_printf(", array of unknown size");
414 if (level->bl_seen_named_member)
415 debug_printf(", seen named member");
416
417 const type_t *eff_type = level->bl_type != NULL
418 ? level->bl_type : level->bl_subtype;
419 if (eff_type->t_tspec == STRUCT && level->bl_next_member != NULL)
420 debug_printf(", next member '%s'",
421 level->bl_next_member->s_name);
422
423 debug_printf(", remaining %d\n", level->bl_remaining);
424 }
425 #else
426 #define brace_level_debug(level) do { } while (false)
427 #endif
428
429
430 static struct initialization *
431 initialization_new(sym_t *sym)
432 {
433 struct initialization *in = xcalloc(1, sizeof(*in));
434
435 in->initsym = sym;
436
437 return in;
438 }
439
440 static void
441 initialization_free(struct initialization *in)
442 {
443 struct brace_level *level, *next;
444
445 for (level = in->brace_level; level != NULL; level = next) {
446 next = level->bl_enclosing;
447 free(level);
448 }
449
450 free(in);
451 }
452
453 #ifdef DEBUG
454 /*
455 * TODO: only call debug_initstack after each push/pop.
456 */
457 static void
458 initialization_debug(const struct initialization *in)
459 {
460 if (in->brace_level == NULL) {
461 debug_step("no brace level in the current initialization");
462 return;
463 }
464
465 size_t i = 0;
466 for (const struct brace_level *level = in->brace_level;
467 level != NULL; level = level->bl_enclosing) {
468 debug_indent();
469 debug_printf("brace level %zu: ", i);
470 brace_level_debug(level);
471 i++;
472 }
473 }
474 #else
475 #define initialization_debug(in) do { } while (false)
476 #endif
477
478 /* XXX: unnecessary prototype since it is not recursive */
479 static bool init_array_using_string(tnode_t *);
480
481
482 static struct initialization *
483 current_init(void)
484 {
485 lint_assert(init != NULL);
486 return init;
487 }
488
489 bool *
490 current_initerr(void)
491 {
492 return ¤t_init()->initerr;
493 }
494
495 sym_t **
496 current_initsym(void)
497 {
498 return ¤t_init()->initsym;
499 }
500
501 static struct designation *
502 current_designation_mod(void)
503 {
504 return ¤t_init()->designation;
505 }
506
507 static struct designation
508 current_designation(void)
509 {
510 return *current_designation_mod();
511 }
512
513 static const struct brace_level *
514 current_brace_level(void)
515 {
516 return current_init()->brace_level;
517 }
518
519 static struct brace_level **
520 current_brace_level_lvalue(void)
521 {
522 return ¤t_init()->brace_level;
523 }
524
525 static void
526 set_initerr(void)
527 {
528 current_init()->initerr = true;
529 }
530
531 #define initerr (*current_initerr())
532 #define initsym (*current_initsym())
533 #define brace_level_rvalue (current_brace_level())
534 #define brace_level_lvalue (*current_brace_level_lvalue())
535
536 #ifndef DEBUG
537
538 #define debug_designation() do { } while (false)
539 #define debug_brace_level(level) do { } while (false)
540 #define debug_initstack() do { } while (false)
541
542 #else
543
544
545 #define debug_enter() debug_enter(__func__)
546 #define debug_leave() debug_leave(__func__)
547
548 #endif
549
550
551 void
552 begin_initialization(sym_t *sym)
553 {
554 struct initialization *curr_init;
555
556 debug_step("begin initialization of '%s'", type_name(sym->s_type));
557 curr_init = initialization_new(sym);
558 curr_init->next = init;
559 init = curr_init;
560 }
561
562 void
563 end_initialization(void)
564 {
565 struct initialization *curr_init;
566
567 curr_init = init;
568 init = init->next;
569 initialization_free(curr_init);
570 debug_step("end initialization");
571 }
572
573
574
575 void
576 designation_add_name(sbuf_t *sb)
577 {
578 designation_add(current_designation_mod(),
579 designator_new(sb->sb_name));
580 }
581
582 /* TODO: Move the function body up here, to avoid the forward declaration. */
583 static void initstack_pop_nobrace(void);
584
585 static struct brace_level *
586 brace_level_new(type_t *type, type_t *subtype, int remaining)
587 {
588 struct brace_level *level = xcalloc(1, sizeof(*level));
589
590 level->bl_type = type;
591 level->bl_subtype = subtype;
592 level->bl_remaining = remaining;
593
594 return level;
595 }
596
597 static const sym_t *
598 brace_level_look_up_member(const char *name)
599 {
600 const type_t *tp = current_brace_level()->bl_type;
601 const sym_t *m;
602
603 lint_assert(tp->t_tspec == STRUCT || tp->t_tspec == UNION);
604
605 for (m = tp->t_str->sou_first_member; m != NULL; m = m->s_next) {
606 if (m->s_bitfield && m->s_name == unnamed)
607 continue;
608 if (strcmp(m->s_name, name) == 0)
609 return m;
610 }
611
612 return NULL;
613 }
614
615 static void
616 brace_level_set_array_dimension(int dim)
617 {
618 debug_step("setting the array size to %d", dim);
619 brace_level_lvalue->bl_type->t_dim = dim;
620 debug_indent();
621 brace_level_debug(brace_level_rvalue);
622 }
623
624 static void
625 brace_level_next_member(struct brace_level *level)
626 {
627 const sym_t *m;
628
629 do {
630 m = level->bl_next_member = level->bl_next_member->s_next;
631 /* XXX: can this assertion be made to fail? */
632 lint_assert(m != NULL);
633 } while (m->s_bitfield && m->s_name == unnamed);
634
635 debug_indent();
636 brace_level_debug(level);
637 }
638
639 /*
640 * A sub-object of an array is initialized using a designator. This does not
641 * have to be an array element directly, it can also be used to initialize
642 * only a sub-object of the array element.
643 *
644 * C99 example: struct { int member[4]; } var = { [2] = 12345 };
645 *
646 * GNU example: struct { int member[4]; } var = { [1 ... 3] = 12345 };
647 *
648 * TODO: test the following initialization with an outer and an inner type:
649 *
650 * .deeply[0].nested = {
651 * .deeply[1].nested = {
652 * 12345,
653 * },
654 * }
655 */
656 void
657 designation_add_subscript(range_t range)
658 {
659 struct brace_level *level;
660
661 debug_enter();
662 if (range.lo == range.hi)
663 debug_step("subscript is %zu", range.hi);
664 else
665 debug_step("subscript range is %zu ... %zu",
666 range.lo, range.hi);
667
668 initstack_pop_nobrace();
669
670 level = brace_level_lvalue;
671 if (level->bl_array_of_unknown_size) {
672 /* No +1 here, extend_if_array_of_unknown_size will add it. */
673 int auto_dim = (int)range.hi;
674 if (auto_dim > level->bl_type->t_dim)
675 brace_level_set_array_dimension(auto_dim);
676 }
677
678 debug_leave();
679 }
680
681
682 /*
683 * Initialize the initialization stack by putting an entry for the object
684 * which is to be initialized on it.
685 *
686 * TODO: merge into begin_initialization
687 */
688 void
689 initstack_init(void)
690 {
691
692 if (initerr)
693 return;
694
695 debug_enter();
696
697 /*
698 * If the type which is to be initialized is an incomplete array,
699 * it must be duplicated.
700 */
701 if (initsym->s_type->t_tspec == ARRAY && is_incomplete(initsym->s_type))
702 initsym->s_type = duptyp(initsym->s_type);
703 /* TODO: does 'duptyp' create a memory leak? */
704
705 brace_level_lvalue = brace_level_new(NULL, initsym->s_type, 1);
706
707 initialization_debug(current_init());
708 debug_leave();
709 }
710
711 /* TODO: document me */
712 static void
713 initstack_pop_item_named_member(const char *name)
714 {
715 struct brace_level *level = brace_level_lvalue;
716 const sym_t *m;
717
718 /*
719 * TODO: fix wording of the debug message; this doesn't seem to be
720 * related to initializing the named member.
721 */
722 debug_step("initializing named member '%s'", name);
723
724 if (level->bl_type->t_tspec != STRUCT &&
725 level->bl_type->t_tspec != UNION) {
726 /* syntax error '%s' */
727 error(249, "named member must only be used with struct/union");
728 set_initerr();
729 return;
730 }
731
732 m = brace_level_look_up_member(name);
733 if (m == NULL) {
734 /* TODO: add type information to the message */
735 /* undefined struct/union member: %s */
736 error(101, name);
737
738 designation_shift_level(current_designation_mod());
739 level->bl_seen_named_member = true;
740 return;
741 }
742
743 debug_step("found matching member");
744 level->bl_subtype = m->s_type;
745 /* XXX: why ++? */
746 level->bl_remaining++;
747 /* XXX: why is bl_seen_named_member not set? */
748 designation_shift_level(current_designation_mod());
749 }
750
751 /* TODO: think of a better name than 'pop' */
752 static void
753 initstack_pop_item_unnamed(void)
754 {
755 struct brace_level *level = brace_level_lvalue;
756
757 /*
758 * If the removed element was a structure member, we must go
759 * to the next structure member.
760 */
761 if (level->bl_remaining > 0 && level->bl_type->t_tspec == STRUCT &&
762 !level->bl_seen_named_member) {
763 brace_level_next_member(level);
764 level->bl_subtype = level->bl_next_member->s_type;
765 }
766 }
767
768 /* TODO: think of a better name than 'pop' */
769 static void
770 initstack_pop_item(void)
771 {
772 struct brace_level *level;
773 struct designator *first_designator;
774
775 debug_enter();
776
777 level = brace_level_lvalue;
778 debug_indent();
779 debug_printf("popping: ");
780 brace_level_debug(level);
781
782 brace_level_lvalue = level->bl_enclosing;
783 free(level);
784 level = brace_level_lvalue;
785 lint_assert(level != NULL);
786
787 level->bl_remaining--;
788 lint_assert(level->bl_remaining >= 0);
789 debug_step("%d elements remaining", level->bl_remaining);
790
791 first_designator = current_designation().head;
792 if (first_designator != NULL && first_designator->name != NULL)
793 initstack_pop_item_named_member(first_designator->name);
794 else
795 initstack_pop_item_unnamed();
796
797 initialization_debug(current_init());
798 debug_leave();
799 }
800
801 /*
802 * Take all entries, including the first which requires a closing brace,
803 * from the stack.
804 */
805 static void
806 initstack_pop_brace(void)
807 {
808 bool brace;
809
810 debug_enter();
811 initialization_debug(current_init());
812 do {
813 brace = brace_level_rvalue->bl_brace;
814 /* TODO: improve wording of the debug message */
815 debug_step("loop brace=%d", brace);
816 initstack_pop_item();
817 } while (!brace);
818 initialization_debug(current_init());
819 debug_leave();
820 }
821
822 /*
823 * Take all entries which cannot be used for further initializers from the
824 * stack, but do this only if they do not require a closing brace.
825 */
826 /* TODO: think of a better name than 'pop' */
827 static void
828 initstack_pop_nobrace(void)
829 {
830
831 debug_enter();
832 while (!brace_level_rvalue->bl_brace &&
833 brace_level_rvalue->bl_remaining == 0 &&
834 !brace_level_rvalue->bl_array_of_unknown_size)
835 initstack_pop_item();
836 debug_leave();
837 }
838
839 /* Extend an array of unknown size by one element */
840 static void
841 extend_if_array_of_unknown_size(void)
842 {
843 struct brace_level *level = brace_level_lvalue;
844
845 if (level->bl_remaining != 0)
846 return;
847 /*
848 * XXX: According to the function name, there should be a 'return' if
849 * bl_array_of_unknown_size is false. There's probably a test missing
850 * for that case.
851 */
852
853 /*
854 * The only place where an incomplete array may appear is at the
855 * outermost aggregate level of the object to be initialized.
856 */
857 lint_assert(level->bl_enclosing->bl_enclosing == NULL);
858 lint_assert(level->bl_type->t_tspec == ARRAY);
859
860 debug_step("extending array of unknown size '%s'",
861 type_name(level->bl_type));
862 level->bl_remaining = 1;
863 level->bl_type->t_dim++;
864 setcomplete(level->bl_type, true);
865
866 debug_step("extended type is '%s'", type_name(level->bl_type));
867 }
868
869 /* TODO: document me */
870 /* TODO: think of a better name than 'push' */
871 static void
872 initstack_push_array(void)
873 {
874 struct brace_level *level = brace_level_lvalue;
875
876 if (level->bl_enclosing->bl_seen_named_member) {
877 level->bl_brace = true;
878 debug_step("ARRAY%s%s",
879 level->bl_brace ? ", needs closing brace" : "",
880 /* TODO: this is redundant, always true */
881 level->bl_enclosing->bl_seen_named_member
882 ? ", seen named member" : "");
883 }
884
885 if (is_incomplete(level->bl_type) &&
886 level->bl_enclosing->bl_enclosing != NULL) {
887 /* initialization of an incomplete type */
888 error(175);
889 set_initerr();
890 return;
891 }
892
893 level->bl_subtype = level->bl_type->t_subt;
894 level->bl_array_of_unknown_size = is_incomplete(level->bl_type);
895 level->bl_remaining = level->bl_type->t_dim;
896 designation_debug(current_designation_mod());
897 debug_step("type '%s' remaining %d",
898 type_name(level->bl_type), level->bl_remaining);
899 }
900
901 static sym_t *
902 look_up_member(struct brace_level *level, int *count)
903 {
904 sym_t *m;
905
906 for (m = level->bl_type->t_str->sou_first_member;
907 m != NULL; m = m->s_next) {
908 if (m->s_bitfield && m->s_name == unnamed)
909 continue;
910 /*
911 * TODO: split into separate functions:
912 *
913 * look_up_array_next
914 * look_up_array_designator
915 * look_up_struct_next
916 * look_up_struct_designator
917 */
918 if (current_designation().head != NULL) {
919 /* XXX: this log entry looks unnecessarily verbose */
920 debug_step("have member '%s', want member '%s'",
921 m->s_name, current_designation().head->name);
922 if (strcmp(m->s_name,
923 current_designation().head->name) == 0) {
924 (*count)++;
925 break;
926 } else
927 continue;
928 }
929 if (++(*count) == 1) {
930 level->bl_next_member = m;
931 level->bl_subtype = m->s_type;
932 }
933 }
934
935 return m;
936 }
937
938 /* TODO: document me */
939 /* TODO: think of a better name than 'push' */
940 static bool
941 initstack_push_struct_or_union(void)
942 {
943 /*
944 * TODO: remove unnecessary 'const' for variables in functions that
945 * fit on a single screen. Keep it for larger functions.
946 */
947 struct brace_level *level = brace_level_lvalue;
948 int cnt;
949 sym_t *m;
950
951 if (is_incomplete(level->bl_type)) {
952 /* initialization of an incomplete type */
953 error(175);
954 set_initerr();
955 return false;
956 }
957
958 cnt = 0;
959 designation_debug(current_designation_mod());
960 debug_step("lookup for '%s'%s",
961 type_name(level->bl_type),
962 level->bl_seen_named_member ? ", seen named member" : "");
963
964 m = look_up_member(level, &cnt);
965
966 if (current_designation().head != NULL) {
967 if (m == NULL) {
968 debug_step("pop struct");
969 return true;
970 }
971 level->bl_next_member = m;
972 level->bl_subtype = m->s_type;
973 level->bl_seen_named_member = true;
974 debug_step("named member '%s'",
975 current_designation().head->name);
976 designation_shift_level(current_designation_mod());
977 cnt = level->bl_type->t_tspec == STRUCT ? 2 : 1;
978 }
979 level->bl_brace = true;
980 debug_step("unnamed element with type '%s'%s",
981 type_name(
982 level->bl_type != NULL ? level->bl_type : level->bl_subtype),
983 level->bl_brace ? ", needs closing brace" : "");
984 if (cnt == 0) {
985 /* cannot init. struct/union with no named member */
986 error(179);
987 set_initerr();
988 return false;
989 }
990 level->bl_remaining = level->bl_type->t_tspec == STRUCT ? cnt : 1;
991 return false;
992 }
993
994 /* TODO: document me */
995 /* TODO: think of a better name than 'push' */
996 static void
997 initstack_push(void)
998 {
999 struct brace_level *level, *enclosing;
1000
1001 debug_enter();
1002
1003 extend_if_array_of_unknown_size();
1004
1005 level = brace_level_lvalue;
1006 lint_assert(level->bl_remaining > 0);
1007 lint_assert(level->bl_type == NULL ||
1008 !is_scalar(level->bl_type->t_tspec));
1009
1010 brace_level_lvalue = xcalloc(1, sizeof *brace_level_lvalue);
1011 brace_level_lvalue->bl_enclosing = level;
1012 brace_level_lvalue->bl_type = level->bl_subtype;
1013 lint_assert(brace_level_lvalue->bl_type->t_tspec != FUNC);
1014
1015 again:
1016 level = brace_level_lvalue;
1017
1018 debug_step("expecting type '%s'", type_name(level->bl_type));
1019 lint_assert(level->bl_type != NULL);
1020 switch (level->bl_type->t_tspec) {
1021 case ARRAY:
1022 if (current_designation().head != NULL) {
1023 debug_step("pop array, named member '%s'%s",
1024 current_designation().head->name,
1025 level->bl_brace ? ", needs closing brace" : "");
1026 goto pop;
1027 }
1028
1029 initstack_push_array();
1030 break;
1031
1032 case UNION:
1033 if (tflag)
1034 /* initialization of union is illegal in trad. C */
1035 warning(238);
1036 /* FALLTHROUGH */
1037 case STRUCT:
1038 if (initstack_push_struct_or_union())
1039 goto pop;
1040 break;
1041 default:
1042 if (current_designation().head != NULL) {
1043 debug_step("pop scalar");
1044 pop:
1045 /* TODO: extract this into end_initializer_level */
1046 enclosing = brace_level_rvalue->bl_enclosing;
1047 free(level);
1048 brace_level_lvalue = enclosing;
1049 goto again;
1050 }
1051 /* The initialization stack now expects a single scalar. */
1052 level->bl_remaining = 1;
1053 break;
1054 }
1055
1056 initialization_debug(current_init());
1057 debug_leave();
1058 }
1059
1060 static void
1061 check_too_many_initializers(void)
1062 {
1063 const struct brace_level *level = brace_level_rvalue;
1064 if (level->bl_remaining > 0)
1065 return;
1066 /*
1067 * FIXME: even with named members, there can be too many initializers
1068 */
1069 if (level->bl_array_of_unknown_size || level->bl_seen_named_member)
1070 return;
1071
1072 tspec_t t = level->bl_type->t_tspec;
1073 if (t == ARRAY) {
1074 /* too many array initializers, expected %d */
1075 error(173, level->bl_type->t_dim);
1076 } else if (t == STRUCT || t == UNION) {
1077 /* too many struct/union initializers */
1078 error(172);
1079 } else {
1080 /* too many initializers */
1081 error(174);
1082 }
1083 set_initerr();
1084 }
1085
1086 /*
1087 * Process a '{' in an initializer by starting the initialization of the
1088 * nested data structure, with bl_type being the bl_subtype of the outer
1089 * initialization level.
1090 */
1091 static void
1092 initstack_next_brace(void)
1093 {
1094
1095 debug_enter();
1096 initialization_debug(current_init());
1097
1098 if (brace_level_rvalue->bl_type != NULL &&
1099 is_scalar(brace_level_rvalue->bl_type->t_tspec)) {
1100 /* invalid initializer type %s */
1101 error(176, type_name(brace_level_rvalue->bl_type));
1102 set_initerr();
1103 }
1104 if (!initerr)
1105 check_too_many_initializers();
1106 if (!initerr)
1107 initstack_push();
1108 if (!initerr) {
1109 brace_level_lvalue->bl_brace = true;
1110 designation_debug(current_designation_mod());
1111 debug_step("expecting type '%s'",
1112 type_name(brace_level_rvalue->bl_type != NULL
1113 ? brace_level_rvalue->bl_type
1114 : brace_level_rvalue->bl_subtype));
1115 }
1116
1117 initialization_debug(current_init());
1118 debug_leave();
1119 }
1120
1121 /* TODO: document me, or think of a better name */
1122 static void
1123 initstack_next_nobrace(tnode_t *tn)
1124 {
1125 debug_enter();
1126
1127 if (brace_level_rvalue->bl_type == NULL &&
1128 !is_scalar(brace_level_rvalue->bl_subtype->t_tspec)) {
1129 /* {}-enclosed initializer required */
1130 error(181);
1131 /* XXX: maybe set initerr here */
1132 }
1133
1134 if (!initerr)
1135 check_too_many_initializers();
1136
1137 while (!initerr) {
1138 struct brace_level *level = brace_level_lvalue;
1139
1140 if (tn->tn_type->t_tspec == STRUCT &&
1141 level->bl_type == tn->tn_type &&
1142 level->bl_enclosing != NULL &&
1143 level->bl_enclosing->bl_enclosing != NULL) {
1144 level->bl_brace = false;
1145 level->bl_remaining = 1; /* the struct itself */
1146 break;
1147 }
1148
1149 if (level->bl_type != NULL &&
1150 is_scalar(level->bl_type->t_tspec))
1151 break;
1152 initstack_push();
1153 }
1154
1155 initialization_debug(current_init());
1156 debug_leave();
1157 }
1158
1159 /* TODO: document me */
1160 void
1161 init_lbrace(void)
1162 {
1163 if (initerr)
1164 return;
1165
1166 debug_enter();
1167 initialization_debug(current_init());
1168
1169 if ((initsym->s_scl == AUTO || initsym->s_scl == REG) &&
1170 brace_level_rvalue->bl_enclosing == NULL) {
1171 if (tflag &&
1172 !is_scalar(brace_level_rvalue->bl_subtype->t_tspec))
1173 /* no automatic aggregate initialization in trad. C */
1174 warning(188);
1175 }
1176
1177 /*
1178 * Remove all entries which cannot be used for further initializers
1179 * and do not expect a closing brace.
1180 */
1181 initstack_pop_nobrace();
1182
1183 initstack_next_brace();
1184
1185 initialization_debug(current_init());
1186 debug_leave();
1187 }
1188
1189 /*
1190 * Process a '}' in an initializer by finishing the current level of the
1191 * initialization stack.
1192 */
1193 void
1194 init_rbrace(void)
1195 {
1196 if (initerr)
1197 return;
1198
1199 debug_enter();
1200 initstack_pop_brace();
1201 debug_leave();
1202 }
1203
1204 /* In traditional C, bit-fields can be initialized only by integer constants. */
1205 static void
1206 check_bit_field_init(const tnode_t *ln, tspec_t lt, tspec_t rt)
1207 {
1208 if (tflag &&
1209 is_integer(lt) &&
1210 ln->tn_type->t_bitfield &&
1211 !is_integer(rt)) {
1212 /* bit-field initialization is illegal in traditional C */
1213 warning(186);
1214 }
1215 }
1216
1217 static void
1218 check_non_constant_initializer(const tnode_t *tn, scl_t sclass)
1219 {
1220 /* TODO: rename CON to CONSTANT to avoid ambiguity with CONVERT */
1221 if (tn == NULL || tn->tn_op == CON)
1222 return;
1223
1224 sym_t *sym;
1225 ptrdiff_t offs;
1226 if (constant_addr(tn, &sym, &offs))
1227 return;
1228
1229 if (sclass == AUTO || sclass == REG) {
1230 /* non-constant initializer */
1231 c99ism(177);
1232 } else {
1233 /* non-constant initializer */
1234 error(177);
1235 }
1236 }
1237
1238 /*
1239 * Initialize a non-array object with automatic storage duration and only a
1240 * single initializer expression without braces by delegating to ASSIGN.
1241 */
1242 static bool
1243 init_using_assign(tnode_t *rn)
1244 {
1245 tnode_t *ln, *tn;
1246
1247 if (initsym->s_type->t_tspec == ARRAY)
1248 return false;
1249 if (brace_level_rvalue->bl_enclosing != NULL)
1250 return false;
1251
1252 debug_step("handing over to ASSIGN");
1253
1254 ln = new_name_node(initsym, 0);
1255 ln->tn_type = tduptyp(ln->tn_type);
1256 ln->tn_type->t_const = false;
1257
1258 tn = build(ASSIGN, ln, rn);
1259 expr(tn, false, false, false, false);
1260
1261 /* XXX: why not clean up the initstack here already? */
1262 return true;
1263 }
1264
1265 static void
1266 check_init_expr(tnode_t *tn, scl_t sclass)
1267 {
1268 tnode_t *ln;
1269 tspec_t lt, rt;
1270 struct mbl *tmem;
1271
1272 /* Create a temporary node for the left side. */
1273 ln = tgetblk(sizeof *ln);
1274 ln->tn_op = NAME;
1275 ln->tn_type = tduptyp(brace_level_rvalue->bl_type);
1276 ln->tn_type->t_const = false;
1277 ln->tn_lvalue = true;
1278 ln->tn_sym = initsym; /* better than nothing */
1279
1280 tn = cconv(tn);
1281
1282 lt = ln->tn_type->t_tspec;
1283 rt = tn->tn_type->t_tspec;
1284
1285 debug_step("typeok '%s', '%s'",
1286 type_name(ln->tn_type), type_name(tn->tn_type));
1287 if (!typeok(INIT, 0, ln, tn))
1288 return;
1289
1290 /*
1291 * Preserve the tree memory. This is necessary because otherwise
1292 * expr() would free it.
1293 */
1294 tmem = tsave();
1295 expr(tn, true, false, true, false);
1296 trestor(tmem);
1297
1298 check_bit_field_init(ln, lt, rt);
1299
1300 /*
1301 * XXX: Is it correct to do this conversion _after_ the typeok above?
1302 */
1303 if (lt != rt ||
1304 (brace_level_rvalue->bl_type->t_bitfield && tn->tn_op == CON))
1305 tn = convert(INIT, 0, brace_level_rvalue->bl_type, tn);
1306
1307 check_non_constant_initializer(tn, sclass);
1308 }
1309
1310 void
1311 init_using_expr(tnode_t *tn)
1312 {
1313 scl_t sclass;
1314
1315 debug_enter();
1316 initialization_debug(current_init());
1317 designation_debug(current_designation_mod());
1318 debug_step("expr:");
1319 debug_node(tn, debug_ind + 1);
1320
1321 if (initerr || tn == NULL)
1322 goto done;
1323
1324 sclass = initsym->s_scl;
1325 if ((sclass == AUTO || sclass == REG) && init_using_assign(tn))
1326 goto done;
1327
1328 initstack_pop_nobrace();
1329
1330 if (init_array_using_string(tn)) {
1331 debug_step("after initializing the string:");
1332 /* XXX: why not clean up the initstack here already? */
1333 goto done_initstack;
1334 }
1335
1336 initstack_next_nobrace(tn);
1337 if (initerr || tn == NULL)
1338 goto done_initstack;
1339
1340 brace_level_lvalue->bl_remaining--;
1341 debug_step("%d elements remaining", brace_level_rvalue->bl_remaining);
1342
1343 check_init_expr(tn, sclass);
1344
1345 done_initstack:
1346 initialization_debug(current_init());
1347
1348 done:
1349 while (current_designation().head != NULL)
1350 designation_shift_level(current_designation_mod());
1351
1352 debug_leave();
1353 }
1354
1355
1356 /* Initialize a character array or wchar_t array with a string literal. */
1357 static bool
1358 init_array_using_string(tnode_t *tn)
1359 {
1360 tspec_t t;
1361 struct brace_level *level;
1362 int len;
1363 strg_t *strg;
1364
1365 if (tn->tn_op != STRING)
1366 return false;
1367
1368 debug_enter();
1369 initialization_debug(current_init());
1370
1371 level = brace_level_lvalue;
1372 strg = tn->tn_string;
1373
1374 /*
1375 * Check if we have an array type which can be initialized by
1376 * the string.
1377 */
1378 if (level->bl_subtype != NULL && level->bl_subtype->t_tspec == ARRAY) {
1379 debug_step("subt array");
1380 t = level->bl_subtype->t_subt->t_tspec;
1381 if (!((strg->st_tspec == CHAR &&
1382 (t == CHAR || t == UCHAR || t == SCHAR)) ||
1383 (strg->st_tspec == WCHAR && t == WCHAR))) {
1384 debug_leave();
1385 return false;
1386 }
1387 /* XXX: duplicate code, see below */
1388
1389 /* Put the array at top of stack */
1390 initstack_push();
1391 level = brace_level_lvalue;
1392
1393 /* TODO: what if both bl_type and bl_subtype are ARRAY? */
1394
1395 } else if (level->bl_type != NULL && level->bl_type->t_tspec == ARRAY) {
1396 debug_step("type array");
1397 t = level->bl_type->t_subt->t_tspec;
1398 if (!((strg->st_tspec == CHAR &&
1399 (t == CHAR || t == UCHAR || t == SCHAR)) ||
1400 (strg->st_tspec == WCHAR && t == WCHAR))) {
1401 debug_leave();
1402 return false;
1403 }
1404 /* XXX: duplicate code, see above */
1405
1406 /*
1407 * TODO: is this really not needed in the branch above this
1408 * one?
1409 */
1410 /*
1411 * If the array is already partly initialized, we are
1412 * wrong here.
1413 */
1414 if (level->bl_remaining != level->bl_type->t_dim) {
1415 debug_leave();
1416 return false;
1417 }
1418 } else {
1419 debug_leave();
1420 return false;
1421 }
1422
1423 /* Get length without trailing NUL character. */
1424 len = strg->st_len;
1425
1426 if (level->bl_array_of_unknown_size) {
1427 level->bl_array_of_unknown_size = false;
1428 level->bl_type->t_dim = len + 1;
1429 setcomplete(level->bl_type, true);
1430 } else {
1431 /*
1432 * TODO: check for buffer overflow in the object to be
1433 * initialized
1434 */
1435 /* XXX: double-check for off-by-one error */
1436 if (level->bl_type->t_dim < len) {
1437 /* non-null byte ignored in string initializer */
1438 warning(187);
1439 }
1440
1441 /*
1442 * TODO: C99 6.7.8p14 allows a string literal to be enclosed
1443 * in optional redundant braces, just like scalars. Add tests
1444 * for this.
1445 */
1446 }
1447
1448 /* In every case the array is initialized completely. */
1449 level->bl_remaining = 0;
1450
1451 initialization_debug(current_init());
1452 debug_leave();
1453 return true;
1454 }
1455