compiler: rationalize external symbol names
[official-gcc.git] / gcc / go / gofrontend / gogo.cc
blob83be6176ae7e04e63aed9585b0a548f96f07f8a6
1 // gogo.cc -- Go frontend parsed representation.
3 // Copyright 2009 The Go Authors. All rights reserved.
4 // Use of this source code is governed by a BSD-style
5 // license that can be found in the LICENSE file.
7 #include "go-system.h"
9 #include <fstream>
11 #include "filenames.h"
13 #include "go-c.h"
14 #include "go-diagnostics.h"
15 #include "go-encode-id.h"
16 #include "go-dump.h"
17 #include "go-optimize.h"
18 #include "lex.h"
19 #include "types.h"
20 #include "statements.h"
21 #include "expressions.h"
22 #include "runtime.h"
23 #include "import.h"
24 #include "export.h"
25 #include "backend.h"
26 #include "gogo.h"
28 // Class Gogo.
30 Gogo::Gogo(Backend* backend, Linemap* linemap, int, int pointer_size)
31 : backend_(backend),
32 linemap_(linemap),
33 package_(NULL),
34 functions_(),
35 globals_(new Bindings(NULL)),
36 file_block_names_(),
37 imports_(),
38 imported_unsafe_(false),
39 current_file_imported_unsafe_(false),
40 packages_(),
41 init_functions_(),
42 var_deps_(),
43 need_init_fn_(false),
44 init_fn_name_(),
45 imported_init_fns_(),
46 pkgpath_(),
47 pkgpath_symbol_(),
48 prefix_(),
49 pkgpath_set_(false),
50 pkgpath_from_option_(false),
51 prefix_from_option_(false),
52 relative_import_path_(),
53 c_header_(),
54 check_divide_by_zero_(true),
55 check_divide_overflow_(true),
56 compiling_runtime_(false),
57 debug_escape_level_(0),
58 nil_check_size_threshold_(4096),
59 verify_types_(),
60 interface_types_(),
61 specific_type_functions_(),
62 specific_type_functions_are_written_(false),
63 named_types_are_converted_(false),
64 analysis_sets_(),
65 gc_roots_()
67 const Location loc = Linemap::predeclared_location();
69 Named_type* uint8_type = Type::make_integer_type("uint8", true, 8,
70 RUNTIME_TYPE_KIND_UINT8);
71 this->add_named_type(uint8_type);
72 this->add_named_type(Type::make_integer_type("uint16", true, 16,
73 RUNTIME_TYPE_KIND_UINT16));
74 this->add_named_type(Type::make_integer_type("uint32", true, 32,
75 RUNTIME_TYPE_KIND_UINT32));
76 this->add_named_type(Type::make_integer_type("uint64", true, 64,
77 RUNTIME_TYPE_KIND_UINT64));
79 this->add_named_type(Type::make_integer_type("int8", false, 8,
80 RUNTIME_TYPE_KIND_INT8));
81 this->add_named_type(Type::make_integer_type("int16", false, 16,
82 RUNTIME_TYPE_KIND_INT16));
83 Named_type* int32_type = Type::make_integer_type("int32", false, 32,
84 RUNTIME_TYPE_KIND_INT32);
85 this->add_named_type(int32_type);
86 this->add_named_type(Type::make_integer_type("int64", false, 64,
87 RUNTIME_TYPE_KIND_INT64));
89 this->add_named_type(Type::make_float_type("float32", 32,
90 RUNTIME_TYPE_KIND_FLOAT32));
91 this->add_named_type(Type::make_float_type("float64", 64,
92 RUNTIME_TYPE_KIND_FLOAT64));
94 this->add_named_type(Type::make_complex_type("complex64", 64,
95 RUNTIME_TYPE_KIND_COMPLEX64));
96 this->add_named_type(Type::make_complex_type("complex128", 128,
97 RUNTIME_TYPE_KIND_COMPLEX128));
99 int int_type_size = pointer_size;
100 if (int_type_size < 32)
101 int_type_size = 32;
102 this->add_named_type(Type::make_integer_type("uint", true,
103 int_type_size,
104 RUNTIME_TYPE_KIND_UINT));
105 Named_type* int_type = Type::make_integer_type("int", false, int_type_size,
106 RUNTIME_TYPE_KIND_INT);
107 this->add_named_type(int_type);
109 this->add_named_type(Type::make_integer_type("uintptr", true,
110 pointer_size,
111 RUNTIME_TYPE_KIND_UINTPTR));
113 // "byte" is an alias for "uint8".
114 uint8_type->integer_type()->set_is_byte();
115 Named_object* byte_type = Named_object::make_type("byte", NULL, uint8_type,
116 loc);
117 byte_type->type_value()->set_is_alias();
118 this->add_named_type(byte_type->type_value());
120 // "rune" is an alias for "int32".
121 int32_type->integer_type()->set_is_rune();
122 Named_object* rune_type = Named_object::make_type("rune", NULL, int32_type,
123 loc);
124 rune_type->type_value()->set_is_alias();
125 this->add_named_type(rune_type->type_value());
127 this->add_named_type(Type::make_named_bool_type());
129 this->add_named_type(Type::make_named_string_type());
131 // "error" is interface { Error() string }.
133 Typed_identifier_list *methods = new Typed_identifier_list;
134 Typed_identifier_list *results = new Typed_identifier_list;
135 results->push_back(Typed_identifier("", Type::lookup_string_type(), loc));
136 Type *method_type = Type::make_function_type(NULL, NULL, results, loc);
137 methods->push_back(Typed_identifier("Error", method_type, loc));
138 Interface_type *error_iface = Type::make_interface_type(methods, loc);
139 error_iface->finalize_methods();
140 Named_type *error_type = Named_object::make_type("error", NULL, error_iface, loc)->type_value();
141 this->add_named_type(error_type);
144 this->globals_->add_constant(Typed_identifier("true",
145 Type::make_boolean_type(),
146 loc),
147 NULL,
148 Expression::make_boolean(true, loc),
150 this->globals_->add_constant(Typed_identifier("false",
151 Type::make_boolean_type(),
152 loc),
153 NULL,
154 Expression::make_boolean(false, loc),
157 this->globals_->add_constant(Typed_identifier("nil", Type::make_nil_type(),
158 loc),
159 NULL,
160 Expression::make_nil(loc),
163 Type* abstract_int_type = Type::make_abstract_integer_type();
164 this->globals_->add_constant(Typed_identifier("iota", abstract_int_type,
165 loc),
166 NULL,
167 Expression::make_iota(),
170 Function_type* new_type = Type::make_function_type(NULL, NULL, NULL, loc);
171 new_type->set_is_varargs();
172 new_type->set_is_builtin();
173 this->globals_->add_function_declaration("new", NULL, new_type, loc);
175 Function_type* make_type = Type::make_function_type(NULL, NULL, NULL, loc);
176 make_type->set_is_varargs();
177 make_type->set_is_builtin();
178 this->globals_->add_function_declaration("make", NULL, make_type, loc);
180 Typed_identifier_list* len_result = new Typed_identifier_list();
181 len_result->push_back(Typed_identifier("", int_type, loc));
182 Function_type* len_type = Type::make_function_type(NULL, NULL, len_result,
183 loc);
184 len_type->set_is_builtin();
185 this->globals_->add_function_declaration("len", NULL, len_type, loc);
187 Typed_identifier_list* cap_result = new Typed_identifier_list();
188 cap_result->push_back(Typed_identifier("", int_type, loc));
189 Function_type* cap_type = Type::make_function_type(NULL, NULL, len_result,
190 loc);
191 cap_type->set_is_builtin();
192 this->globals_->add_function_declaration("cap", NULL, cap_type, loc);
194 Function_type* print_type = Type::make_function_type(NULL, NULL, NULL, loc);
195 print_type->set_is_varargs();
196 print_type->set_is_builtin();
197 this->globals_->add_function_declaration("print", NULL, print_type, loc);
199 print_type = Type::make_function_type(NULL, NULL, NULL, loc);
200 print_type->set_is_varargs();
201 print_type->set_is_builtin();
202 this->globals_->add_function_declaration("println", NULL, print_type, loc);
204 Type *empty = Type::make_empty_interface_type(loc);
205 Typed_identifier_list* panic_parms = new Typed_identifier_list();
206 panic_parms->push_back(Typed_identifier("e", empty, loc));
207 Function_type *panic_type = Type::make_function_type(NULL, panic_parms,
208 NULL, loc);
209 panic_type->set_is_builtin();
210 this->globals_->add_function_declaration("panic", NULL, panic_type, loc);
212 Typed_identifier_list* recover_result = new Typed_identifier_list();
213 recover_result->push_back(Typed_identifier("", empty, loc));
214 Function_type* recover_type = Type::make_function_type(NULL, NULL,
215 recover_result,
216 loc);
217 recover_type->set_is_builtin();
218 this->globals_->add_function_declaration("recover", NULL, recover_type, loc);
220 Function_type* close_type = Type::make_function_type(NULL, NULL, NULL, loc);
221 close_type->set_is_varargs();
222 close_type->set_is_builtin();
223 this->globals_->add_function_declaration("close", NULL, close_type, loc);
225 Typed_identifier_list* copy_result = new Typed_identifier_list();
226 copy_result->push_back(Typed_identifier("", int_type, loc));
227 Function_type* copy_type = Type::make_function_type(NULL, NULL,
228 copy_result, loc);
229 copy_type->set_is_varargs();
230 copy_type->set_is_builtin();
231 this->globals_->add_function_declaration("copy", NULL, copy_type, loc);
233 Function_type* append_type = Type::make_function_type(NULL, NULL, NULL, loc);
234 append_type->set_is_varargs();
235 append_type->set_is_builtin();
236 this->globals_->add_function_declaration("append", NULL, append_type, loc);
238 Function_type* complex_type = Type::make_function_type(NULL, NULL, NULL, loc);
239 complex_type->set_is_varargs();
240 complex_type->set_is_builtin();
241 this->globals_->add_function_declaration("complex", NULL, complex_type, loc);
243 Function_type* real_type = Type::make_function_type(NULL, NULL, NULL, loc);
244 real_type->set_is_varargs();
245 real_type->set_is_builtin();
246 this->globals_->add_function_declaration("real", NULL, real_type, loc);
248 Function_type* imag_type = Type::make_function_type(NULL, NULL, NULL, loc);
249 imag_type->set_is_varargs();
250 imag_type->set_is_builtin();
251 this->globals_->add_function_declaration("imag", NULL, imag_type, loc);
253 Function_type* delete_type = Type::make_function_type(NULL, NULL, NULL, loc);
254 delete_type->set_is_varargs();
255 delete_type->set_is_builtin();
256 this->globals_->add_function_declaration("delete", NULL, delete_type, loc);
259 // Convert a pkgpath into a string suitable for a symbol. Note that
260 // this transformation is convenient but imperfect. A -fgo-pkgpath
261 // option of a/b_c will conflict with a -fgo-pkgpath option of a_b/c,
262 // possibly leading to link time errors.
264 std::string
265 Gogo::pkgpath_for_symbol(const std::string& pkgpath)
267 std::string s = pkgpath;
268 for (size_t i = 0; i < s.length(); ++i)
270 char c = s[i];
271 if ((c >= 'a' && c <= 'z')
272 || (c >= 'A' && c <= 'Z')
273 || (c >= '0' && c <= '9'))
275 else
276 s[i] = '_';
278 return s;
281 // Get the package path to use for type reflection data. This should
282 // ideally be unique across the entire link.
284 const std::string&
285 Gogo::pkgpath() const
287 go_assert(this->pkgpath_set_);
288 return this->pkgpath_;
291 // Set the package path from the -fgo-pkgpath command line option.
293 void
294 Gogo::set_pkgpath(const std::string& arg)
296 go_assert(!this->pkgpath_set_);
297 this->pkgpath_ = arg;
298 this->pkgpath_set_ = true;
299 this->pkgpath_from_option_ = true;
302 // Get the package path to use for symbol names.
304 const std::string&
305 Gogo::pkgpath_symbol() const
307 go_assert(this->pkgpath_set_);
308 return this->pkgpath_symbol_;
311 // Set the unique prefix to use to determine the package path, from
312 // the -fgo-prefix command line option.
314 void
315 Gogo::set_prefix(const std::string& arg)
317 go_assert(!this->prefix_from_option_);
318 this->prefix_ = arg;
319 this->prefix_from_option_ = true;
322 // Munge name for use in an error message.
324 std::string
325 Gogo::message_name(const std::string& name)
327 return go_localize_identifier(Gogo::unpack_hidden_name(name).c_str());
330 // Get the package name.
332 const std::string&
333 Gogo::package_name() const
335 go_assert(this->package_ != NULL);
336 return this->package_->package_name();
339 // Set the package name.
341 void
342 Gogo::set_package_name(const std::string& package_name,
343 Location location)
345 if (this->package_ != NULL)
347 if (this->package_->package_name() != package_name)
348 go_error_at(location, "expected package %<%s%>",
349 Gogo::message_name(this->package_->package_name()).c_str());
350 return;
353 // Now that we know the name of the package we are compiling, set
354 // the package path to use for reflect.Type.PkgPath and global
355 // symbol names.
356 if (this->pkgpath_set_)
357 this->pkgpath_symbol_ = Gogo::pkgpath_for_symbol(this->pkgpath_);
358 else
360 if (!this->prefix_from_option_ && package_name == "main")
362 this->pkgpath_ = package_name;
363 this->pkgpath_symbol_ = Gogo::pkgpath_for_symbol(package_name);
365 else
367 if (!this->prefix_from_option_)
368 this->prefix_ = "go";
369 this->pkgpath_ = this->prefix_ + '.' + package_name;
370 this->pkgpath_symbol_ = (Gogo::pkgpath_for_symbol(this->prefix_) + '.'
371 + Gogo::pkgpath_for_symbol(package_name));
373 this->pkgpath_set_ = true;
376 this->package_ = this->register_package(this->pkgpath_,
377 this->pkgpath_symbol_, location);
378 this->package_->set_package_name(package_name, location);
380 if (this->is_main_package())
382 // Declare "main" as a function which takes no parameters and
383 // returns no value.
384 Location uloc = Linemap::unknown_location();
385 this->declare_function(Gogo::pack_hidden_name("main", false),
386 Type::make_function_type (NULL, NULL, NULL, uloc),
387 uloc);
391 // Return whether this is the "main" package. This is not true if
392 // -fgo-pkgpath or -fgo-prefix was used.
394 bool
395 Gogo::is_main_package() const
397 return (this->package_name() == "main"
398 && !this->pkgpath_from_option_
399 && !this->prefix_from_option_);
402 // Import a package.
404 void
405 Gogo::import_package(const std::string& filename,
406 const std::string& local_name,
407 bool is_local_name_exported,
408 bool must_exist,
409 Location location)
411 if (filename.empty())
413 go_error_at(location, "import path is empty");
414 return;
417 const char *pf = filename.data();
418 const char *pend = pf + filename.length();
419 while (pf < pend)
421 unsigned int c;
422 int adv = Lex::fetch_char(pf, &c);
423 if (adv == 0)
425 go_error_at(location, "import path contains invalid UTF-8 sequence");
426 return;
428 if (c == '\0')
430 go_error_at(location, "import path contains NUL");
431 return;
433 if (c < 0x20 || c == 0x7f)
435 go_error_at(location, "import path contains control character");
436 return;
438 if (c == '\\')
440 go_error_at(location, "import path contains backslash; use slash");
441 return;
443 if (Lex::is_unicode_space(c))
445 go_error_at(location, "import path contains space character");
446 return;
448 if (c < 0x7f && strchr("!\"#$%&'()*,:;<=>?[]^`{|}", c) != NULL)
450 go_error_at(location,
451 "import path contains invalid character '%c'", c);
452 return;
454 pf += adv;
457 if (IS_ABSOLUTE_PATH(filename.c_str()))
459 go_error_at(location, "import path cannot be absolute path");
460 return;
463 if (local_name == "init")
464 go_error_at(location, "cannot import package as init");
466 if (filename == "unsafe")
468 this->import_unsafe(local_name, is_local_name_exported, location);
469 this->current_file_imported_unsafe_ = true;
470 return;
473 Imports::const_iterator p = this->imports_.find(filename);
474 if (p != this->imports_.end())
476 Package* package = p->second;
477 package->set_location(location);
478 std::string ln = local_name;
479 bool is_ln_exported = is_local_name_exported;
480 if (ln.empty())
482 ln = package->package_name();
483 go_assert(!ln.empty());
484 is_ln_exported = Lex::is_exported_name(ln);
486 if (ln == "_")
488 else if (ln == ".")
490 Bindings* bindings = package->bindings();
491 for (Bindings::const_declarations_iterator p =
492 bindings->begin_declarations();
493 p != bindings->end_declarations();
494 ++p)
495 this->add_dot_import_object(p->second);
496 std::string dot_alias = "." + package->package_name();
497 package->add_alias(dot_alias, location);
499 else
501 package->add_alias(ln, location);
502 ln = this->pack_hidden_name(ln, is_ln_exported);
503 this->package_->bindings()->add_package(ln, package);
505 return;
508 Import::Stream* stream = Import::open_package(filename, location,
509 this->relative_import_path_);
510 if (stream == NULL)
512 if (must_exist)
513 go_error_at(location, "import file %qs not found", filename.c_str());
514 return;
517 Import imp(stream, location);
518 imp.register_builtin_types(this);
519 Package* package = imp.import(this, local_name, is_local_name_exported);
520 if (package != NULL)
522 if (package->pkgpath() == this->pkgpath())
523 go_error_at(location,
524 ("imported package uses same package path as package "
525 "being compiled (see -fgo-pkgpath option)"));
527 this->imports_.insert(std::make_pair(filename, package));
530 delete stream;
533 Import_init *
534 Gogo::lookup_init(const std::string& init_name)
536 Import_init tmp("", init_name, -1);
537 Import_init_set::iterator it = this->imported_init_fns_.find(&tmp);
538 return (it != this->imported_init_fns_.end()) ? *it : NULL;
541 // Add an import control function for an imported package to the list.
543 void
544 Gogo::add_import_init_fn(const std::string& package_name,
545 const std::string& init_name, int prio)
547 for (Import_init_set::iterator p =
548 this->imported_init_fns_.begin();
549 p != this->imported_init_fns_.end();
550 ++p)
552 Import_init *ii = (*p);
553 if (ii->init_name() == init_name)
555 // If a test of package P1, built as part of package P1,
556 // imports package P2, and P2 imports P1 (perhaps
557 // indirectly), then we will see the same import name with
558 // different import priorities. That is OK, so don't give
559 // an error about it.
560 if (ii->package_name() != package_name)
562 go_error_at(Linemap::unknown_location(),
563 "duplicate package initialization name %qs",
564 Gogo::message_name(init_name).c_str());
565 go_inform(Linemap::unknown_location(), "used by package %qs",
566 Gogo::message_name(ii->package_name()).c_str());
567 go_inform(Linemap::unknown_location(), " and by package %qs",
568 Gogo::message_name(package_name).c_str());
570 ii->set_priority(prio);
571 return;
575 Import_init* nii = new Import_init(package_name, init_name, prio);
576 this->imported_init_fns_.insert(nii);
579 // Return whether we are at the global binding level.
581 bool
582 Gogo::in_global_scope() const
584 return this->functions_.empty();
587 // Return the current binding contour.
589 Bindings*
590 Gogo::current_bindings()
592 if (!this->functions_.empty())
593 return this->functions_.back().blocks.back()->bindings();
594 else if (this->package_ != NULL)
595 return this->package_->bindings();
596 else
597 return this->globals_;
600 const Bindings*
601 Gogo::current_bindings() const
603 if (!this->functions_.empty())
604 return this->functions_.back().blocks.back()->bindings();
605 else if (this->package_ != NULL)
606 return this->package_->bindings();
607 else
608 return this->globals_;
611 void
612 Gogo::update_init_priority(Import_init* ii,
613 std::set<const Import_init *>* visited)
615 visited->insert(ii);
616 int succ_prior = -1;
618 for (std::set<std::string>::const_iterator pci =
619 ii->precursors().begin();
620 pci != ii->precursors().end();
621 ++pci)
623 Import_init* succ = this->lookup_init(*pci);
624 if (visited->find(succ) == visited->end())
625 update_init_priority(succ, visited);
626 succ_prior = std::max(succ_prior, succ->priority());
628 if (ii->priority() <= succ_prior)
629 ii->set_priority(succ_prior + 1);
632 void
633 Gogo::recompute_init_priorities()
635 std::set<Import_init *> nonroots;
637 for (Import_init_set::const_iterator p =
638 this->imported_init_fns_.begin();
639 p != this->imported_init_fns_.end();
640 ++p)
642 const Import_init *ii = *p;
643 for (std::set<std::string>::const_iterator pci =
644 ii->precursors().begin();
645 pci != ii->precursors().end();
646 ++pci)
648 Import_init* ii = this->lookup_init(*pci);
649 nonroots.insert(ii);
653 // Recursively update priorities starting at roots.
654 std::set<const Import_init*> visited;
655 for (Import_init_set::iterator p =
656 this->imported_init_fns_.begin();
657 p != this->imported_init_fns_.end();
658 ++p)
660 Import_init* ii = *p;
661 if (nonroots.find(ii) != nonroots.end())
662 continue;
663 update_init_priority(ii, &visited);
667 // Add statements to INIT_STMTS which run the initialization
668 // functions for imported packages. This is only used for the "main"
669 // package.
671 void
672 Gogo::init_imports(std::vector<Bstatement*>& init_stmts, Bfunction *bfunction)
674 go_assert(this->is_main_package());
676 if (this->imported_init_fns_.empty())
677 return;
679 Location unknown_loc = Linemap::unknown_location();
680 Function_type* func_type =
681 Type::make_function_type(NULL, NULL, NULL, unknown_loc);
682 Btype* fntype = func_type->get_backend_fntype(this);
684 // Recompute init priorities based on a walk of the init graph.
685 recompute_init_priorities();
687 // We must call them in increasing priority order.
688 std::vector<const Import_init*> v;
689 for (Import_init_set::const_iterator p =
690 this->imported_init_fns_.begin();
691 p != this->imported_init_fns_.end();
692 ++p)
694 if ((*p)->priority() < 0)
695 go_error_at(Linemap::unknown_location(),
696 "internal error: failed to set init priority for %s",
697 (*p)->package_name().c_str());
698 v.push_back(*p);
700 std::sort(v.begin(), v.end(), priority_compare);
702 // We build calls to the init functions, which take no arguments.
703 std::vector<Bexpression*> empty_args;
704 for (std::vector<const Import_init*>::const_iterator p = v.begin();
705 p != v.end();
706 ++p)
708 const Import_init* ii = *p;
709 std::string user_name = ii->package_name() + ".init";
710 const std::string& init_name(ii->init_name());
712 Bfunction* pfunc = this->backend()->function(fntype, user_name, init_name,
713 true, true, true, false,
714 false, false, unknown_loc);
715 Bexpression* pfunc_code =
716 this->backend()->function_code_expression(pfunc, unknown_loc);
717 Bexpression* pfunc_call =
718 this->backend()->call_expression(bfunction, pfunc_code, empty_args,
719 NULL, unknown_loc);
720 init_stmts.push_back(this->backend()->expression_statement(bfunction,
721 pfunc_call));
725 // Register global variables with the garbage collector. We need to
726 // register all variables which can hold a pointer value. They become
727 // roots during the mark phase. We build a struct that is easy to
728 // hook into a list of roots.
730 // type gcRoot struct {
731 // decl unsafe.Pointer // Pointer to variable.
732 // size uintptr // Total size of variable.
733 // ptrdata uintptr // Length of variable's gcdata.
734 // gcdata *byte // Pointer mask.
735 // }
737 // type gcRootList struct {
738 // next *gcRootList
739 // count int
740 // roots [...]gcRoot
741 // }
743 // The last entry in the roots array has a NULL decl field.
745 void
746 Gogo::register_gc_vars(const std::vector<Named_object*>& var_gc,
747 std::vector<Bstatement*>& init_stmts,
748 Bfunction* init_bfn)
750 if (var_gc.empty() && this->gc_roots_.empty())
751 return;
753 Type* pvt = Type::make_pointer_type(Type::make_void_type());
754 Type* uintptr_type = Type::lookup_integer_type("uintptr");
755 Type* byte_type = this->lookup_global("byte")->type_value();
756 Type* pointer_byte_type = Type::make_pointer_type(byte_type);
757 Struct_type* root_type =
758 Type::make_builtin_struct_type(4,
759 "decl", pvt,
760 "size", uintptr_type,
761 "ptrdata", uintptr_type,
762 "gcdata", pointer_byte_type);
764 Location builtin_loc = Linemap::predeclared_location();
765 unsigned long roots_len = var_gc.size() + this->gc_roots_.size();
766 Expression* length = Expression::make_integer_ul(roots_len, NULL,
767 builtin_loc);
768 Array_type* root_array_type = Type::make_array_type(root_type, length);
769 root_array_type->set_is_array_incomparable();
771 Type* int_type = Type::lookup_integer_type("int");
772 Struct_type* root_list_type =
773 Type::make_builtin_struct_type(3,
774 "next", pvt,
775 "count", int_type,
776 "roots", root_array_type);
778 // Build an initializer for the roots array.
780 Expression_list* roots_init = new Expression_list();
782 for (std::vector<Named_object*>::const_iterator p = var_gc.begin();
783 p != var_gc.end();
784 ++p)
786 Expression_list* init = new Expression_list();
788 Location no_loc = (*p)->location();
789 Expression* decl = Expression::make_var_reference(*p, no_loc);
790 Expression* decl_addr =
791 Expression::make_unary(OPERATOR_AND, decl, no_loc);
792 decl_addr->unary_expression()->set_does_not_escape();
793 decl_addr = Expression::make_cast(pvt, decl_addr, no_loc);
794 init->push_back(decl_addr);
796 Expression* size =
797 Expression::make_type_info(decl->type(),
798 Expression::TYPE_INFO_SIZE);
799 init->push_back(size);
801 Expression* ptrdata =
802 Expression::make_type_info(decl->type(),
803 Expression::TYPE_INFO_BACKEND_PTRDATA);
804 init->push_back(ptrdata);
806 Expression* gcdata = Expression::make_ptrmask_symbol(decl->type());
807 init->push_back(gcdata);
809 Expression* root_ctor =
810 Expression::make_struct_composite_literal(root_type, init, no_loc);
811 roots_init->push_back(root_ctor);
814 for (std::vector<Expression*>::const_iterator p = this->gc_roots_.begin();
815 p != this->gc_roots_.end();
816 ++p)
818 Expression_list *init = new Expression_list();
820 Expression* expr = *p;
821 Location eloc = expr->location();
822 init->push_back(Expression::make_cast(pvt, expr, eloc));
824 Type* type = expr->type()->points_to();
825 go_assert(type != NULL);
827 Expression* size =
828 Expression::make_type_info(type,
829 Expression::TYPE_INFO_SIZE);
830 init->push_back(size);
832 Expression* ptrdata =
833 Expression::make_type_info(type,
834 Expression::TYPE_INFO_BACKEND_PTRDATA);
835 init->push_back(ptrdata);
837 Expression* gcdata = Expression::make_ptrmask_symbol(type);
838 init->push_back(gcdata);
840 Expression* root_ctor =
841 Expression::make_struct_composite_literal(root_type, init, eloc);
842 roots_init->push_back(root_ctor);
845 // Build a constructor for the struct.
847 Expression_list* root_list_init = new Expression_list();
848 root_list_init->push_back(Expression::make_nil(builtin_loc));
849 root_list_init->push_back(Expression::make_integer_ul(roots_len, int_type,
850 builtin_loc));
852 Expression* roots_ctor =
853 Expression::make_array_composite_literal(root_array_type, roots_init,
854 builtin_loc);
855 root_list_init->push_back(roots_ctor);
857 Expression* root_list_ctor =
858 Expression::make_struct_composite_literal(root_list_type, root_list_init,
859 builtin_loc);
861 Expression* root_addr = Expression::make_unary(OPERATOR_AND, root_list_ctor,
862 builtin_loc);
863 root_addr->unary_expression()->set_is_gc_root();
864 Expression* register_roots = Runtime::make_call(Runtime::REGISTER_GC_ROOTS,
865 builtin_loc, 1, root_addr);
867 Translate_context context(this, NULL, NULL, NULL);
868 Bexpression* bcall = register_roots->get_backend(&context);
869 init_stmts.push_back(this->backend()->expression_statement(init_bfn, bcall));
872 // Build the decl for the initialization function.
874 Named_object*
875 Gogo::initialization_function_decl()
877 std::string name = this->get_init_fn_name();
878 Location loc = this->package_->location();
880 Function_type* fntype = Type::make_function_type(NULL, NULL, NULL, loc);
881 Function* initfn = new Function(fntype, NULL, NULL, loc);
882 return Named_object::make_function(name, NULL, initfn);
885 // Create the magic initialization function. CODE_STMT is the
886 // code that it needs to run.
888 Named_object*
889 Gogo::create_initialization_function(Named_object* initfn,
890 Bstatement* code_stmt)
892 // Make sure that we thought we needed an initialization function,
893 // as otherwise we will not have reported it in the export data.
894 go_assert(this->is_main_package() || this->need_init_fn_);
896 if (initfn == NULL)
897 initfn = this->initialization_function_decl();
899 // Bind the initialization function code to a block.
900 Bfunction* fndecl = initfn->func_value()->get_or_make_decl(this, initfn);
901 Location pkg_loc = this->package_->location();
902 std::vector<Bvariable*> vars;
903 this->backend()->block(fndecl, NULL, vars, pkg_loc, pkg_loc);
905 if (!this->backend()->function_set_body(fndecl, code_stmt))
907 go_assert(saw_errors());
908 return NULL;
910 return initfn;
913 // Search for references to VAR in any statements or called functions.
915 class Find_var : public Traverse
917 public:
918 // A hash table we use to avoid looping. The index is the name of a
919 // named object. We only look through objects defined in this
920 // package.
921 typedef Unordered_set(const void*) Seen_objects;
923 Find_var(Named_object* var, Seen_objects* seen_objects)
924 : Traverse(traverse_expressions),
925 var_(var), seen_objects_(seen_objects), found_(false)
928 // Whether the variable was found.
929 bool
930 found() const
931 { return this->found_; }
934 expression(Expression**);
936 private:
937 // The variable we are looking for.
938 Named_object* var_;
939 // Names of objects we have already seen.
940 Seen_objects* seen_objects_;
941 // True if the variable was found.
942 bool found_;
945 // See if EXPR refers to VAR, looking through function calls and
946 // variable initializations.
949 Find_var::expression(Expression** pexpr)
951 Expression* e = *pexpr;
953 Var_expression* ve = e->var_expression();
954 if (ve != NULL)
956 Named_object* v = ve->named_object();
957 if (v == this->var_)
959 this->found_ = true;
960 return TRAVERSE_EXIT;
963 if (v->is_variable() && v->package() == NULL)
965 Expression* init = v->var_value()->init();
966 if (init != NULL)
968 std::pair<Seen_objects::iterator, bool> ins =
969 this->seen_objects_->insert(v);
970 if (ins.second)
972 // This is the first time we have seen this name.
973 if (Expression::traverse(&init, this) == TRAVERSE_EXIT)
974 return TRAVERSE_EXIT;
980 // We traverse the code of any function or bound method we see. Note that
981 // this means that we will traverse the code of a function or bound method
982 // whose address is taken even if it is not called.
983 Func_expression* fe = e->func_expression();
984 Bound_method_expression* bme = e->bound_method_expression();
985 if (fe != NULL || bme != NULL)
987 const Named_object* f = fe != NULL ? fe->named_object() : bme->function();
988 if (f->is_function() && f->package() == NULL)
990 std::pair<Seen_objects::iterator, bool> ins =
991 this->seen_objects_->insert(f);
992 if (ins.second)
994 // This is the first time we have seen this name.
995 if (f->func_value()->block()->traverse(this) == TRAVERSE_EXIT)
996 return TRAVERSE_EXIT;
1001 Temporary_reference_expression* tre = e->temporary_reference_expression();
1002 if (tre != NULL)
1004 Temporary_statement* ts = tre->statement();
1005 Expression* init = ts->init();
1006 if (init != NULL)
1008 std::pair<Seen_objects::iterator, bool> ins =
1009 this->seen_objects_->insert(ts);
1010 if (ins.second)
1012 // This is the first time we have seen this temporary
1013 // statement.
1014 if (Expression::traverse(&init, this) == TRAVERSE_EXIT)
1015 return TRAVERSE_EXIT;
1020 return TRAVERSE_CONTINUE;
1023 // Return true if EXPR, PREINIT, or DEP refers to VAR.
1025 static bool
1026 expression_requires(Expression* expr, Block* preinit, Named_object* dep,
1027 Named_object* var)
1029 Find_var::Seen_objects seen_objects;
1030 Find_var find_var(var, &seen_objects);
1031 if (expr != NULL)
1032 Expression::traverse(&expr, &find_var);
1033 if (preinit != NULL)
1034 preinit->traverse(&find_var);
1035 if (dep != NULL)
1037 Expression* init = dep->var_value()->init();
1038 if (init != NULL)
1039 Expression::traverse(&init, &find_var);
1040 if (dep->var_value()->has_pre_init())
1041 dep->var_value()->preinit()->traverse(&find_var);
1044 return find_var.found();
1047 // Sort variable initializations. If the initialization expression
1048 // for variable A refers directly or indirectly to the initialization
1049 // expression for variable B, then we must initialize B before A.
1051 class Var_init
1053 public:
1054 Var_init()
1055 : var_(NULL), init_(NULL), dep_count_(0)
1058 Var_init(Named_object* var, Bstatement* init)
1059 : var_(var), init_(init), dep_count_(0)
1062 // Return the variable.
1063 Named_object*
1064 var() const
1065 { return this->var_; }
1067 // Return the initialization expression.
1068 Bstatement*
1069 init() const
1070 { return this->init_; }
1072 // Return the number of remaining dependencies.
1073 size_t
1074 dep_count() const
1075 { return this->dep_count_; }
1077 // Increment the number of dependencies.
1078 void
1079 add_dependency()
1080 { ++this->dep_count_; }
1082 // Decrement the number of dependencies.
1083 void
1084 remove_dependency()
1085 { --this->dep_count_; }
1087 private:
1088 // The variable being initialized.
1089 Named_object* var_;
1090 // The initialization statement.
1091 Bstatement* init_;
1092 // The number of initializations this is dependent on. A variable
1093 // initialization should not be emitted if any of its dependencies
1094 // have not yet been resolved.
1095 size_t dep_count_;
1098 // For comparing Var_init keys in a map.
1100 inline bool
1101 operator<(const Var_init& v1, const Var_init& v2)
1102 { return v1.var()->name() < v2.var()->name(); }
1104 typedef std::list<Var_init> Var_inits;
1106 // Sort the variable initializations. The rule we follow is that we
1107 // emit them in the order they appear in the array, except that if the
1108 // initialization expression for a variable V1 depends upon another
1109 // variable V2 then we initialize V1 after V2.
1111 static void
1112 sort_var_inits(Gogo* gogo, Var_inits* var_inits)
1114 if (var_inits->empty())
1115 return;
1117 typedef std::pair<Named_object*, Named_object*> No_no;
1118 typedef std::map<No_no, bool> Cache;
1119 Cache cache;
1121 // A mapping from a variable initialization to a set of
1122 // variable initializations that depend on it.
1123 typedef std::map<Var_init, std::set<Var_init*> > Init_deps;
1124 Init_deps init_deps;
1125 bool init_loop = false;
1126 for (Var_inits::iterator p1 = var_inits->begin();
1127 p1 != var_inits->end();
1128 ++p1)
1130 Named_object* var = p1->var();
1131 Expression* init = var->var_value()->init();
1132 Block* preinit = var->var_value()->preinit();
1133 Named_object* dep = gogo->var_depends_on(var->var_value());
1135 // Start walking through the list to see which variables VAR
1136 // needs to wait for.
1137 for (Var_inits::iterator p2 = var_inits->begin();
1138 p2 != var_inits->end();
1139 ++p2)
1141 if (var == p2->var())
1142 continue;
1144 Named_object* p2var = p2->var();
1145 No_no key(var, p2var);
1146 std::pair<Cache::iterator, bool> ins =
1147 cache.insert(std::make_pair(key, false));
1148 if (ins.second)
1149 ins.first->second = expression_requires(init, preinit, dep, p2var);
1150 if (ins.first->second)
1152 // VAR depends on P2VAR.
1153 init_deps[*p2].insert(&(*p1));
1154 p1->add_dependency();
1156 // Check for cycles.
1157 key = std::make_pair(p2var, var);
1158 ins = cache.insert(std::make_pair(key, false));
1159 if (ins.second)
1160 ins.first->second =
1161 expression_requires(p2var->var_value()->init(),
1162 p2var->var_value()->preinit(),
1163 gogo->var_depends_on(p2var->var_value()),
1164 var);
1165 if (ins.first->second)
1167 go_error_at(var->location(),
1168 ("initialization expressions for %qs and "
1169 "%qs depend upon each other"),
1170 var->message_name().c_str(),
1171 p2var->message_name().c_str());
1172 go_inform(p2->var()->location(), "%qs defined here",
1173 p2var->message_name().c_str());
1174 init_loop = true;
1175 break;
1181 // If there are no dependencies then the declaration order is sorted.
1182 if (!init_deps.empty() && !init_loop)
1184 // Otherwise, sort variable initializations by emitting all variables with
1185 // no dependencies in declaration order. VAR_INITS is already in
1186 // declaration order.
1187 Var_inits ready;
1188 while (!var_inits->empty())
1190 Var_inits::iterator v1;;
1191 for (v1 = var_inits->begin(); v1 != var_inits->end(); ++v1)
1193 if (v1->dep_count() == 0)
1194 break;
1196 go_assert(v1 != var_inits->end());
1198 // V1 either has no dependencies or its dependencies have already
1199 // been emitted, add it to READY next. When V1 is emitted, remove
1200 // a dependency from each V that depends on V1.
1201 ready.splice(ready.end(), *var_inits, v1);
1203 Init_deps::iterator p1 = init_deps.find(*v1);
1204 if (p1 != init_deps.end())
1206 std::set<Var_init*> resolved = p1->second;
1207 for (std::set<Var_init*>::iterator pv = resolved.begin();
1208 pv != resolved.end();
1209 ++pv)
1210 (*pv)->remove_dependency();
1211 init_deps.erase(p1);
1214 var_inits->swap(ready);
1215 go_assert(init_deps.empty());
1218 // VAR_INITS is in the correct order. For each VAR in VAR_INITS,
1219 // check for a loop of VAR on itself.
1220 // interpret as a loop.
1221 for (Var_inits::const_iterator p = var_inits->begin();
1222 p != var_inits->end();
1223 ++p)
1224 gogo->check_self_dep(p->var());
1227 // Give an error if the initialization expression for VAR depends on
1228 // itself. We only check if INIT is not NULL and there is no
1229 // dependency; when INIT is NULL, it means that PREINIT sets VAR,
1230 // which we will interpret as a loop.
1232 void
1233 Gogo::check_self_dep(Named_object* var)
1235 Expression* init = var->var_value()->init();
1236 Block* preinit = var->var_value()->preinit();
1237 Named_object* dep = this->var_depends_on(var->var_value());
1238 if (init != NULL
1239 && dep == NULL
1240 && expression_requires(init, preinit, NULL, var))
1241 go_error_at(var->location(),
1242 "initialization expression for %qs depends upon itself",
1243 var->message_name().c_str());
1246 // Write out the global definitions.
1248 void
1249 Gogo::write_globals()
1251 this->build_interface_method_tables();
1253 Bindings* bindings = this->current_bindings();
1255 for (Bindings::const_declarations_iterator p = bindings->begin_declarations();
1256 p != bindings->end_declarations();
1257 ++p)
1259 // If any function declarations needed a descriptor, make sure
1260 // we build it.
1261 Named_object* no = p->second;
1262 if (no->is_function_declaration())
1263 no->func_declaration_value()->build_backend_descriptor(this);
1266 // Lists of globally declared types, variables, constants, and functions
1267 // that must be defined.
1268 std::vector<Btype*> type_decls;
1269 std::vector<Bvariable*> var_decls;
1270 std::vector<Bexpression*> const_decls;
1271 std::vector<Bfunction*> func_decls;
1273 // The init function declaration and associated Bfunction, if necessary.
1274 Named_object* init_fndecl = NULL;
1275 Bfunction* init_bfn = NULL;
1277 std::vector<Bstatement*> init_stmts;
1278 std::vector<Bstatement*> var_init_stmts;
1280 if (this->is_main_package())
1282 init_fndecl = this->initialization_function_decl();
1283 init_bfn = init_fndecl->func_value()->get_or_make_decl(this, init_fndecl);
1284 this->init_imports(init_stmts, init_bfn);
1287 // A list of variable initializations.
1288 Var_inits var_inits;
1290 // A list of variables which need to be registered with the garbage
1291 // collector.
1292 size_t count_definitions = bindings->size_definitions();
1293 std::vector<Named_object*> var_gc;
1294 var_gc.reserve(count_definitions);
1296 for (Bindings::const_definitions_iterator p = bindings->begin_definitions();
1297 p != bindings->end_definitions();
1298 ++p)
1300 Named_object* no = *p;
1301 go_assert(!no->is_type_declaration() && !no->is_function_declaration());
1303 // There is nothing to do for a package.
1304 if (no->is_package())
1305 continue;
1307 // There is nothing to do for an object which was imported from
1308 // a different package into the global scope.
1309 if (no->package() != NULL)
1310 continue;
1312 // Skip blank named functions and constants.
1313 if ((no->is_function() && no->func_value()->is_sink())
1314 || (no->is_const() && no->const_value()->is_sink()))
1315 continue;
1317 // There is nothing useful we can output for constants which
1318 // have ideal or non-integral type.
1319 if (no->is_const())
1321 Type* type = no->const_value()->type();
1322 if (type == NULL)
1323 type = no->const_value()->expr()->type();
1324 if (type->is_abstract() || !type->is_numeric_type())
1325 continue;
1328 if (!no->is_variable())
1329 no->get_backend(this, const_decls, type_decls, func_decls);
1330 else
1332 Variable* var = no->var_value();
1333 Bvariable* bvar = no->get_backend_variable(this, NULL);
1334 var_decls.push_back(bvar);
1336 // Check for a sink variable, which may be used to run an
1337 // initializer purely for its side effects.
1338 bool is_sink = no->name()[0] == '_' && no->name()[1] == '.';
1340 Bstatement* var_init_stmt = NULL;
1341 if (!var->has_pre_init())
1343 // If the backend representation of the variable initializer is
1344 // constant, we can just set the initial value using
1345 // global_var_set_init instead of during the init() function.
1346 // The initializer is constant if it is the zero-value of the
1347 // variable's type or if the initial value is an immutable value
1348 // that is not copied to the heap.
1349 bool is_static_initializer = false;
1350 if (var->init() == NULL)
1351 is_static_initializer = true;
1352 else
1354 Type* var_type = var->type();
1355 Expression* init = var->init();
1356 Expression* init_cast =
1357 Expression::make_cast(var_type, init, var->location());
1358 is_static_initializer = init_cast->is_static_initializer();
1361 // Non-constant variable initializations might need to create
1362 // temporary variables, which will need the initialization
1363 // function as context.
1364 Named_object* var_init_fn;
1365 if (is_static_initializer)
1366 var_init_fn = NULL;
1367 else
1369 if (init_fndecl == NULL)
1371 init_fndecl = this->initialization_function_decl();
1372 Function* func = init_fndecl->func_value();
1373 init_bfn = func->get_or_make_decl(this, init_fndecl);
1375 var_init_fn = init_fndecl;
1377 Bexpression* var_binit = var->get_init(this, var_init_fn);
1379 if (var_binit == NULL)
1381 else if (is_static_initializer)
1383 if (expression_requires(var->init(), NULL,
1384 this->var_depends_on(var), no))
1385 go_error_at(no->location(),
1386 "initialization expression for %qs depends "
1387 "upon itself",
1388 no->message_name().c_str());
1389 this->backend()->global_variable_set_init(bvar, var_binit);
1391 else if (is_sink)
1392 var_init_stmt =
1393 this->backend()->expression_statement(init_bfn, var_binit);
1394 else
1396 Location loc = var->location();
1397 Bexpression* var_expr =
1398 this->backend()->var_expression(bvar, loc);
1399 var_init_stmt =
1400 this->backend()->assignment_statement(init_bfn, var_expr,
1401 var_binit, loc);
1404 else
1406 // We are going to create temporary variables which
1407 // means that we need an fndecl.
1408 if (init_fndecl == NULL)
1409 init_fndecl = this->initialization_function_decl();
1411 Bvariable* var_decl = is_sink ? NULL : bvar;
1412 var_init_stmt = var->get_init_block(this, init_fndecl, var_decl);
1415 if (var_init_stmt != NULL)
1417 if (var->init() == NULL && !var->has_pre_init())
1418 var_init_stmts.push_back(var_init_stmt);
1419 else
1420 var_inits.push_back(Var_init(no, var_init_stmt));
1422 else if (this->var_depends_on(var) != NULL)
1424 // This variable is initialized from something that is
1425 // not in its init or preinit. This variable needs to
1426 // participate in dependency analysis sorting, in case
1427 // some other variable depends on this one.
1428 Btype* btype = no->var_value()->type()->get_backend(this);
1429 Bexpression* zero = this->backend()->zero_expression(btype);
1430 Bstatement* zero_stmt =
1431 this->backend()->expression_statement(init_bfn, zero);
1432 var_inits.push_back(Var_init(no, zero_stmt));
1435 // Collect a list of all global variables with pointers,
1436 // to register them for the garbage collector.
1437 if (!is_sink && var->type()->has_pointer())
1439 // Avoid putting runtime.gcRoots itself on the list.
1440 if (this->compiling_runtime()
1441 && this->package_name() == "runtime"
1442 && Gogo::unpack_hidden_name(no->name()) == "gcRoots")
1444 else
1445 var_gc.push_back(no);
1450 // Register global variables with the garbage collector.
1451 this->register_gc_vars(var_gc, init_stmts, init_bfn);
1453 // Simple variable initializations, after all variables are
1454 // registered.
1455 init_stmts.push_back(this->backend()->statement_list(var_init_stmts));
1457 // Complete variable initializations, first sorting them into a
1458 // workable order.
1459 if (!var_inits.empty())
1461 sort_var_inits(this, &var_inits);
1462 for (Var_inits::const_iterator p = var_inits.begin();
1463 p != var_inits.end();
1464 ++p)
1465 init_stmts.push_back(p->init());
1468 // After all the variables are initialized, call the init
1469 // functions if there are any. Init functions take no arguments, so
1470 // we pass in EMPTY_ARGS to call them.
1471 std::vector<Bexpression*> empty_args;
1472 for (std::vector<Named_object*>::const_iterator p =
1473 this->init_functions_.begin();
1474 p != this->init_functions_.end();
1475 ++p)
1477 Location func_loc = (*p)->location();
1478 Function* func = (*p)->func_value();
1479 Bfunction* initfn = func->get_or_make_decl(this, *p);
1480 Bexpression* func_code =
1481 this->backend()->function_code_expression(initfn, func_loc);
1482 Bexpression* call = this->backend()->call_expression(init_bfn, func_code,
1483 empty_args,
1484 NULL, func_loc);
1485 Bstatement* ist = this->backend()->expression_statement(init_bfn, call);
1486 init_stmts.push_back(ist);
1489 // Set up a magic function to do all the initialization actions.
1490 // This will be called if this package is imported.
1491 Bstatement* init_fncode = this->backend()->statement_list(init_stmts);
1492 if (this->need_init_fn_ || this->is_main_package())
1494 init_fndecl =
1495 this->create_initialization_function(init_fndecl, init_fncode);
1496 if (init_fndecl != NULL)
1497 func_decls.push_back(init_fndecl->func_value()->get_decl());
1500 // We should not have seen any new bindings created during the conversion.
1501 go_assert(count_definitions == this->current_bindings()->size_definitions());
1503 // Define all globally declared values.
1504 if (!saw_errors())
1505 this->backend()->write_global_definitions(type_decls, const_decls,
1506 func_decls, var_decls);
1509 // Return the current block.
1511 Block*
1512 Gogo::current_block()
1514 if (this->functions_.empty())
1515 return NULL;
1516 else
1517 return this->functions_.back().blocks.back();
1520 // Look up a name in the current binding contour. If PFUNCTION is not
1521 // NULL, set it to the function in which the name is defined, or NULL
1522 // if the name is defined in global scope.
1524 Named_object*
1525 Gogo::lookup(const std::string& name, Named_object** pfunction) const
1527 if (pfunction != NULL)
1528 *pfunction = NULL;
1530 if (Gogo::is_sink_name(name))
1531 return Named_object::make_sink();
1533 for (Open_functions::const_reverse_iterator p = this->functions_.rbegin();
1534 p != this->functions_.rend();
1535 ++p)
1537 Named_object* ret = p->blocks.back()->bindings()->lookup(name);
1538 if (ret != NULL)
1540 if (pfunction != NULL)
1541 *pfunction = p->function;
1542 return ret;
1546 if (this->package_ != NULL)
1548 Named_object* ret = this->package_->bindings()->lookup(name);
1549 if (ret != NULL)
1551 if (ret->package() != NULL)
1553 std::string dot_alias = "." + ret->package()->package_name();
1554 ret->package()->note_usage(dot_alias);
1556 return ret;
1560 // We do not look in the global namespace. If we did, the global
1561 // namespace would effectively hide names which were defined in
1562 // package scope which we have not yet seen. Instead,
1563 // define_global_names is called after parsing is over to connect
1564 // undefined names at package scope with names defined at global
1565 // scope.
1567 return NULL;
1570 // Look up a name in the current block, without searching enclosing
1571 // blocks.
1573 Named_object*
1574 Gogo::lookup_in_block(const std::string& name) const
1576 go_assert(!this->functions_.empty());
1577 go_assert(!this->functions_.back().blocks.empty());
1578 return this->functions_.back().blocks.back()->bindings()->lookup_local(name);
1581 // Look up a name in the global namespace.
1583 Named_object*
1584 Gogo::lookup_global(const char* name) const
1586 return this->globals_->lookup(name);
1589 // Add an imported package.
1591 Package*
1592 Gogo::add_imported_package(const std::string& real_name,
1593 const std::string& alias_arg,
1594 bool is_alias_exported,
1595 const std::string& pkgpath,
1596 const std::string& pkgpath_symbol,
1597 Location location,
1598 bool* padd_to_globals)
1600 Package* ret = this->register_package(pkgpath, pkgpath_symbol, location);
1601 ret->set_package_name(real_name, location);
1603 *padd_to_globals = false;
1605 if (alias_arg == "_")
1607 else if (alias_arg == ".")
1609 *padd_to_globals = true;
1610 std::string dot_alias = "." + real_name;
1611 ret->add_alias(dot_alias, location);
1613 else
1615 std::string alias = alias_arg;
1616 if (alias.empty())
1618 alias = real_name;
1619 is_alias_exported = Lex::is_exported_name(alias);
1621 ret->add_alias(alias, location);
1622 alias = this->pack_hidden_name(alias, is_alias_exported);
1623 Named_object* no = this->package_->bindings()->add_package(alias, ret);
1624 if (!no->is_package())
1625 return NULL;
1628 return ret;
1631 // Register a package. This package may or may not be imported. This
1632 // returns the Package structure for the package, creating if it
1633 // necessary. LOCATION is the location of the import statement that
1634 // led us to see this package. PKGPATH_SYMBOL is the symbol to use
1635 // for names in the package; it may be the empty string, in which case
1636 // we either get it later or make a guess when we need it.
1638 Package*
1639 Gogo::register_package(const std::string& pkgpath,
1640 const std::string& pkgpath_symbol, Location location)
1642 Package* package = NULL;
1643 std::pair<Packages::iterator, bool> ins =
1644 this->packages_.insert(std::make_pair(pkgpath, package));
1645 if (!ins.second)
1647 // We have seen this package name before.
1648 package = ins.first->second;
1649 go_assert(package != NULL && package->pkgpath() == pkgpath);
1650 if (!pkgpath_symbol.empty())
1651 package->set_pkgpath_symbol(pkgpath_symbol);
1652 if (Linemap::is_unknown_location(package->location()))
1653 package->set_location(location);
1655 else
1657 // First time we have seen this package name.
1658 package = new Package(pkgpath, pkgpath_symbol, location);
1659 go_assert(ins.first->second == NULL);
1660 ins.first->second = package;
1663 return package;
1666 // Return the pkgpath symbol for a package, given the pkgpath.
1668 std::string
1669 Gogo::pkgpath_symbol_for_package(const std::string& pkgpath)
1671 Packages::iterator p = this->packages_.find(pkgpath);
1672 go_assert(p != this->packages_.end());
1673 return p->second->pkgpath_symbol();
1676 // Start compiling a function.
1678 Named_object*
1679 Gogo::start_function(const std::string& name, Function_type* type,
1680 bool add_method_to_type, Location location)
1682 bool at_top_level = this->functions_.empty();
1684 Block* block = new Block(NULL, location);
1686 Named_object* enclosing = (at_top_level
1687 ? NULL
1688 : this->functions_.back().function);
1690 Function* function = new Function(type, enclosing, block, location);
1692 if (type->is_method())
1694 const Typed_identifier* receiver = type->receiver();
1695 Variable* this_param = new Variable(receiver->type(), NULL, false,
1696 true, true, location);
1697 std::string rname = receiver->name();
1698 if (rname.empty() || Gogo::is_sink_name(rname))
1700 // We need to give receivers a name since they wind up in
1701 // DECL_ARGUMENTS. FIXME.
1702 static unsigned int count;
1703 char buf[50];
1704 snprintf(buf, sizeof buf, "r.%u", count);
1705 ++count;
1706 rname = buf;
1708 block->bindings()->add_variable(rname, NULL, this_param);
1711 const Typed_identifier_list* parameters = type->parameters();
1712 bool is_varargs = type->is_varargs();
1713 if (parameters != NULL)
1715 for (Typed_identifier_list::const_iterator p = parameters->begin();
1716 p != parameters->end();
1717 ++p)
1719 Variable* param = new Variable(p->type(), NULL, false, true, false,
1720 p->location());
1721 if (is_varargs && p + 1 == parameters->end())
1722 param->set_is_varargs_parameter();
1724 std::string pname = p->name();
1725 if (pname.empty() || Gogo::is_sink_name(pname))
1727 // We need to give parameters a name since they wind up
1728 // in DECL_ARGUMENTS. FIXME.
1729 static unsigned int count;
1730 char buf[50];
1731 snprintf(buf, sizeof buf, "p.%u", count);
1732 ++count;
1733 pname = buf;
1735 block->bindings()->add_variable(pname, NULL, param);
1739 function->create_result_variables(this);
1741 const std::string* pname;
1742 std::string nested_name;
1743 bool is_init = false;
1744 if (Gogo::unpack_hidden_name(name) == "init" && !type->is_method())
1746 if ((type->parameters() != NULL && !type->parameters()->empty())
1747 || (type->results() != NULL && !type->results()->empty()))
1748 go_error_at(location,
1749 "func init must have no arguments and no return values");
1750 // There can be multiple "init" functions, so give them each a
1751 // different name.
1752 nested_name = this->init_function_name();
1753 pname = &nested_name;
1754 is_init = true;
1756 else if (!name.empty())
1757 pname = &name;
1758 else
1760 // Invent a name for a nested function.
1761 nested_name = this->nested_function_name(enclosing);
1762 pname = &nested_name;
1765 Named_object* ret;
1766 if (Gogo::is_sink_name(*pname))
1768 std::string sname(this->sink_function_name());
1769 ret = Named_object::make_function(sname, NULL, function);
1770 ret->func_value()->set_is_sink();
1772 if (!type->is_method())
1773 ret = this->package_->bindings()->add_named_object(ret);
1774 else if (add_method_to_type)
1776 // We should report errors even for sink methods.
1777 Type* rtype = type->receiver()->type();
1778 // Avoid points_to and deref to avoid getting an error if
1779 // the type is not yet defined.
1780 if (rtype->classification() == Type::TYPE_POINTER)
1781 rtype = rtype->points_to();
1782 while (rtype->named_type() != NULL
1783 && rtype->named_type()->is_alias())
1784 rtype = rtype->named_type()->real_type()->forwarded();
1785 if (rtype->is_error_type())
1787 else if (rtype->named_type() != NULL)
1789 if (rtype->named_type()->named_object()->package() != NULL)
1790 go_error_at(type->receiver()->location(),
1791 "may not define methods on non-local type");
1793 else if (rtype->forward_declaration_type() != NULL)
1795 // Go ahead and add the method in case we need to report
1796 // an error when we see the definition.
1797 rtype->forward_declaration_type()->add_existing_method(ret);
1799 else
1800 go_error_at(type->receiver()->location(),
1801 ("invalid receiver type "
1802 "(receiver must be a named type)"));
1805 else if (!type->is_method())
1807 ret = this->package_->bindings()->add_function(*pname, NULL, function);
1808 if (!ret->is_function() || ret->func_value() != function)
1810 // Redefinition error. Invent a name to avoid knockon
1811 // errors.
1812 std::string rname(this->redefined_function_name());
1813 ret = this->package_->bindings()->add_function(rname, NULL, function);
1816 else
1818 if (!add_method_to_type)
1819 ret = Named_object::make_function(name, NULL, function);
1820 else
1822 go_assert(at_top_level);
1823 Type* rtype = type->receiver()->type();
1825 // We want to look through the pointer created by the
1826 // parser, without getting an error if the type is not yet
1827 // defined.
1828 if (rtype->classification() == Type::TYPE_POINTER)
1829 rtype = rtype->points_to();
1831 while (rtype->named_type() != NULL
1832 && rtype->named_type()->is_alias())
1833 rtype = rtype->named_type()->real_type()->forwarded();
1835 if (rtype->is_error_type())
1836 ret = Named_object::make_function(name, NULL, function);
1837 else if (rtype->named_type() != NULL)
1839 if (rtype->named_type()->named_object()->package() != NULL)
1841 go_error_at(type->receiver()->location(),
1842 "may not define methods on non-local type");
1843 ret = Named_object::make_function(name, NULL, function);
1845 else
1847 ret = rtype->named_type()->add_method(name, function);
1848 if (!ret->is_function())
1850 // Redefinition error.
1851 ret = Named_object::make_function(name, NULL, function);
1855 else if (rtype->forward_declaration_type() != NULL)
1857 Named_object* type_no =
1858 rtype->forward_declaration_type()->named_object();
1859 if (type_no->is_unknown())
1861 // If we are seeing methods it really must be a
1862 // type. Declare it as such. An alternative would
1863 // be to support lists of methods for unknown
1864 // expressions. Either way the error messages if
1865 // this is not a type are going to get confusing.
1866 Named_object* declared =
1867 this->declare_package_type(type_no->name(),
1868 type_no->location());
1869 go_assert(declared
1870 == type_no->unknown_value()->real_named_object());
1872 ret = rtype->forward_declaration_type()->add_method(name,
1873 function);
1875 else
1877 go_error_at(type->receiver()->location(),
1878 ("invalid receiver type (receiver must "
1879 "be a named type)"));
1880 ret = Named_object::make_function(name, NULL, function);
1883 this->package_->bindings()->add_method(ret);
1886 this->functions_.resize(this->functions_.size() + 1);
1887 Open_function& of(this->functions_.back());
1888 of.function = ret;
1889 of.blocks.push_back(block);
1891 if (is_init)
1893 this->init_functions_.push_back(ret);
1894 this->need_init_fn_ = true;
1897 return ret;
1900 // Finish compiling a function.
1902 void
1903 Gogo::finish_function(Location location)
1905 this->finish_block(location);
1906 go_assert(this->functions_.back().blocks.empty());
1907 this->functions_.pop_back();
1910 // Return the current function.
1912 Named_object*
1913 Gogo::current_function() const
1915 go_assert(!this->functions_.empty());
1916 return this->functions_.back().function;
1919 // Start a new block.
1921 void
1922 Gogo::start_block(Location location)
1924 go_assert(!this->functions_.empty());
1925 Block* block = new Block(this->current_block(), location);
1926 this->functions_.back().blocks.push_back(block);
1929 // Finish a block.
1931 Block*
1932 Gogo::finish_block(Location location)
1934 go_assert(!this->functions_.empty());
1935 go_assert(!this->functions_.back().blocks.empty());
1936 Block* block = this->functions_.back().blocks.back();
1937 this->functions_.back().blocks.pop_back();
1938 block->set_end_location(location);
1939 return block;
1942 // Add an erroneous name.
1944 Named_object*
1945 Gogo::add_erroneous_name(const std::string& name)
1947 return this->package_->bindings()->add_erroneous_name(name);
1950 // Add an unknown name.
1952 Named_object*
1953 Gogo::add_unknown_name(const std::string& name, Location location)
1955 return this->package_->bindings()->add_unknown_name(name, location);
1958 // Declare a function.
1960 Named_object*
1961 Gogo::declare_function(const std::string& name, Function_type* type,
1962 Location location)
1964 if (!type->is_method())
1965 return this->current_bindings()->add_function_declaration(name, NULL, type,
1966 location);
1967 else
1969 // We don't bother to add this to the list of global
1970 // declarations.
1971 Type* rtype = type->receiver()->type();
1973 // We want to look through the pointer created by the
1974 // parser, without getting an error if the type is not yet
1975 // defined.
1976 if (rtype->classification() == Type::TYPE_POINTER)
1977 rtype = rtype->points_to();
1979 if (rtype->is_error_type())
1980 return NULL;
1981 else if (rtype->named_type() != NULL)
1982 return rtype->named_type()->add_method_declaration(name, NULL, type,
1983 location);
1984 else if (rtype->forward_declaration_type() != NULL)
1986 Forward_declaration_type* ftype = rtype->forward_declaration_type();
1987 return ftype->add_method_declaration(name, NULL, type, location);
1989 else
1991 go_error_at(type->receiver()->location(),
1992 "invalid receiver type (receiver must be a named type)");
1993 return Named_object::make_erroneous_name(name);
1998 // Add a label definition.
2000 Label*
2001 Gogo::add_label_definition(const std::string& label_name,
2002 Location location)
2004 go_assert(!this->functions_.empty());
2005 Function* func = this->functions_.back().function->func_value();
2006 Label* label = func->add_label_definition(this, label_name, location);
2007 this->add_statement(Statement::make_label_statement(label, location));
2008 return label;
2011 // Add a label reference.
2013 Label*
2014 Gogo::add_label_reference(const std::string& label_name,
2015 Location location, bool issue_goto_errors)
2017 go_assert(!this->functions_.empty());
2018 Function* func = this->functions_.back().function->func_value();
2019 return func->add_label_reference(this, label_name, location,
2020 issue_goto_errors);
2023 // Return the current binding state.
2025 Bindings_snapshot*
2026 Gogo::bindings_snapshot(Location location)
2028 return new Bindings_snapshot(this->current_block(), location);
2031 // Add a statement.
2033 void
2034 Gogo::add_statement(Statement* statement)
2036 go_assert(!this->functions_.empty()
2037 && !this->functions_.back().blocks.empty());
2038 this->functions_.back().blocks.back()->add_statement(statement);
2041 // Add a block.
2043 void
2044 Gogo::add_block(Block* block, Location location)
2046 go_assert(!this->functions_.empty()
2047 && !this->functions_.back().blocks.empty());
2048 Statement* statement = Statement::make_block_statement(block, location);
2049 this->functions_.back().blocks.back()->add_statement(statement);
2052 // Add a constant.
2054 Named_object*
2055 Gogo::add_constant(const Typed_identifier& tid, Expression* expr,
2056 int iota_value)
2058 return this->current_bindings()->add_constant(tid, NULL, expr, iota_value);
2061 // Add a type.
2063 void
2064 Gogo::add_type(const std::string& name, Type* type, Location location)
2066 Named_object* no = this->current_bindings()->add_type(name, NULL, type,
2067 location);
2068 if (!this->in_global_scope() && no->is_type())
2070 Named_object* f = this->functions_.back().function;
2071 unsigned int index;
2072 if (f->is_function())
2073 index = f->func_value()->new_local_type_index();
2074 else
2075 index = 0;
2076 no->type_value()->set_in_function(f, index);
2080 // Add a named type.
2082 void
2083 Gogo::add_named_type(Named_type* type)
2085 go_assert(this->in_global_scope());
2086 this->current_bindings()->add_named_type(type);
2089 // Declare a type.
2091 Named_object*
2092 Gogo::declare_type(const std::string& name, Location location)
2094 Bindings* bindings = this->current_bindings();
2095 Named_object* no = bindings->add_type_declaration(name, NULL, location);
2096 if (!this->in_global_scope() && no->is_type_declaration())
2098 Named_object* f = this->functions_.back().function;
2099 unsigned int index;
2100 if (f->is_function())
2101 index = f->func_value()->new_local_type_index();
2102 else
2103 index = 0;
2104 no->type_declaration_value()->set_in_function(f, index);
2106 return no;
2109 // Declare a type at the package level.
2111 Named_object*
2112 Gogo::declare_package_type(const std::string& name, Location location)
2114 return this->package_->bindings()->add_type_declaration(name, NULL, location);
2117 // Declare a function at the package level.
2119 Named_object*
2120 Gogo::declare_package_function(const std::string& name, Function_type* type,
2121 Location location)
2123 return this->package_->bindings()->add_function_declaration(name, NULL, type,
2124 location);
2127 // Define a type which was already declared.
2129 void
2130 Gogo::define_type(Named_object* no, Named_type* type)
2132 this->current_bindings()->define_type(no, type);
2135 // Add a variable.
2137 Named_object*
2138 Gogo::add_variable(const std::string& name, Variable* variable)
2140 Named_object* no = this->current_bindings()->add_variable(name, NULL,
2141 variable);
2143 // In a function the middle-end wants to see a DECL_EXPR node.
2144 if (no != NULL
2145 && no->is_variable()
2146 && !no->var_value()->is_parameter()
2147 && !this->functions_.empty())
2148 this->add_statement(Statement::make_variable_declaration(no));
2150 return no;
2153 // Add a sink--a reference to the blank identifier _.
2155 Named_object*
2156 Gogo::add_sink()
2158 return Named_object::make_sink();
2161 // Add a named object for a dot import.
2163 void
2164 Gogo::add_dot_import_object(Named_object* no)
2166 // If the name already exists, then it was defined in some file seen
2167 // earlier. If the earlier name is just a declaration, don't add
2168 // this name, because that will cause the previous declaration to
2169 // merge to this imported name, which should not happen. Just add
2170 // this name to the list of file block names to get appropriate
2171 // errors if we see a later definition.
2172 Named_object* e = this->package_->bindings()->lookup(no->name());
2173 if (e != NULL && e->package() == NULL)
2175 if (e->is_unknown())
2176 e = e->resolve();
2177 if (e->package() == NULL
2178 && (e->is_type_declaration()
2179 || e->is_function_declaration()
2180 || e->is_unknown()))
2182 this->add_file_block_name(no->name(), no->location());
2183 return;
2187 this->current_bindings()->add_named_object(no);
2190 // Add a linkname. This implements the go:linkname compiler directive.
2191 // We only support this for functions and function declarations.
2193 void
2194 Gogo::add_linkname(const std::string& go_name, bool is_exported,
2195 const std::string& ext_name, Location loc)
2197 Named_object* no =
2198 this->package_->bindings()->lookup(this->pack_hidden_name(go_name,
2199 is_exported));
2200 if (no == NULL)
2201 go_error_at(loc, "%s is not defined", go_name.c_str());
2202 else if (no->is_function())
2203 no->func_value()->set_asm_name(ext_name);
2204 else if (no->is_function_declaration())
2205 no->func_declaration_value()->set_asm_name(ext_name);
2206 else
2207 go_error_at(loc,
2208 ("%s is not a function; "
2209 "//go:linkname is only supported for functions"),
2210 go_name.c_str());
2213 // Mark all local variables used. This is used when some types of
2214 // parse error occur.
2216 void
2217 Gogo::mark_locals_used()
2219 for (Open_functions::iterator pf = this->functions_.begin();
2220 pf != this->functions_.end();
2221 ++pf)
2223 for (std::vector<Block*>::iterator pb = pf->blocks.begin();
2224 pb != pf->blocks.end();
2225 ++pb)
2226 (*pb)->bindings()->mark_locals_used();
2230 // Record that we've seen an interface type.
2232 void
2233 Gogo::record_interface_type(Interface_type* itype)
2235 this->interface_types_.push_back(itype);
2238 // Define the global names. We do this only after parsing all the
2239 // input files, because the program might define the global names
2240 // itself.
2242 void
2243 Gogo::define_global_names()
2245 if (this->is_main_package())
2247 // Every Go program has to import the runtime package, so that
2248 // it is properly initialized.
2249 this->import_package("runtime", "_", false, false,
2250 Linemap::predeclared_location());
2253 for (Bindings::const_declarations_iterator p =
2254 this->globals_->begin_declarations();
2255 p != this->globals_->end_declarations();
2256 ++p)
2258 Named_object* global_no = p->second;
2259 std::string name(Gogo::pack_hidden_name(global_no->name(), false));
2260 Named_object* no = this->package_->bindings()->lookup(name);
2261 if (no == NULL)
2262 continue;
2263 no = no->resolve();
2264 if (no->is_type_declaration())
2266 if (global_no->is_type())
2268 if (no->type_declaration_value()->has_methods())
2270 for (std::vector<Named_object*>::const_iterator p =
2271 no->type_declaration_value()->methods()->begin();
2272 p != no->type_declaration_value()->methods()->end();
2273 p++)
2274 go_error_at((*p)->location(),
2275 "may not define methods on non-local type");
2277 no->set_type_value(global_no->type_value());
2279 else
2281 go_error_at(no->location(), "expected type");
2282 Type* errtype = Type::make_error_type();
2283 Named_object* err =
2284 Named_object::make_type("erroneous_type", NULL, errtype,
2285 Linemap::predeclared_location());
2286 no->set_type_value(err->type_value());
2289 else if (no->is_unknown())
2290 no->unknown_value()->set_real_named_object(global_no);
2293 // Give an error if any name is defined in both the package block
2294 // and the file block. For example, this can happen if one file
2295 // imports "fmt" and another file defines a global variable fmt.
2296 for (Bindings::const_declarations_iterator p =
2297 this->package_->bindings()->begin_declarations();
2298 p != this->package_->bindings()->end_declarations();
2299 ++p)
2301 if (p->second->is_unknown()
2302 && p->second->unknown_value()->real_named_object() == NULL)
2304 // No point in warning about an undefined name, as we will
2305 // get other errors later anyhow.
2306 continue;
2308 File_block_names::const_iterator pf =
2309 this->file_block_names_.find(p->second->name());
2310 if (pf != this->file_block_names_.end())
2312 std::string n = p->second->message_name();
2313 go_error_at(p->second->location(),
2314 "%qs defined as both imported name and global name",
2315 n.c_str());
2316 go_inform(pf->second, "%qs imported here", n.c_str());
2319 // No package scope identifier may be named "init".
2320 if (!p->second->is_function()
2321 && Gogo::unpack_hidden_name(p->second->name()) == "init")
2323 go_error_at(p->second->location(),
2324 "cannot declare init - must be func");
2329 // Clear out names in file scope.
2331 void
2332 Gogo::clear_file_scope()
2334 this->package_->bindings()->clear_file_scope(this);
2336 // Warn about packages which were imported but not used.
2337 bool quiet = saw_errors();
2338 for (Packages::iterator p = this->packages_.begin();
2339 p != this->packages_.end();
2340 ++p)
2342 Package* package = p->second;
2343 if (package != this->package_ && !quiet)
2345 for (Package::Aliases::const_iterator p1 = package->aliases().begin();
2346 p1 != package->aliases().end();
2347 ++p1)
2349 if (!p1->second->used())
2351 // Give a more refined error message if the alias name is known.
2352 std::string pkg_name = package->package_name();
2353 if (p1->first != pkg_name && p1->first[0] != '.')
2355 go_error_at(p1->second->location(),
2356 "imported and not used: %s as %s",
2357 Gogo::message_name(pkg_name).c_str(),
2358 Gogo::message_name(p1->first).c_str());
2360 else
2361 go_error_at(p1->second->location(),
2362 "imported and not used: %s",
2363 Gogo::message_name(pkg_name).c_str());
2367 package->clear_used();
2370 this->current_file_imported_unsafe_ = false;
2373 // Queue up a type specific function for later writing. These are
2374 // written out in write_specific_type_functions, called after the
2375 // parse tree is lowered.
2377 void
2378 Gogo::queue_specific_type_function(Type* type, Named_type* name, int64_t size,
2379 const std::string& hash_name,
2380 Function_type* hash_fntype,
2381 const std::string& equal_name,
2382 Function_type* equal_fntype)
2384 go_assert(!this->specific_type_functions_are_written_);
2385 go_assert(!this->in_global_scope());
2386 Specific_type_function* tsf = new Specific_type_function(type, name, size,
2387 hash_name,
2388 hash_fntype,
2389 equal_name,
2390 equal_fntype);
2391 this->specific_type_functions_.push_back(tsf);
2394 // Look for types which need specific hash or equality functions.
2396 class Specific_type_functions : public Traverse
2398 public:
2399 Specific_type_functions(Gogo* gogo)
2400 : Traverse(traverse_types),
2401 gogo_(gogo)
2405 type(Type*);
2407 private:
2408 Gogo* gogo_;
2412 Specific_type_functions::type(Type* t)
2414 Named_object* hash_fn;
2415 Named_object* equal_fn;
2416 switch (t->classification())
2418 case Type::TYPE_NAMED:
2420 Named_type* nt = t->named_type();
2421 if (nt->is_alias())
2422 return TRAVERSE_CONTINUE;
2423 if (t->needs_specific_type_functions(this->gogo_))
2424 t->type_functions(this->gogo_, nt, NULL, NULL, &hash_fn, &equal_fn);
2426 // If this is a struct type, we don't want to make functions
2427 // for the unnamed struct.
2428 Type* rt = nt->real_type();
2429 if (rt->struct_type() == NULL)
2431 if (Type::traverse(rt, this) == TRAVERSE_EXIT)
2432 return TRAVERSE_EXIT;
2434 else
2436 // If this type is defined in another package, then we don't
2437 // need to worry about the unexported fields.
2438 bool is_defined_elsewhere = nt->named_object()->package() != NULL;
2439 const Struct_field_list* fields = rt->struct_type()->fields();
2440 for (Struct_field_list::const_iterator p = fields->begin();
2441 p != fields->end();
2442 ++p)
2444 if (is_defined_elsewhere
2445 && Gogo::is_hidden_name(p->field_name()))
2446 continue;
2447 if (Type::traverse(p->type(), this) == TRAVERSE_EXIT)
2448 return TRAVERSE_EXIT;
2452 return TRAVERSE_SKIP_COMPONENTS;
2455 case Type::TYPE_STRUCT:
2456 case Type::TYPE_ARRAY:
2457 if (t->needs_specific_type_functions(this->gogo_))
2458 t->type_functions(this->gogo_, NULL, NULL, NULL, &hash_fn, &equal_fn);
2459 break;
2461 default:
2462 break;
2465 return TRAVERSE_CONTINUE;
2468 // Write out type specific functions.
2470 void
2471 Gogo::write_specific_type_functions()
2473 Specific_type_functions stf(this);
2474 this->traverse(&stf);
2476 while (!this->specific_type_functions_.empty())
2478 Specific_type_function* tsf = this->specific_type_functions_.back();
2479 this->specific_type_functions_.pop_back();
2480 tsf->type->write_specific_type_functions(this, tsf->name, tsf->size,
2481 tsf->hash_name,
2482 tsf->hash_fntype,
2483 tsf->equal_name,
2484 tsf->equal_fntype);
2485 delete tsf;
2487 this->specific_type_functions_are_written_ = true;
2490 // Traverse the tree.
2492 void
2493 Gogo::traverse(Traverse* traverse)
2495 // Traverse the current package first for consistency. The other
2496 // packages will only contain imported types, constants, and
2497 // declarations.
2498 if (this->package_->bindings()->traverse(traverse, true) == TRAVERSE_EXIT)
2499 return;
2500 for (Packages::const_iterator p = this->packages_.begin();
2501 p != this->packages_.end();
2502 ++p)
2504 if (p->second != this->package_)
2506 if (p->second->bindings()->traverse(traverse, true) == TRAVERSE_EXIT)
2507 break;
2512 // Add a type to verify. This is used for types of sink variables, in
2513 // order to give appropriate error messages.
2515 void
2516 Gogo::add_type_to_verify(Type* type)
2518 this->verify_types_.push_back(type);
2521 // Traversal class used to verify types.
2523 class Verify_types : public Traverse
2525 public:
2526 Verify_types()
2527 : Traverse(traverse_types)
2531 type(Type*);
2534 // Verify that a type is correct.
2537 Verify_types::type(Type* t)
2539 if (!t->verify())
2540 return TRAVERSE_SKIP_COMPONENTS;
2541 return TRAVERSE_CONTINUE;
2544 // Verify that all types are correct.
2546 void
2547 Gogo::verify_types()
2549 Verify_types traverse;
2550 this->traverse(&traverse);
2552 for (std::vector<Type*>::iterator p = this->verify_types_.begin();
2553 p != this->verify_types_.end();
2554 ++p)
2555 (*p)->verify();
2556 this->verify_types_.clear();
2559 // Traversal class used to lower parse tree.
2561 class Lower_parse_tree : public Traverse
2563 public:
2564 Lower_parse_tree(Gogo* gogo, Named_object* function)
2565 : Traverse(traverse_variables
2566 | traverse_constants
2567 | traverse_functions
2568 | traverse_statements
2569 | traverse_expressions),
2570 gogo_(gogo), function_(function), iota_value_(-1), inserter_()
2573 void
2574 set_inserter(const Statement_inserter* inserter)
2575 { this->inserter_ = *inserter; }
2578 variable(Named_object*);
2581 constant(Named_object*, bool);
2584 function(Named_object*);
2587 statement(Block*, size_t* pindex, Statement*);
2590 expression(Expression**);
2592 private:
2593 // General IR.
2594 Gogo* gogo_;
2595 // The function we are traversing.
2596 Named_object* function_;
2597 // Value to use for the predeclared constant iota.
2598 int iota_value_;
2599 // Current statement inserter for use by expressions.
2600 Statement_inserter inserter_;
2603 // Lower variables.
2606 Lower_parse_tree::variable(Named_object* no)
2608 if (!no->is_variable())
2609 return TRAVERSE_CONTINUE;
2611 if (no->is_variable() && no->var_value()->is_global())
2613 // Global variables can have loops in their initialization
2614 // expressions. This is handled in lower_init_expression.
2615 no->var_value()->lower_init_expression(this->gogo_, this->function_,
2616 &this->inserter_);
2617 return TRAVERSE_CONTINUE;
2620 // This is a local variable. We are going to return
2621 // TRAVERSE_SKIP_COMPONENTS here because we want to traverse the
2622 // initialization expression when we reach the variable declaration
2623 // statement. However, that means that we need to traverse the type
2624 // ourselves.
2625 if (no->var_value()->has_type())
2627 Type* type = no->var_value()->type();
2628 if (type != NULL)
2630 if (Type::traverse(type, this) == TRAVERSE_EXIT)
2631 return TRAVERSE_EXIT;
2634 go_assert(!no->var_value()->has_pre_init());
2636 return TRAVERSE_SKIP_COMPONENTS;
2639 // Lower constants. We handle constants specially so that we can set
2640 // the right value for the predeclared constant iota. This works in
2641 // conjunction with the way we lower Const_expression objects.
2644 Lower_parse_tree::constant(Named_object* no, bool)
2646 Named_constant* nc = no->const_value();
2648 // Don't get into trouble if the constant's initializer expression
2649 // refers to the constant itself.
2650 if (nc->lowering())
2651 return TRAVERSE_CONTINUE;
2652 nc->set_lowering();
2654 go_assert(this->iota_value_ == -1);
2655 this->iota_value_ = nc->iota_value();
2656 nc->traverse_expression(this);
2657 this->iota_value_ = -1;
2659 nc->clear_lowering();
2661 // We will traverse the expression a second time, but that will be
2662 // fast.
2664 return TRAVERSE_CONTINUE;
2667 // Lower the body of a function, and set the closure type. Record the
2668 // function while lowering it, so that we can pass it down when
2669 // lowering an expression.
2672 Lower_parse_tree::function(Named_object* no)
2674 no->func_value()->set_closure_type();
2676 go_assert(this->function_ == NULL);
2677 this->function_ = no;
2678 int t = no->func_value()->traverse(this);
2679 this->function_ = NULL;
2681 if (t == TRAVERSE_EXIT)
2682 return t;
2683 return TRAVERSE_SKIP_COMPONENTS;
2686 // Lower statement parse trees.
2689 Lower_parse_tree::statement(Block* block, size_t* pindex, Statement* sorig)
2691 // Because we explicitly traverse the statement's contents
2692 // ourselves, we want to skip block statements here. There is
2693 // nothing to lower in a block statement.
2694 if (sorig->is_block_statement())
2695 return TRAVERSE_CONTINUE;
2697 Statement_inserter hold_inserter(this->inserter_);
2698 this->inserter_ = Statement_inserter(block, pindex);
2700 // Lower the expressions first.
2701 int t = sorig->traverse_contents(this);
2702 if (t == TRAVERSE_EXIT)
2704 this->inserter_ = hold_inserter;
2705 return t;
2708 // Keep lowering until nothing changes.
2709 Statement* s = sorig;
2710 while (true)
2712 Statement* snew = s->lower(this->gogo_, this->function_, block,
2713 &this->inserter_);
2714 if (snew == s)
2715 break;
2716 s = snew;
2717 t = s->traverse_contents(this);
2718 if (t == TRAVERSE_EXIT)
2720 this->inserter_ = hold_inserter;
2721 return t;
2725 if (s != sorig)
2726 block->replace_statement(*pindex, s);
2728 this->inserter_ = hold_inserter;
2729 return TRAVERSE_SKIP_COMPONENTS;
2732 // Lower expression parse trees.
2735 Lower_parse_tree::expression(Expression** pexpr)
2737 // We have to lower all subexpressions first, so that we can get
2738 // their type if necessary. This is awkward, because we don't have
2739 // a postorder traversal pass.
2740 if ((*pexpr)->traverse_subexpressions(this) == TRAVERSE_EXIT)
2741 return TRAVERSE_EXIT;
2742 // Keep lowering until nothing changes.
2743 while (true)
2745 Expression* e = *pexpr;
2746 Expression* enew = e->lower(this->gogo_, this->function_,
2747 &this->inserter_, this->iota_value_);
2748 if (enew == e)
2749 break;
2750 if (enew->traverse_subexpressions(this) == TRAVERSE_EXIT)
2751 return TRAVERSE_EXIT;
2752 *pexpr = enew;
2754 return TRAVERSE_SKIP_COMPONENTS;
2757 // Lower the parse tree. This is called after the parse is complete,
2758 // when all names should be resolved.
2760 void
2761 Gogo::lower_parse_tree()
2763 Lower_parse_tree lower_parse_tree(this, NULL);
2764 this->traverse(&lower_parse_tree);
2766 // There might be type definitions that involve expressions such as the
2767 // array length. Make sure to lower these expressions as well. Otherwise,
2768 // errors hidden within a type can introduce unexpected errors into later
2769 // passes.
2770 for (std::vector<Type*>::iterator p = this->verify_types_.begin();
2771 p != this->verify_types_.end();
2772 ++p)
2773 Type::traverse(*p, &lower_parse_tree);
2776 // Lower a block.
2778 void
2779 Gogo::lower_block(Named_object* function, Block* block)
2781 Lower_parse_tree lower_parse_tree(this, function);
2782 block->traverse(&lower_parse_tree);
2785 // Lower an expression. INSERTER may be NULL, in which case the
2786 // expression had better not need to create any temporaries.
2788 void
2789 Gogo::lower_expression(Named_object* function, Statement_inserter* inserter,
2790 Expression** pexpr)
2792 Lower_parse_tree lower_parse_tree(this, function);
2793 if (inserter != NULL)
2794 lower_parse_tree.set_inserter(inserter);
2795 lower_parse_tree.expression(pexpr);
2798 // Lower a constant. This is called when lowering a reference to a
2799 // constant. We have to make sure that the constant has already been
2800 // lowered.
2802 void
2803 Gogo::lower_constant(Named_object* no)
2805 go_assert(no->is_const());
2806 Lower_parse_tree lower(this, NULL);
2807 lower.constant(no, false);
2810 // Traverse the tree to create function descriptors as needed.
2812 class Create_function_descriptors : public Traverse
2814 public:
2815 Create_function_descriptors(Gogo* gogo)
2816 : Traverse(traverse_functions | traverse_expressions),
2817 gogo_(gogo)
2821 function(Named_object*);
2824 expression(Expression**);
2826 private:
2827 Gogo* gogo_;
2830 // Create a descriptor for every top-level exported function.
2833 Create_function_descriptors::function(Named_object* no)
2835 if (no->is_function()
2836 && no->func_value()->enclosing() == NULL
2837 && !no->func_value()->is_method()
2838 && !Gogo::is_hidden_name(no->name())
2839 && !Gogo::is_thunk(no))
2840 no->func_value()->descriptor(this->gogo_, no);
2842 return TRAVERSE_CONTINUE;
2845 // If we see a function referenced in any way other than calling it,
2846 // create a descriptor for it.
2849 Create_function_descriptors::expression(Expression** pexpr)
2851 Expression* expr = *pexpr;
2853 Func_expression* fe = expr->func_expression();
2854 if (fe != NULL)
2856 // We would not get here for a call to this function, so this is
2857 // a reference to a function other than calling it. We need a
2858 // descriptor.
2859 if (fe->closure() != NULL)
2860 return TRAVERSE_CONTINUE;
2861 Named_object* no = fe->named_object();
2862 if (no->is_function() && !no->func_value()->is_method())
2863 no->func_value()->descriptor(this->gogo_, no);
2864 else if (no->is_function_declaration()
2865 && !no->func_declaration_value()->type()->is_method()
2866 && !Linemap::is_predeclared_location(no->location()))
2867 no->func_declaration_value()->descriptor(this->gogo_, no);
2868 return TRAVERSE_CONTINUE;
2871 Bound_method_expression* bme = expr->bound_method_expression();
2872 if (bme != NULL)
2874 // We would not get here for a call to this method, so this is a
2875 // method value. We need to create a thunk.
2876 Bound_method_expression::create_thunk(this->gogo_, bme->method(),
2877 bme->function());
2878 return TRAVERSE_CONTINUE;
2881 Interface_field_reference_expression* ifre =
2882 expr->interface_field_reference_expression();
2883 if (ifre != NULL)
2885 // We would not get here for a call to this interface method, so
2886 // this is a method value. We need to create a thunk.
2887 Interface_type* type = ifre->expr()->type()->interface_type();
2888 if (type != NULL)
2889 Interface_field_reference_expression::create_thunk(this->gogo_, type,
2890 ifre->name());
2891 return TRAVERSE_CONTINUE;
2894 Call_expression* ce = expr->call_expression();
2895 if (ce != NULL)
2897 Expression* fn = ce->fn();
2898 if (fn->func_expression() != NULL
2899 || fn->bound_method_expression() != NULL
2900 || fn->interface_field_reference_expression() != NULL)
2902 // Traverse the arguments but not the function.
2903 Expression_list* args = ce->args();
2904 if (args != NULL)
2906 if (args->traverse(this) == TRAVERSE_EXIT)
2907 return TRAVERSE_EXIT;
2909 return TRAVERSE_SKIP_COMPONENTS;
2913 return TRAVERSE_CONTINUE;
2916 // Create function descriptors as needed. We need a function
2917 // descriptor for all exported functions and for all functions that
2918 // are referenced without being called.
2920 void
2921 Gogo::create_function_descriptors()
2923 // Create a function descriptor for any exported function that is
2924 // declared in this package. This is so that we have a descriptor
2925 // for functions written in assembly. Gather the descriptors first
2926 // so that we don't add declarations while looping over them.
2927 std::vector<Named_object*> fndecls;
2928 Bindings* b = this->package_->bindings();
2929 for (Bindings::const_declarations_iterator p = b->begin_declarations();
2930 p != b->end_declarations();
2931 ++p)
2933 Named_object* no = p->second;
2934 if (no->is_function_declaration()
2935 && !no->func_declaration_value()->type()->is_method()
2936 && !Linemap::is_predeclared_location(no->location())
2937 && !Gogo::is_hidden_name(no->name()))
2938 fndecls.push_back(no);
2940 for (std::vector<Named_object*>::const_iterator p = fndecls.begin();
2941 p != fndecls.end();
2942 ++p)
2943 (*p)->func_declaration_value()->descriptor(this, *p);
2944 fndecls.clear();
2946 Create_function_descriptors cfd(this);
2947 this->traverse(&cfd);
2950 // Look for interface types to finalize methods of inherited
2951 // interfaces.
2953 class Finalize_methods : public Traverse
2955 public:
2956 Finalize_methods(Gogo* gogo)
2957 : Traverse(traverse_types),
2958 gogo_(gogo)
2962 type(Type*);
2964 private:
2965 Gogo* gogo_;
2968 // Finalize the methods of an interface type.
2971 Finalize_methods::type(Type* t)
2973 // Check the classification so that we don't finalize the methods
2974 // twice for a named interface type.
2975 switch (t->classification())
2977 case Type::TYPE_INTERFACE:
2978 t->interface_type()->finalize_methods();
2979 break;
2981 case Type::TYPE_NAMED:
2983 Named_type* nt = t->named_type();
2984 Type* rt = nt->real_type();
2985 if (rt->classification() != Type::TYPE_STRUCT)
2987 // Finalize the methods of the real type first.
2988 if (Type::traverse(rt, this) == TRAVERSE_EXIT)
2989 return TRAVERSE_EXIT;
2991 // Finalize the methods of this type.
2992 nt->finalize_methods(this->gogo_);
2994 else
2996 // We don't want to finalize the methods of a named struct
2997 // type, as the methods should be attached to the named
2998 // type, not the struct type. We just want to finalize
2999 // the field types.
3001 // It is possible that a field type refers indirectly to
3002 // this type, such as via a field with function type with
3003 // an argument or result whose type is this type. To
3004 // avoid the cycle, first finalize the methods of any
3005 // embedded types, which are the only types we need to
3006 // know to finalize the methods of this type.
3007 const Struct_field_list* fields = rt->struct_type()->fields();
3008 if (fields != NULL)
3010 for (Struct_field_list::const_iterator pf = fields->begin();
3011 pf != fields->end();
3012 ++pf)
3014 if (pf->is_anonymous())
3016 if (Type::traverse(pf->type(), this) == TRAVERSE_EXIT)
3017 return TRAVERSE_EXIT;
3022 // Finalize the methods of this type.
3023 nt->finalize_methods(this->gogo_);
3025 // Finalize all the struct fields.
3026 if (rt->struct_type()->traverse_field_types(this) == TRAVERSE_EXIT)
3027 return TRAVERSE_EXIT;
3030 // If this type is defined in a different package, then finalize the
3031 // types of all the methods, since we won't see them otherwise.
3032 if (nt->named_object()->package() != NULL && nt->has_any_methods())
3034 const Methods* methods = nt->methods();
3035 for (Methods::const_iterator p = methods->begin();
3036 p != methods->end();
3037 ++p)
3039 if (Type::traverse(p->second->type(), this) == TRAVERSE_EXIT)
3040 return TRAVERSE_EXIT;
3044 // Finalize the types of all methods that are declared but not
3045 // defined, since we won't see the declarations otherwise.
3046 if (nt->named_object()->package() == NULL
3047 && nt->local_methods() != NULL)
3049 const Bindings* methods = nt->local_methods();
3050 for (Bindings::const_declarations_iterator p =
3051 methods->begin_declarations();
3052 p != methods->end_declarations();
3053 p++)
3055 if (p->second->is_function_declaration())
3057 Type* mt = p->second->func_declaration_value()->type();
3058 if (Type::traverse(mt, this) == TRAVERSE_EXIT)
3059 return TRAVERSE_EXIT;
3064 return TRAVERSE_SKIP_COMPONENTS;
3067 case Type::TYPE_STRUCT:
3068 // Traverse the field types first in case there is an embedded
3069 // field with methods that the struct should inherit.
3070 if (t->struct_type()->traverse_field_types(this) == TRAVERSE_EXIT)
3071 return TRAVERSE_EXIT;
3072 t->struct_type()->finalize_methods(this->gogo_);
3073 return TRAVERSE_SKIP_COMPONENTS;
3075 default:
3076 break;
3079 return TRAVERSE_CONTINUE;
3082 // Finalize method lists and build stub methods for types.
3084 void
3085 Gogo::finalize_methods()
3087 Finalize_methods finalize(this);
3088 this->traverse(&finalize);
3091 // Set types for unspecified variables and constants.
3093 void
3094 Gogo::determine_types()
3096 Bindings* bindings = this->current_bindings();
3097 for (Bindings::const_definitions_iterator p = bindings->begin_definitions();
3098 p != bindings->end_definitions();
3099 ++p)
3101 if ((*p)->is_function())
3102 (*p)->func_value()->determine_types();
3103 else if ((*p)->is_variable())
3104 (*p)->var_value()->determine_type();
3105 else if ((*p)->is_const())
3106 (*p)->const_value()->determine_type();
3108 // See if a variable requires us to build an initialization
3109 // function. We know that we will see all global variables
3110 // here.
3111 if (!this->need_init_fn_ && (*p)->is_variable())
3113 Variable* variable = (*p)->var_value();
3115 // If this is a global variable which requires runtime
3116 // initialization, we need an initialization function.
3117 if (!variable->is_global())
3119 else if (variable->init() == NULL)
3121 else if (variable->type()->interface_type() != NULL)
3122 this->need_init_fn_ = true;
3123 else if (variable->init()->is_constant())
3125 else if (!variable->init()->is_composite_literal())
3126 this->need_init_fn_ = true;
3127 else if (variable->init()->is_nonconstant_composite_literal())
3128 this->need_init_fn_ = true;
3130 // If this is a global variable which holds a pointer value,
3131 // then we need an initialization function to register it as a
3132 // GC root.
3133 if (variable->is_global() && variable->type()->has_pointer())
3134 this->need_init_fn_ = true;
3138 // Determine the types of constants in packages.
3139 for (Packages::const_iterator p = this->packages_.begin();
3140 p != this->packages_.end();
3141 ++p)
3142 p->second->determine_types();
3145 // Traversal class used for type checking.
3147 class Check_types_traverse : public Traverse
3149 public:
3150 Check_types_traverse(Gogo* gogo)
3151 : Traverse(traverse_variables
3152 | traverse_constants
3153 | traverse_functions
3154 | traverse_statements
3155 | traverse_expressions),
3156 gogo_(gogo)
3160 variable(Named_object*);
3163 constant(Named_object*, bool);
3166 function(Named_object*);
3169 statement(Block*, size_t* pindex, Statement*);
3172 expression(Expression**);
3174 private:
3175 // General IR.
3176 Gogo* gogo_;
3179 // Check that a variable initializer has the right type.
3182 Check_types_traverse::variable(Named_object* named_object)
3184 if (named_object->is_variable())
3186 Variable* var = named_object->var_value();
3188 // Give error if variable type is not defined.
3189 var->type()->base();
3191 Expression* init = var->init();
3192 std::string reason;
3193 if (init != NULL
3194 && !Type::are_assignable(var->type(), init->type(), &reason))
3196 if (reason.empty())
3197 go_error_at(var->location(), "incompatible type in initialization");
3198 else
3199 go_error_at(var->location(),
3200 "incompatible type in initialization (%s)",
3201 reason.c_str());
3202 init = Expression::make_error(named_object->location());
3203 var->clear_init();
3205 else if (init != NULL
3206 && init->func_expression() != NULL)
3208 Named_object* no = init->func_expression()->named_object();
3209 Function_type* fntype;
3210 if (no->is_function())
3211 fntype = no->func_value()->type();
3212 else if (no->is_function_declaration())
3213 fntype = no->func_declaration_value()->type();
3214 else
3215 go_unreachable();
3217 // Builtin functions cannot be used as function values for variable
3218 // initialization.
3219 if (fntype->is_builtin())
3221 go_error_at(init->location(),
3222 "invalid use of special builtin function %qs; "
3223 "must be called",
3224 no->message_name().c_str());
3227 if (!var->is_used()
3228 && !var->is_global()
3229 && !var->is_parameter()
3230 && !var->is_receiver()
3231 && !var->type()->is_error()
3232 && (init == NULL || !init->is_error_expression())
3233 && !Lex::is_invalid_identifier(named_object->name()))
3234 go_error_at(var->location(), "%qs declared and not used",
3235 named_object->message_name().c_str());
3237 return TRAVERSE_CONTINUE;
3240 // Check that a constant initializer has the right type.
3243 Check_types_traverse::constant(Named_object* named_object, bool)
3245 Named_constant* constant = named_object->const_value();
3246 Type* ctype = constant->type();
3247 if (ctype->integer_type() == NULL
3248 && ctype->float_type() == NULL
3249 && ctype->complex_type() == NULL
3250 && !ctype->is_boolean_type()
3251 && !ctype->is_string_type())
3253 if (ctype->is_nil_type())
3254 go_error_at(constant->location(), "const initializer cannot be nil");
3255 else if (!ctype->is_error())
3256 go_error_at(constant->location(), "invalid constant type");
3257 constant->set_error();
3259 else if (!constant->expr()->is_constant())
3261 go_error_at(constant->expr()->location(), "expression is not constant");
3262 constant->set_error();
3264 else if (!Type::are_assignable(constant->type(), constant->expr()->type(),
3265 NULL))
3267 go_error_at(constant->location(),
3268 "initialization expression has wrong type");
3269 constant->set_error();
3271 return TRAVERSE_CONTINUE;
3274 // There are no types to check in a function, but this is where we
3275 // issue warnings about labels which are defined but not referenced.
3278 Check_types_traverse::function(Named_object* no)
3280 no->func_value()->check_labels();
3281 return TRAVERSE_CONTINUE;
3284 // Check that types are valid in a statement.
3287 Check_types_traverse::statement(Block*, size_t*, Statement* s)
3289 s->check_types(this->gogo_);
3290 return TRAVERSE_CONTINUE;
3293 // Check that types are valid in an expression.
3296 Check_types_traverse::expression(Expression** expr)
3298 (*expr)->check_types(this->gogo_);
3299 return TRAVERSE_CONTINUE;
3302 // Check that types are valid.
3304 void
3305 Gogo::check_types()
3307 Check_types_traverse traverse(this);
3308 this->traverse(&traverse);
3310 Bindings* bindings = this->current_bindings();
3311 for (Bindings::const_declarations_iterator p = bindings->begin_declarations();
3312 p != bindings->end_declarations();
3313 ++p)
3315 // Also check the types in a function declaration's signature.
3316 Named_object* no = p->second;
3317 if (no->is_function_declaration())
3318 no->func_declaration_value()->check_types();
3322 // Check the types in a single block.
3324 void
3325 Gogo::check_types_in_block(Block* block)
3327 Check_types_traverse traverse(this);
3328 block->traverse(&traverse);
3331 // A traversal class used to find a single shortcut operator within an
3332 // expression.
3334 class Find_shortcut : public Traverse
3336 public:
3337 Find_shortcut()
3338 : Traverse(traverse_blocks
3339 | traverse_statements
3340 | traverse_expressions),
3341 found_(NULL)
3344 // A pointer to the expression which was found, or NULL if none was
3345 // found.
3346 Expression**
3347 found() const
3348 { return this->found_; }
3350 protected:
3352 block(Block*)
3353 { return TRAVERSE_SKIP_COMPONENTS; }
3356 statement(Block*, size_t*, Statement*)
3357 { return TRAVERSE_SKIP_COMPONENTS; }
3360 expression(Expression**);
3362 private:
3363 Expression** found_;
3366 // Find a shortcut expression.
3369 Find_shortcut::expression(Expression** pexpr)
3371 Expression* expr = *pexpr;
3372 Binary_expression* be = expr->binary_expression();
3373 if (be == NULL)
3374 return TRAVERSE_CONTINUE;
3375 Operator op = be->op();
3376 if (op != OPERATOR_OROR && op != OPERATOR_ANDAND)
3377 return TRAVERSE_CONTINUE;
3378 go_assert(this->found_ == NULL);
3379 this->found_ = pexpr;
3380 return TRAVERSE_EXIT;
3383 // A traversal class used to turn shortcut operators into explicit if
3384 // statements.
3386 class Shortcuts : public Traverse
3388 public:
3389 Shortcuts(Gogo* gogo)
3390 : Traverse(traverse_variables
3391 | traverse_statements),
3392 gogo_(gogo)
3395 protected:
3397 variable(Named_object*);
3400 statement(Block*, size_t*, Statement*);
3402 private:
3403 // Convert a shortcut operator.
3404 Statement*
3405 convert_shortcut(Block* enclosing, Expression** pshortcut);
3407 // The IR.
3408 Gogo* gogo_;
3411 // Remove shortcut operators in a single statement.
3414 Shortcuts::statement(Block* block, size_t* pindex, Statement* s)
3416 // FIXME: This approach doesn't work for switch statements, because
3417 // we add the new statements before the whole switch when we need to
3418 // instead add them just before the switch expression. The right
3419 // fix is probably to lower switch statements with nonconstant cases
3420 // to a series of conditionals.
3421 if (s->switch_statement() != NULL)
3422 return TRAVERSE_CONTINUE;
3424 while (true)
3426 Find_shortcut find_shortcut;
3428 // If S is a variable declaration, then ordinary traversal won't
3429 // do anything. We want to explicitly traverse the
3430 // initialization expression if there is one.
3431 Variable_declaration_statement* vds = s->variable_declaration_statement();
3432 Expression* init = NULL;
3433 if (vds == NULL)
3434 s->traverse_contents(&find_shortcut);
3435 else
3437 init = vds->var()->var_value()->init();
3438 if (init == NULL)
3439 return TRAVERSE_CONTINUE;
3440 init->traverse(&init, &find_shortcut);
3442 Expression** pshortcut = find_shortcut.found();
3443 if (pshortcut == NULL)
3444 return TRAVERSE_CONTINUE;
3446 Statement* snew = this->convert_shortcut(block, pshortcut);
3447 block->insert_statement_before(*pindex, snew);
3448 ++*pindex;
3450 if (pshortcut == &init)
3451 vds->var()->var_value()->set_init(init);
3455 // Remove shortcut operators in the initializer of a global variable.
3458 Shortcuts::variable(Named_object* no)
3460 if (no->is_result_variable())
3461 return TRAVERSE_CONTINUE;
3462 Variable* var = no->var_value();
3463 Expression* init = var->init();
3464 if (!var->is_global() || init == NULL)
3465 return TRAVERSE_CONTINUE;
3467 while (true)
3469 Find_shortcut find_shortcut;
3470 init->traverse(&init, &find_shortcut);
3471 Expression** pshortcut = find_shortcut.found();
3472 if (pshortcut == NULL)
3473 return TRAVERSE_CONTINUE;
3475 Statement* snew = this->convert_shortcut(NULL, pshortcut);
3476 var->add_preinit_statement(this->gogo_, snew);
3477 if (pshortcut == &init)
3478 var->set_init(init);
3482 // Given an expression which uses a shortcut operator, return a
3483 // statement which implements it, and update *PSHORTCUT accordingly.
3485 Statement*
3486 Shortcuts::convert_shortcut(Block* enclosing, Expression** pshortcut)
3488 Binary_expression* shortcut = (*pshortcut)->binary_expression();
3489 Expression* left = shortcut->left();
3490 Expression* right = shortcut->right();
3491 Location loc = shortcut->location();
3493 Block* retblock = new Block(enclosing, loc);
3494 retblock->set_end_location(loc);
3496 Temporary_statement* ts = Statement::make_temporary(shortcut->type(),
3497 left, loc);
3498 retblock->add_statement(ts);
3500 Block* block = new Block(retblock, loc);
3501 block->set_end_location(loc);
3502 Expression* tmpref = Expression::make_temporary_reference(ts, loc);
3503 Statement* assign = Statement::make_assignment(tmpref, right, loc);
3504 block->add_statement(assign);
3506 Expression* cond = Expression::make_temporary_reference(ts, loc);
3507 if (shortcut->binary_expression()->op() == OPERATOR_OROR)
3508 cond = Expression::make_unary(OPERATOR_NOT, cond, loc);
3510 Statement* if_statement = Statement::make_if_statement(cond, block, NULL,
3511 loc);
3512 retblock->add_statement(if_statement);
3514 *pshortcut = Expression::make_temporary_reference(ts, loc);
3516 delete shortcut;
3518 // Now convert any shortcut operators in LEFT and RIGHT.
3519 Shortcuts shortcuts(this->gogo_);
3520 retblock->traverse(&shortcuts);
3522 return Statement::make_block_statement(retblock, loc);
3525 // Turn shortcut operators into explicit if statements. Doing this
3526 // considerably simplifies the order of evaluation rules.
3528 void
3529 Gogo::remove_shortcuts()
3531 Shortcuts shortcuts(this);
3532 this->traverse(&shortcuts);
3535 // A traversal class which finds all the expressions which must be
3536 // evaluated in order within a statement or larger expression. This
3537 // is used to implement the rules about order of evaluation.
3539 class Find_eval_ordering : public Traverse
3541 private:
3542 typedef std::vector<Expression**> Expression_pointers;
3544 public:
3545 Find_eval_ordering()
3546 : Traverse(traverse_blocks
3547 | traverse_statements
3548 | traverse_expressions),
3549 exprs_()
3552 size_t
3553 size() const
3554 { return this->exprs_.size(); }
3556 typedef Expression_pointers::const_iterator const_iterator;
3558 const_iterator
3559 begin() const
3560 { return this->exprs_.begin(); }
3562 const_iterator
3563 end() const
3564 { return this->exprs_.end(); }
3566 protected:
3568 block(Block*)
3569 { return TRAVERSE_SKIP_COMPONENTS; }
3572 statement(Block*, size_t*, Statement*)
3573 { return TRAVERSE_SKIP_COMPONENTS; }
3576 expression(Expression**);
3578 private:
3579 // A list of pointers to expressions with side-effects.
3580 Expression_pointers exprs_;
3583 // If an expression must be evaluated in order, put it on the list.
3586 Find_eval_ordering::expression(Expression** expression_pointer)
3588 // We have to look at subexpressions before this one.
3589 if ((*expression_pointer)->traverse_subexpressions(this) == TRAVERSE_EXIT)
3590 return TRAVERSE_EXIT;
3591 if ((*expression_pointer)->must_eval_in_order())
3592 this->exprs_.push_back(expression_pointer);
3593 return TRAVERSE_SKIP_COMPONENTS;
3596 // A traversal class for ordering evaluations.
3598 class Order_eval : public Traverse
3600 public:
3601 Order_eval(Gogo* gogo)
3602 : Traverse(traverse_variables
3603 | traverse_statements),
3604 gogo_(gogo)
3608 variable(Named_object*);
3611 statement(Block*, size_t*, Statement*);
3613 private:
3614 // The IR.
3615 Gogo* gogo_;
3618 // Implement the order of evaluation rules for a statement.
3621 Order_eval::statement(Block* block, size_t* pindex, Statement* stmt)
3623 // FIXME: This approach doesn't work for switch statements, because
3624 // we add the new statements before the whole switch when we need to
3625 // instead add them just before the switch expression. The right
3626 // fix is probably to lower switch statements with nonconstant cases
3627 // to a series of conditionals.
3628 if (stmt->switch_statement() != NULL)
3629 return TRAVERSE_CONTINUE;
3631 Find_eval_ordering find_eval_ordering;
3633 // If S is a variable declaration, then ordinary traversal won't do
3634 // anything. We want to explicitly traverse the initialization
3635 // expression if there is one.
3636 Variable_declaration_statement* vds = stmt->variable_declaration_statement();
3637 Expression* init = NULL;
3638 Expression* orig_init = NULL;
3639 if (vds == NULL)
3640 stmt->traverse_contents(&find_eval_ordering);
3641 else
3643 init = vds->var()->var_value()->init();
3644 if (init == NULL)
3645 return TRAVERSE_CONTINUE;
3646 orig_init = init;
3648 // It might seem that this could be
3649 // init->traverse_subexpressions. Unfortunately that can fail
3650 // in a case like
3651 // var err os.Error
3652 // newvar, err := call(arg())
3653 // Here newvar will have an init of call result 0 of
3654 // call(arg()). If we only traverse subexpressions, we will
3655 // only find arg(), and we won't bother to move anything out.
3656 // Then we get to the assignment to err, we will traverse the
3657 // whole statement, and this time we will find both call() and
3658 // arg(), and so we will move them out. This will cause them to
3659 // be put into temporary variables before the assignment to err
3660 // but after the declaration of newvar. To avoid that problem,
3661 // we traverse the entire expression here.
3662 Expression::traverse(&init, &find_eval_ordering);
3665 size_t c = find_eval_ordering.size();
3666 if (c == 0)
3667 return TRAVERSE_CONTINUE;
3669 // If there is only one expression with a side-effect, we can
3670 // usually leave it in place.
3671 if (c == 1)
3673 switch (stmt->classification())
3675 case Statement::STATEMENT_ASSIGNMENT:
3676 // For an assignment statement, we need to evaluate an
3677 // expression on the right hand side before we evaluate any
3678 // index expression on the left hand side, so for that case
3679 // we always move the expression. Otherwise we mishandle
3680 // m[0] = len(m) where m is a map.
3681 break;
3683 case Statement::STATEMENT_EXPRESSION:
3685 // If this is a call statement that doesn't return any
3686 // values, it will not have been counted as a value to
3687 // move. We need to move any subexpressions in case they
3688 // are themselves call statements that require passing a
3689 // closure.
3690 Expression* expr = stmt->expression_statement()->expr();
3691 if (expr->call_expression() != NULL
3692 && expr->call_expression()->result_count() == 0)
3693 break;
3694 return TRAVERSE_CONTINUE;
3697 default:
3698 // We can leave the expression in place.
3699 return TRAVERSE_CONTINUE;
3703 bool is_thunk = stmt->thunk_statement() != NULL;
3704 Expression_statement* es = stmt->expression_statement();
3705 for (Find_eval_ordering::const_iterator p = find_eval_ordering.begin();
3706 p != find_eval_ordering.end();
3707 ++p)
3709 Expression** pexpr = *p;
3711 // The last expression in a thunk will be the call passed to go
3712 // or defer, which we must not evaluate early.
3713 if (is_thunk && p + 1 == find_eval_ordering.end())
3714 break;
3716 Location loc = (*pexpr)->location();
3717 Statement* s;
3718 if ((*pexpr)->call_expression() == NULL
3719 || (*pexpr)->call_expression()->result_count() < 2)
3721 Temporary_statement* ts = Statement::make_temporary(NULL, *pexpr,
3722 loc);
3723 s = ts;
3724 *pexpr = Expression::make_temporary_reference(ts, loc);
3726 else
3728 // A call expression which returns multiple results needs to
3729 // be handled specially. We can't create a temporary
3730 // because there is no type to give it. Any actual uses of
3731 // the values will be done via Call_result_expressions.
3733 // Since a given call expression can be shared by multiple
3734 // Call_result_expressions, avoid hoisting the call the
3735 // second time we see it here. In addition, don't try to
3736 // hoist the top-level multi-return call in the statement,
3737 // since doing this would result a tree with more than one copy
3738 // of the call.
3739 if (this->remember_expression(*pexpr))
3740 s = NULL;
3741 else if (es != NULL && *pexpr == es->expr())
3742 s = NULL;
3743 else
3744 s = Statement::make_statement(*pexpr, true);
3747 if (s != NULL)
3749 block->insert_statement_before(*pindex, s);
3750 ++*pindex;
3754 if (init != orig_init)
3755 vds->var()->var_value()->set_init(init);
3757 return TRAVERSE_CONTINUE;
3760 // Implement the order of evaluation rules for the initializer of a
3761 // global variable.
3764 Order_eval::variable(Named_object* no)
3766 if (no->is_result_variable())
3767 return TRAVERSE_CONTINUE;
3768 Variable* var = no->var_value();
3769 Expression* init = var->init();
3770 if (!var->is_global() || init == NULL)
3771 return TRAVERSE_CONTINUE;
3773 Find_eval_ordering find_eval_ordering;
3774 Expression::traverse(&init, &find_eval_ordering);
3776 if (find_eval_ordering.size() <= 1)
3778 // If there is only one expression with a side-effect, we can
3779 // leave it in place.
3780 return TRAVERSE_SKIP_COMPONENTS;
3783 Expression* orig_init = init;
3785 for (Find_eval_ordering::const_iterator p = find_eval_ordering.begin();
3786 p != find_eval_ordering.end();
3787 ++p)
3789 Expression** pexpr = *p;
3790 Location loc = (*pexpr)->location();
3791 Statement* s;
3792 if ((*pexpr)->call_expression() == NULL
3793 || (*pexpr)->call_expression()->result_count() < 2)
3795 Temporary_statement* ts = Statement::make_temporary(NULL, *pexpr,
3796 loc);
3797 s = ts;
3798 *pexpr = Expression::make_temporary_reference(ts, loc);
3800 else
3802 // A call expression which returns multiple results needs to
3803 // be handled specially.
3804 s = Statement::make_statement(*pexpr, true);
3806 var->add_preinit_statement(this->gogo_, s);
3809 if (init != orig_init)
3810 var->set_init(init);
3812 return TRAVERSE_SKIP_COMPONENTS;
3815 // Use temporary variables to implement the order of evaluation rules.
3817 void
3818 Gogo::order_evaluations()
3820 Order_eval order_eval(this);
3821 this->traverse(&order_eval);
3824 // Traversal to flatten parse tree after order of evaluation rules are applied.
3826 class Flatten : public Traverse
3828 public:
3829 Flatten(Gogo* gogo, Named_object* function)
3830 : Traverse(traverse_variables
3831 | traverse_functions
3832 | traverse_statements
3833 | traverse_expressions),
3834 gogo_(gogo), function_(function), inserter_()
3837 void
3838 set_inserter(const Statement_inserter* inserter)
3839 { this->inserter_ = *inserter; }
3842 variable(Named_object*);
3845 function(Named_object*);
3848 statement(Block*, size_t* pindex, Statement*);
3851 expression(Expression**);
3853 private:
3854 // General IR.
3855 Gogo* gogo_;
3856 // The function we are traversing.
3857 Named_object* function_;
3858 // Current statement inserter for use by expressions.
3859 Statement_inserter inserter_;
3862 // Flatten variables.
3865 Flatten::variable(Named_object* no)
3867 if (!no->is_variable())
3868 return TRAVERSE_CONTINUE;
3870 if (no->is_variable() && no->var_value()->is_global())
3872 // Global variables can have loops in their initialization
3873 // expressions. This is handled in flatten_init_expression.
3874 no->var_value()->flatten_init_expression(this->gogo_, this->function_,
3875 &this->inserter_);
3876 return TRAVERSE_CONTINUE;
3879 if (!no->var_value()->is_parameter()
3880 && !no->var_value()->is_receiver()
3881 && !no->var_value()->is_closure()
3882 && no->var_value()->is_non_escaping_address_taken()
3883 && !no->var_value()->is_in_heap()
3884 && no->var_value()->toplevel_decl() == NULL)
3886 // Local variable that has address taken but not escape.
3887 // It needs to be live beyond its lexical scope. So we
3888 // create a top-level declaration for it.
3889 // No need to do it if it is already in the top level.
3890 Block* top_block = function_->func_value()->block();
3891 if (top_block->bindings()->lookup_local(no->name()) != no)
3893 Variable* var = no->var_value();
3894 Temporary_statement* ts =
3895 Statement::make_temporary(var->type(), NULL, var->location());
3896 ts->set_is_address_taken();
3897 top_block->add_statement_at_front(ts);
3898 var->set_toplevel_decl(ts);
3902 go_assert(!no->var_value()->has_pre_init());
3904 return TRAVERSE_SKIP_COMPONENTS;
3907 // Flatten the body of a function. Record the function while flattening it,
3908 // so that we can pass it down when flattening an expression.
3911 Flatten::function(Named_object* no)
3913 go_assert(this->function_ == NULL);
3914 this->function_ = no;
3915 int t = no->func_value()->traverse(this);
3916 this->function_ = NULL;
3918 if (t == TRAVERSE_EXIT)
3919 return t;
3920 return TRAVERSE_SKIP_COMPONENTS;
3923 // Flatten statement parse trees.
3926 Flatten::statement(Block* block, size_t* pindex, Statement* sorig)
3928 // Because we explicitly traverse the statement's contents
3929 // ourselves, we want to skip block statements here. There is
3930 // nothing to flatten in a block statement.
3931 if (sorig->is_block_statement())
3932 return TRAVERSE_CONTINUE;
3934 Statement_inserter hold_inserter(this->inserter_);
3935 this->inserter_ = Statement_inserter(block, pindex);
3937 // Flatten the expressions first.
3938 int t = sorig->traverse_contents(this);
3939 if (t == TRAVERSE_EXIT)
3941 this->inserter_ = hold_inserter;
3942 return t;
3945 // Keep flattening until nothing changes.
3946 Statement* s = sorig;
3947 while (true)
3949 Statement* snew = s->flatten(this->gogo_, this->function_, block,
3950 &this->inserter_);
3951 if (snew == s)
3952 break;
3953 s = snew;
3954 t = s->traverse_contents(this);
3955 if (t == TRAVERSE_EXIT)
3957 this->inserter_ = hold_inserter;
3958 return t;
3962 if (s != sorig)
3963 block->replace_statement(*pindex, s);
3965 this->inserter_ = hold_inserter;
3966 return TRAVERSE_SKIP_COMPONENTS;
3969 // Flatten expression parse trees.
3972 Flatten::expression(Expression** pexpr)
3974 // Keep flattening until nothing changes.
3975 while (true)
3977 Expression* e = *pexpr;
3978 if (e->traverse_subexpressions(this) == TRAVERSE_EXIT)
3979 return TRAVERSE_EXIT;
3981 Expression* enew = e->flatten(this->gogo_, this->function_,
3982 &this->inserter_);
3983 if (enew == e)
3984 break;
3985 *pexpr = enew;
3987 return TRAVERSE_SKIP_COMPONENTS;
3990 // Flatten a block.
3992 void
3993 Gogo::flatten_block(Named_object* function, Block* block)
3995 Flatten flatten(this, function);
3996 block->traverse(&flatten);
3999 // Flatten an expression. INSERTER may be NULL, in which case the
4000 // expression had better not need to create any temporaries.
4002 void
4003 Gogo::flatten_expression(Named_object* function, Statement_inserter* inserter,
4004 Expression** pexpr)
4006 Flatten flatten(this, function);
4007 if (inserter != NULL)
4008 flatten.set_inserter(inserter);
4009 flatten.expression(pexpr);
4012 void
4013 Gogo::flatten()
4015 Flatten flatten(this, NULL);
4016 this->traverse(&flatten);
4019 // Traversal to convert calls to the predeclared recover function to
4020 // pass in an argument indicating whether it can recover from a panic
4021 // or not.
4023 class Convert_recover : public Traverse
4025 public:
4026 Convert_recover(Named_object* arg)
4027 : Traverse(traverse_expressions),
4028 arg_(arg)
4031 protected:
4033 expression(Expression**);
4035 private:
4036 // The argument to pass to the function.
4037 Named_object* arg_;
4040 // Convert calls to recover.
4043 Convert_recover::expression(Expression** pp)
4045 Call_expression* ce = (*pp)->call_expression();
4046 if (ce != NULL && ce->is_recover_call())
4047 ce->set_recover_arg(Expression::make_var_reference(this->arg_,
4048 ce->location()));
4049 return TRAVERSE_CONTINUE;
4052 // Traversal for build_recover_thunks.
4054 class Build_recover_thunks : public Traverse
4056 public:
4057 Build_recover_thunks(Gogo* gogo)
4058 : Traverse(traverse_functions),
4059 gogo_(gogo)
4063 function(Named_object*);
4065 private:
4066 Expression*
4067 can_recover_arg(Location);
4069 // General IR.
4070 Gogo* gogo_;
4073 // If this function calls recover, turn it into a thunk.
4076 Build_recover_thunks::function(Named_object* orig_no)
4078 Function* orig_func = orig_no->func_value();
4079 if (!orig_func->calls_recover()
4080 || orig_func->is_recover_thunk()
4081 || orig_func->has_recover_thunk())
4082 return TRAVERSE_CONTINUE;
4084 Gogo* gogo = this->gogo_;
4085 Location location = orig_func->location();
4087 static int count;
4088 char buf[50];
4090 Function_type* orig_fntype = orig_func->type();
4091 Typed_identifier_list* new_params = new Typed_identifier_list();
4092 std::string receiver_name;
4093 if (orig_fntype->is_method())
4095 const Typed_identifier* receiver = orig_fntype->receiver();
4096 snprintf(buf, sizeof buf, "rt.%u", count);
4097 ++count;
4098 receiver_name = buf;
4099 new_params->push_back(Typed_identifier(receiver_name, receiver->type(),
4100 receiver->location()));
4102 const Typed_identifier_list* orig_params = orig_fntype->parameters();
4103 if (orig_params != NULL && !orig_params->empty())
4105 for (Typed_identifier_list::const_iterator p = orig_params->begin();
4106 p != orig_params->end();
4107 ++p)
4109 snprintf(buf, sizeof buf, "pt.%u", count);
4110 ++count;
4111 new_params->push_back(Typed_identifier(buf, p->type(),
4112 p->location()));
4115 snprintf(buf, sizeof buf, "pr.%u", count);
4116 ++count;
4117 std::string can_recover_name = buf;
4118 new_params->push_back(Typed_identifier(can_recover_name,
4119 Type::lookup_bool_type(),
4120 orig_fntype->location()));
4122 const Typed_identifier_list* orig_results = orig_fntype->results();
4123 Typed_identifier_list* new_results;
4124 if (orig_results == NULL || orig_results->empty())
4125 new_results = NULL;
4126 else
4128 new_results = new Typed_identifier_list();
4129 for (Typed_identifier_list::const_iterator p = orig_results->begin();
4130 p != orig_results->end();
4131 ++p)
4132 new_results->push_back(Typed_identifier("", p->type(), p->location()));
4135 Function_type *new_fntype = Type::make_function_type(NULL, new_params,
4136 new_results,
4137 orig_fntype->location());
4138 if (orig_fntype->is_varargs())
4139 new_fntype->set_is_varargs();
4141 Type* rtype = NULL;
4142 if (orig_fntype->is_method())
4143 rtype = orig_fntype->receiver()->type();
4144 std::string name(gogo->recover_thunk_name(orig_no->name(), rtype));
4145 Named_object *new_no = gogo->start_function(name, new_fntype, false,
4146 location);
4147 Function *new_func = new_no->func_value();
4148 if (orig_func->enclosing() != NULL)
4149 new_func->set_enclosing(orig_func->enclosing());
4151 // We build the code for the original function attached to the new
4152 // function, and then swap the original and new function bodies.
4153 // This means that existing references to the original function will
4154 // then refer to the new function. That makes this code a little
4155 // confusing, in that the reference to NEW_NO really refers to the
4156 // other function, not the one we are building.
4158 Expression* closure = NULL;
4159 if (orig_func->needs_closure())
4161 // For the new function we are creating, declare a new parameter
4162 // variable NEW_CLOSURE_NO and set it to be the closure variable
4163 // of the function. This will be set to the closure value
4164 // passed in by the caller. Then pass a reference to this
4165 // variable as the closure value when calling the original
4166 // function. In other words, simply pass the closure value
4167 // through the thunk we are creating.
4168 Named_object* orig_closure_no = orig_func->closure_var();
4169 Variable* orig_closure_var = orig_closure_no->var_value();
4170 Variable* new_var = new Variable(orig_closure_var->type(), NULL, false,
4171 false, false, location);
4172 new_var->set_is_closure();
4173 snprintf(buf, sizeof buf, "closure.%u", count);
4174 ++count;
4175 Named_object* new_closure_no = Named_object::make_variable(buf, NULL,
4176 new_var);
4177 new_func->set_closure_var(new_closure_no);
4178 closure = Expression::make_var_reference(new_closure_no, location);
4181 Expression* fn = Expression::make_func_reference(new_no, closure, location);
4183 Expression_list* args = new Expression_list();
4184 if (new_params != NULL)
4186 // Note that we skip the last parameter, which is the boolean
4187 // indicating whether recover can succed.
4188 for (Typed_identifier_list::const_iterator p = new_params->begin();
4189 p + 1 != new_params->end();
4190 ++p)
4192 Named_object* p_no = gogo->lookup(p->name(), NULL);
4193 go_assert(p_no != NULL
4194 && p_no->is_variable()
4195 && p_no->var_value()->is_parameter());
4196 args->push_back(Expression::make_var_reference(p_no, location));
4199 args->push_back(this->can_recover_arg(location));
4201 gogo->start_block(location);
4203 Call_expression* call = Expression::make_call(fn, args, false, location);
4205 // Any varargs call has already been lowered.
4206 call->set_varargs_are_lowered();
4208 Statement* s = Statement::make_return_from_call(call, location);
4209 s->determine_types();
4210 gogo->add_statement(s);
4212 Block* b = gogo->finish_block(location);
4214 gogo->add_block(b, location);
4216 // Lower the call in case it returns multiple results.
4217 gogo->lower_block(new_no, b);
4219 gogo->finish_function(location);
4221 // Swap the function bodies and types.
4222 new_func->swap_for_recover(orig_func);
4223 orig_func->set_is_recover_thunk();
4224 new_func->set_calls_recover();
4225 new_func->set_has_recover_thunk();
4227 Bindings* orig_bindings = orig_func->block()->bindings();
4228 Bindings* new_bindings = new_func->block()->bindings();
4229 if (orig_fntype->is_method())
4231 // We changed the receiver to be a regular parameter. We have
4232 // to update the binding accordingly in both functions.
4233 Named_object* orig_rec_no = orig_bindings->lookup_local(receiver_name);
4234 go_assert(orig_rec_no != NULL
4235 && orig_rec_no->is_variable()
4236 && !orig_rec_no->var_value()->is_receiver());
4237 orig_rec_no->var_value()->set_is_receiver();
4239 std::string new_receiver_name(orig_fntype->receiver()->name());
4240 if (new_receiver_name.empty())
4242 // Find the receiver. It was named "r.NNN" in
4243 // Gogo::start_function.
4244 for (Bindings::const_definitions_iterator p =
4245 new_bindings->begin_definitions();
4246 p != new_bindings->end_definitions();
4247 ++p)
4249 const std::string& pname((*p)->name());
4250 if (pname[0] == 'r' && pname[1] == '.')
4252 new_receiver_name = pname;
4253 break;
4256 go_assert(!new_receiver_name.empty());
4258 Named_object* new_rec_no = new_bindings->lookup_local(new_receiver_name);
4259 if (new_rec_no == NULL)
4260 go_assert(saw_errors());
4261 else
4263 go_assert(new_rec_no->is_variable()
4264 && new_rec_no->var_value()->is_receiver());
4265 new_rec_no->var_value()->set_is_not_receiver();
4269 // Because we flipped blocks but not types, the can_recover
4270 // parameter appears in the (now) old bindings as a parameter.
4271 // Change it to a local variable, whereupon it will be discarded.
4272 Named_object* can_recover_no = orig_bindings->lookup_local(can_recover_name);
4273 go_assert(can_recover_no != NULL
4274 && can_recover_no->is_variable()
4275 && can_recover_no->var_value()->is_parameter());
4276 orig_bindings->remove_binding(can_recover_no);
4278 // Add the can_recover argument to the (now) new bindings, and
4279 // attach it to any recover statements.
4280 Variable* can_recover_var = new Variable(Type::lookup_bool_type(), NULL,
4281 false, true, false, location);
4282 can_recover_no = new_bindings->add_variable(can_recover_name, NULL,
4283 can_recover_var);
4284 Convert_recover convert_recover(can_recover_no);
4285 new_func->traverse(&convert_recover);
4287 // Update the function pointers in any named results.
4288 new_func->update_result_variables();
4289 orig_func->update_result_variables();
4291 return TRAVERSE_CONTINUE;
4294 // Return the expression to pass for the .can_recover parameter to the
4295 // new function. This indicates whether a call to recover may return
4296 // non-nil. The expression is runtime.canrecover(__builtin_return_address()).
4298 Expression*
4299 Build_recover_thunks::can_recover_arg(Location location)
4301 static Named_object* builtin_return_address;
4302 if (builtin_return_address == NULL)
4303 builtin_return_address =
4304 Gogo::declare_builtin_rf_address("__builtin_return_address");
4306 static Named_object* can_recover;
4307 if (can_recover == NULL)
4309 const Location bloc = Linemap::predeclared_location();
4310 Typed_identifier_list* param_types = new Typed_identifier_list();
4311 Type* voidptr_type = Type::make_pointer_type(Type::make_void_type());
4312 param_types->push_back(Typed_identifier("a", voidptr_type, bloc));
4313 Type* boolean_type = Type::lookup_bool_type();
4314 Typed_identifier_list* results = new Typed_identifier_list();
4315 results->push_back(Typed_identifier("", boolean_type, bloc));
4316 Function_type* fntype = Type::make_function_type(NULL, param_types,
4317 results, bloc);
4318 can_recover =
4319 Named_object::make_function_declaration("runtime_canrecover",
4320 NULL, fntype, bloc);
4321 can_recover->func_declaration_value()->set_asm_name("runtime.canrecover");
4324 Expression* fn = Expression::make_func_reference(builtin_return_address,
4325 NULL, location);
4327 Expression* zexpr = Expression::make_integer_ul(0, NULL, location);
4328 Expression_list *args = new Expression_list();
4329 args->push_back(zexpr);
4331 Expression* call = Expression::make_call(fn, args, false, location);
4333 args = new Expression_list();
4334 args->push_back(call);
4336 fn = Expression::make_func_reference(can_recover, NULL, location);
4337 return Expression::make_call(fn, args, false, location);
4340 // Build thunks for functions which call recover. We build a new
4341 // function with an extra parameter, which is whether a call to
4342 // recover can succeed. We then move the body of this function to
4343 // that one. We then turn this function into a thunk which calls the
4344 // new one, passing the value of runtime.canrecover(__builtin_return_address()).
4345 // The function will be marked as not splitting the stack. This will
4346 // cooperate with the implementation of defer to make recover do the
4347 // right thing.
4349 void
4350 Gogo::build_recover_thunks()
4352 Build_recover_thunks build_recover_thunks(this);
4353 this->traverse(&build_recover_thunks);
4356 // Return a declaration for __builtin_return_address or
4357 // __builtin_frame_address.
4359 Named_object*
4360 Gogo::declare_builtin_rf_address(const char* name)
4362 const Location bloc = Linemap::predeclared_location();
4364 Typed_identifier_list* param_types = new Typed_identifier_list();
4365 Type* uint32_type = Type::lookup_integer_type("uint32");
4366 param_types->push_back(Typed_identifier("l", uint32_type, bloc));
4368 Typed_identifier_list* return_types = new Typed_identifier_list();
4369 Type* voidptr_type = Type::make_pointer_type(Type::make_void_type());
4370 return_types->push_back(Typed_identifier("", voidptr_type, bloc));
4372 Function_type* fntype = Type::make_function_type(NULL, param_types,
4373 return_types, bloc);
4374 Named_object* ret = Named_object::make_function_declaration(name, NULL,
4375 fntype, bloc);
4376 ret->func_declaration_value()->set_asm_name(name);
4377 return ret;
4380 // Build a call to the runtime error function.
4382 Expression*
4383 Gogo::runtime_error(int code, Location location)
4385 Type* int32_type = Type::lookup_integer_type("int32");
4386 Expression* code_expr = Expression::make_integer_ul(code, int32_type,
4387 location);
4388 return Runtime::make_call(Runtime::RUNTIME_ERROR, location, 1, code_expr);
4391 // Look for named types to see whether we need to create an interface
4392 // method table.
4394 class Build_method_tables : public Traverse
4396 public:
4397 Build_method_tables(Gogo* gogo,
4398 const std::vector<Interface_type*>& interfaces)
4399 : Traverse(traverse_types),
4400 gogo_(gogo), interfaces_(interfaces)
4404 type(Type*);
4406 private:
4407 // The IR.
4408 Gogo* gogo_;
4409 // A list of locally defined interfaces which have hidden methods.
4410 const std::vector<Interface_type*>& interfaces_;
4413 // Build all required interface method tables for types. We need to
4414 // ensure that we have an interface method table for every interface
4415 // which has a hidden method, for every named type which implements
4416 // that interface. Normally we can just build interface method tables
4417 // as we need them. However, in some cases we can require an
4418 // interface method table for an interface defined in a different
4419 // package for a type defined in that package. If that interface and
4420 // type both use a hidden method, that is OK. However, we will not be
4421 // able to build that interface method table when we need it, because
4422 // the type's hidden method will be static. So we have to build it
4423 // here, and just refer it from other packages as needed.
4425 void
4426 Gogo::build_interface_method_tables()
4428 if (saw_errors())
4429 return;
4431 std::vector<Interface_type*> hidden_interfaces;
4432 hidden_interfaces.reserve(this->interface_types_.size());
4433 for (std::vector<Interface_type*>::const_iterator pi =
4434 this->interface_types_.begin();
4435 pi != this->interface_types_.end();
4436 ++pi)
4438 const Typed_identifier_list* methods = (*pi)->methods();
4439 if (methods == NULL)
4440 continue;
4441 for (Typed_identifier_list::const_iterator pm = methods->begin();
4442 pm != methods->end();
4443 ++pm)
4445 if (Gogo::is_hidden_name(pm->name()))
4447 hidden_interfaces.push_back(*pi);
4448 break;
4453 if (!hidden_interfaces.empty())
4455 // Now traverse the tree looking for all named types.
4456 Build_method_tables bmt(this, hidden_interfaces);
4457 this->traverse(&bmt);
4460 // We no longer need the list of interfaces.
4462 this->interface_types_.clear();
4465 // This is called for each type. For a named type, for each of the
4466 // interfaces with hidden methods that it implements, create the
4467 // method table.
4470 Build_method_tables::type(Type* type)
4472 Named_type* nt = type->named_type();
4473 Struct_type* st = type->struct_type();
4474 if (nt != NULL || st != NULL)
4476 Translate_context context(this->gogo_, NULL, NULL, NULL);
4477 for (std::vector<Interface_type*>::const_iterator p =
4478 this->interfaces_.begin();
4479 p != this->interfaces_.end();
4480 ++p)
4482 // We ask whether a pointer to the named type implements the
4483 // interface, because a pointer can implement more methods
4484 // than a value.
4485 if (nt != NULL)
4487 if ((*p)->implements_interface(Type::make_pointer_type(nt),
4488 NULL))
4490 nt->interface_method_table(*p, false)->get_backend(&context);
4491 nt->interface_method_table(*p, true)->get_backend(&context);
4494 else
4496 if ((*p)->implements_interface(Type::make_pointer_type(st),
4497 NULL))
4499 st->interface_method_table(*p, false)->get_backend(&context);
4500 st->interface_method_table(*p, true)->get_backend(&context);
4505 return TRAVERSE_CONTINUE;
4508 // Return an expression which allocates memory to hold values of type TYPE.
4510 Expression*
4511 Gogo::allocate_memory(Type* type, Location location)
4513 Expression* td = Expression::make_type_descriptor(type, location);
4514 return Runtime::make_call(Runtime::NEW, location, 1, td);
4517 // Traversal class used to check for return statements.
4519 class Check_return_statements_traverse : public Traverse
4521 public:
4522 Check_return_statements_traverse()
4523 : Traverse(traverse_functions)
4527 function(Named_object*);
4530 // Check that a function has a return statement if it needs one.
4533 Check_return_statements_traverse::function(Named_object* no)
4535 Function* func = no->func_value();
4536 const Function_type* fntype = func->type();
4537 const Typed_identifier_list* results = fntype->results();
4539 // We only need a return statement if there is a return value.
4540 if (results == NULL || results->empty())
4541 return TRAVERSE_CONTINUE;
4543 if (func->block()->may_fall_through())
4544 go_error_at(func->block()->end_location(),
4545 "missing return at end of function");
4547 return TRAVERSE_CONTINUE;
4550 // Check return statements.
4552 void
4553 Gogo::check_return_statements()
4555 Check_return_statements_traverse traverse;
4556 this->traverse(&traverse);
4559 // Export identifiers as requested.
4561 void
4562 Gogo::do_exports()
4564 // For now we always stream to a section. Later we may want to
4565 // support streaming to a separate file.
4566 Stream_to_section stream(this->backend());
4568 // Write out either the prefix or pkgpath depending on how we were
4569 // invoked.
4570 std::string prefix;
4571 std::string pkgpath;
4572 if (this->pkgpath_from_option_)
4573 pkgpath = this->pkgpath_;
4574 else if (this->prefix_from_option_)
4575 prefix = this->prefix_;
4576 else if (this->is_main_package())
4577 pkgpath = "main";
4578 else
4579 prefix = "go";
4581 Export exp(&stream);
4582 exp.register_builtin_types(this);
4583 exp.export_globals(this->package_name(),
4584 prefix,
4585 pkgpath,
4586 this->packages_,
4587 this->imports_,
4588 (this->need_init_fn_ && !this->is_main_package()
4589 ? this->get_init_fn_name()
4590 : ""),
4591 this->imported_init_fns_,
4592 this->package_->bindings());
4594 if (!this->c_header_.empty() && !saw_errors())
4595 this->write_c_header();
4598 // Write the top level named struct types in C format to a C header
4599 // file. This is used when building the runtime package, to share
4600 // struct definitions between C and Go.
4602 void
4603 Gogo::write_c_header()
4605 std::ofstream out;
4606 out.open(this->c_header_.c_str());
4607 if (out.fail())
4609 go_error_at(Linemap::unknown_location(),
4610 "cannot open %s: %m", this->c_header_.c_str());
4611 return;
4614 std::list<Named_object*> types;
4615 Bindings* top = this->package_->bindings();
4616 for (Bindings::const_definitions_iterator p = top->begin_definitions();
4617 p != top->end_definitions();
4618 ++p)
4620 Named_object* no = *p;
4622 // Skip names that start with underscore followed by something
4623 // other than an uppercase letter, as when compiling the runtime
4624 // package they are mostly types defined by mkrsysinfo.sh based
4625 // on the C system header files. We don't need to translate
4626 // types to C and back to Go. But do accept the special cases
4627 // _defer and _panic.
4628 std::string name = Gogo::unpack_hidden_name(no->name());
4629 if (name[0] == '_'
4630 && (name[1] < 'A' || name[1] > 'Z')
4631 && (name != "_defer" && name != "_panic"))
4632 continue;
4634 if (no->is_type() && no->type_value()->struct_type() != NULL)
4635 types.push_back(no);
4636 if (no->is_const() && no->const_value()->type()->integer_type() != NULL)
4638 Numeric_constant nc;
4639 unsigned long val;
4640 if (no->const_value()->expr()->numeric_constant_value(&nc)
4641 && nc.to_unsigned_long(&val) == Numeric_constant::NC_UL_VALID)
4643 out << "#define " << no->message_name() << ' ' << val
4644 << std::endl;
4649 std::vector<const Named_object*> written;
4650 int loop = 0;
4651 while (!types.empty())
4653 Named_object* no = types.front();
4654 types.pop_front();
4656 std::vector<const Named_object*> requires;
4657 std::vector<const Named_object*> declare;
4658 if (!no->type_value()->struct_type()->can_write_to_c_header(&requires,
4659 &declare))
4660 continue;
4662 bool ok = true;
4663 for (std::vector<const Named_object*>::const_iterator pr
4664 = requires.begin();
4665 pr != requires.end() && ok;
4666 ++pr)
4668 for (std::list<Named_object*>::const_iterator pt = types.begin();
4669 pt != types.end() && ok;
4670 ++pt)
4671 if (*pr == *pt)
4672 ok = false;
4674 if (!ok)
4676 ++loop;
4677 if (loop > 10000)
4679 // This should be impossible since the code parsed and
4680 // type checked.
4681 go_unreachable();
4684 types.push_back(no);
4685 continue;
4688 for (std::vector<const Named_object*>::const_iterator pd
4689 = declare.begin();
4690 pd != declare.end();
4691 ++pd)
4693 if (*pd == no)
4694 continue;
4696 std::vector<const Named_object*> drequires;
4697 std::vector<const Named_object*> ddeclare;
4698 if (!(*pd)->type_value()->struct_type()->
4699 can_write_to_c_header(&drequires, &ddeclare))
4700 continue;
4702 bool done = false;
4703 for (std::vector<const Named_object*>::const_iterator pw
4704 = written.begin();
4705 pw != written.end();
4706 ++pw)
4708 if (*pw == *pd)
4710 done = true;
4711 break;
4714 if (!done)
4716 out << std::endl;
4717 out << "struct " << (*pd)->message_name() << ";" << std::endl;
4718 written.push_back(*pd);
4722 out << std::endl;
4723 out << "struct " << no->message_name() << " {" << std::endl;
4724 no->type_value()->struct_type()->write_to_c_header(out);
4725 out << "};" << std::endl;
4726 written.push_back(no);
4729 out.close();
4730 if (out.fail())
4731 go_error_at(Linemap::unknown_location(),
4732 "error writing to %s: %m", this->c_header_.c_str());
4735 // Find the blocks in order to convert named types defined in blocks.
4737 class Convert_named_types : public Traverse
4739 public:
4740 Convert_named_types(Gogo* gogo)
4741 : Traverse(traverse_blocks),
4742 gogo_(gogo)
4745 protected:
4747 block(Block* block);
4749 private:
4750 Gogo* gogo_;
4754 Convert_named_types::block(Block* block)
4756 this->gogo_->convert_named_types_in_bindings(block->bindings());
4757 return TRAVERSE_CONTINUE;
4760 // Convert all named types to the backend representation. Since named
4761 // types can refer to other types, this needs to be done in the right
4762 // sequence, which is handled by Named_type::convert. Here we arrange
4763 // to call that for each named type.
4765 void
4766 Gogo::convert_named_types()
4768 this->convert_named_types_in_bindings(this->globals_);
4769 for (Packages::iterator p = this->packages_.begin();
4770 p != this->packages_.end();
4771 ++p)
4773 Package* package = p->second;
4774 this->convert_named_types_in_bindings(package->bindings());
4777 Convert_named_types cnt(this);
4778 this->traverse(&cnt);
4780 // Make all the builtin named types used for type descriptors, and
4781 // then convert them. They will only be written out if they are
4782 // needed.
4783 Type::make_type_descriptor_type();
4784 Type::make_type_descriptor_ptr_type();
4785 Function_type::make_function_type_descriptor_type();
4786 Pointer_type::make_pointer_type_descriptor_type();
4787 Struct_type::make_struct_type_descriptor_type();
4788 Array_type::make_array_type_descriptor_type();
4789 Array_type::make_slice_type_descriptor_type();
4790 Map_type::make_map_type_descriptor_type();
4791 Channel_type::make_chan_type_descriptor_type();
4792 Interface_type::make_interface_type_descriptor_type();
4793 Expression::make_func_descriptor_type();
4794 Type::convert_builtin_named_types(this);
4796 Runtime::convert_types(this);
4798 this->named_types_are_converted_ = true;
4800 Type::finish_pointer_types(this);
4803 // Convert all names types in a set of bindings.
4805 void
4806 Gogo::convert_named_types_in_bindings(Bindings* bindings)
4808 for (Bindings::const_definitions_iterator p = bindings->begin_definitions();
4809 p != bindings->end_definitions();
4810 ++p)
4812 if ((*p)->is_type())
4813 (*p)->type_value()->convert(this);
4817 // Class Function.
4819 Function::Function(Function_type* type, Named_object* enclosing, Block* block,
4820 Location location)
4821 : type_(type), enclosing_(enclosing), results_(NULL),
4822 closure_var_(NULL), block_(block), location_(location), labels_(),
4823 local_type_count_(0), descriptor_(NULL), fndecl_(NULL), defer_stack_(NULL),
4824 pragmas_(0), nested_functions_(0), is_sink_(false),
4825 results_are_named_(false), is_unnamed_type_stub_method_(false),
4826 calls_recover_(false), is_recover_thunk_(false), has_recover_thunk_(false),
4827 calls_defer_retaddr_(false), is_type_specific_function_(false),
4828 in_unique_section_(false)
4832 // Create the named result variables.
4834 void
4835 Function::create_result_variables(Gogo* gogo)
4837 const Typed_identifier_list* results = this->type_->results();
4838 if (results == NULL || results->empty())
4839 return;
4841 if (!results->front().name().empty())
4842 this->results_are_named_ = true;
4844 this->results_ = new Results();
4845 this->results_->reserve(results->size());
4847 Block* block = this->block_;
4848 int index = 0;
4849 for (Typed_identifier_list::const_iterator p = results->begin();
4850 p != results->end();
4851 ++p, ++index)
4853 std::string name = p->name();
4854 if (name.empty() || Gogo::is_sink_name(name))
4856 static int result_counter;
4857 char buf[100];
4858 snprintf(buf, sizeof buf, "$ret%d", result_counter);
4859 ++result_counter;
4860 name = gogo->pack_hidden_name(buf, false);
4862 Result_variable* result = new Result_variable(p->type(), this, index,
4863 p->location());
4864 Named_object* no = block->bindings()->add_result_variable(name, result);
4865 if (no->is_result_variable())
4866 this->results_->push_back(no);
4867 else
4869 static int dummy_result_count;
4870 char buf[100];
4871 snprintf(buf, sizeof buf, "$dret%d", dummy_result_count);
4872 ++dummy_result_count;
4873 name = gogo->pack_hidden_name(buf, false);
4874 no = block->bindings()->add_result_variable(name, result);
4875 go_assert(no->is_result_variable());
4876 this->results_->push_back(no);
4881 // Update the named result variables when cloning a function which
4882 // calls recover.
4884 void
4885 Function::update_result_variables()
4887 if (this->results_ == NULL)
4888 return;
4890 for (Results::iterator p = this->results_->begin();
4891 p != this->results_->end();
4892 ++p)
4893 (*p)->result_var_value()->set_function(this);
4896 // Whether this method should not be included in the type descriptor.
4898 bool
4899 Function::nointerface() const
4901 go_assert(this->is_method());
4902 return (this->pragmas_ & GOPRAGMA_NOINTERFACE) != 0;
4905 // Record that this method should not be included in the type
4906 // descriptor.
4908 void
4909 Function::set_nointerface()
4911 this->pragmas_ |= GOPRAGMA_NOINTERFACE;
4914 // Return the closure variable, creating it if necessary.
4916 Named_object*
4917 Function::closure_var()
4919 if (this->closure_var_ == NULL)
4921 go_assert(this->descriptor_ == NULL);
4922 // We don't know the type of the variable yet. We add fields as
4923 // we find them.
4924 Location loc = this->type_->location();
4925 Struct_field_list* sfl = new Struct_field_list;
4926 Struct_type* struct_type = Type::make_struct_type(sfl, loc);
4927 struct_type->set_is_struct_incomparable();
4928 Variable* var = new Variable(Type::make_pointer_type(struct_type),
4929 NULL, false, false, false, loc);
4930 var->set_is_used();
4931 var->set_is_closure();
4932 this->closure_var_ = Named_object::make_variable("$closure", NULL, var);
4933 // Note that the new variable is not in any binding contour.
4935 return this->closure_var_;
4938 // Set the type of the closure variable.
4940 void
4941 Function::set_closure_type()
4943 if (this->closure_var_ == NULL)
4944 return;
4945 Named_object* closure = this->closure_var_;
4946 Struct_type* st = closure->var_value()->type()->deref()->struct_type();
4948 // The first field of a closure is always a pointer to the function
4949 // code.
4950 Type* voidptr_type = Type::make_pointer_type(Type::make_void_type());
4951 st->push_field(Struct_field(Typed_identifier(".f", voidptr_type,
4952 this->location_)));
4954 unsigned int index = 1;
4955 for (Closure_fields::const_iterator p = this->closure_fields_.begin();
4956 p != this->closure_fields_.end();
4957 ++p, ++index)
4959 Named_object* no = p->first;
4960 char buf[20];
4961 snprintf(buf, sizeof buf, "%u", index);
4962 std::string n = no->name() + buf;
4963 Type* var_type;
4964 if (no->is_variable())
4965 var_type = no->var_value()->type();
4966 else
4967 var_type = no->result_var_value()->type();
4968 Type* field_type = Type::make_pointer_type(var_type);
4969 st->push_field(Struct_field(Typed_identifier(n, field_type, p->second)));
4973 // Return whether this function is a method.
4975 bool
4976 Function::is_method() const
4978 return this->type_->is_method();
4981 // Add a label definition.
4983 Label*
4984 Function::add_label_definition(Gogo* gogo, const std::string& label_name,
4985 Location location)
4987 Label* lnull = NULL;
4988 std::pair<Labels::iterator, bool> ins =
4989 this->labels_.insert(std::make_pair(label_name, lnull));
4990 Label* label;
4991 if (label_name == "_")
4993 label = Label::create_dummy_label();
4994 if (ins.second)
4995 ins.first->second = label;
4997 else if (ins.second)
4999 // This is a new label.
5000 label = new Label(label_name);
5001 ins.first->second = label;
5003 else
5005 // The label was already in the hash table.
5006 label = ins.first->second;
5007 if (label->is_defined())
5009 go_error_at(location, "label %qs already defined",
5010 Gogo::message_name(label_name).c_str());
5011 go_inform(label->location(), "previous definition of %qs was here",
5012 Gogo::message_name(label_name).c_str());
5013 return new Label(label_name);
5017 label->define(location, gogo->bindings_snapshot(location));
5019 // Issue any errors appropriate for any previous goto's to this
5020 // label.
5021 const std::vector<Bindings_snapshot*>& refs(label->refs());
5022 for (std::vector<Bindings_snapshot*>::const_iterator p = refs.begin();
5023 p != refs.end();
5024 ++p)
5025 (*p)->check_goto_to(gogo->current_block());
5026 label->clear_refs();
5028 return label;
5031 // Add a reference to a label.
5033 Label*
5034 Function::add_label_reference(Gogo* gogo, const std::string& label_name,
5035 Location location, bool issue_goto_errors)
5037 Label* lnull = NULL;
5038 std::pair<Labels::iterator, bool> ins =
5039 this->labels_.insert(std::make_pair(label_name, lnull));
5040 Label* label;
5041 if (!ins.second)
5043 // The label was already in the hash table.
5044 label = ins.first->second;
5046 else
5048 go_assert(ins.first->second == NULL);
5049 label = new Label(label_name);
5050 ins.first->second = label;
5053 label->set_is_used();
5055 if (issue_goto_errors)
5057 Bindings_snapshot* snapshot = label->snapshot();
5058 if (snapshot != NULL)
5059 snapshot->check_goto_from(gogo->current_block(), location);
5060 else
5061 label->add_snapshot_ref(gogo->bindings_snapshot(location));
5064 return label;
5067 // Warn about labels that are defined but not used.
5069 void
5070 Function::check_labels() const
5072 for (Labels::const_iterator p = this->labels_.begin();
5073 p != this->labels_.end();
5074 p++)
5076 Label* label = p->second;
5077 if (!label->is_used())
5078 go_error_at(label->location(), "label %qs defined and not used",
5079 Gogo::message_name(label->name()).c_str());
5083 // Swap one function with another. This is used when building the
5084 // thunk we use to call a function which calls recover. It may not
5085 // work for any other case.
5087 void
5088 Function::swap_for_recover(Function *x)
5090 go_assert(this->enclosing_ == x->enclosing_);
5091 std::swap(this->results_, x->results_);
5092 std::swap(this->closure_var_, x->closure_var_);
5093 std::swap(this->block_, x->block_);
5094 go_assert(this->location_ == x->location_);
5095 go_assert(this->fndecl_ == NULL && x->fndecl_ == NULL);
5096 go_assert(this->defer_stack_ == NULL && x->defer_stack_ == NULL);
5099 // Traverse the tree.
5102 Function::traverse(Traverse* traverse)
5104 unsigned int traverse_mask = traverse->traverse_mask();
5106 if ((traverse_mask
5107 & (Traverse::traverse_types | Traverse::traverse_expressions))
5108 != 0)
5110 if (Type::traverse(this->type_, traverse) == TRAVERSE_EXIT)
5111 return TRAVERSE_EXIT;
5114 // FIXME: We should check traverse_functions here if nested
5115 // functions are stored in block bindings.
5116 if (this->block_ != NULL
5117 && (traverse_mask
5118 & (Traverse::traverse_variables
5119 | Traverse::traverse_constants
5120 | Traverse::traverse_blocks
5121 | Traverse::traverse_statements
5122 | Traverse::traverse_expressions
5123 | Traverse::traverse_types)) != 0)
5125 if (this->block_->traverse(traverse) == TRAVERSE_EXIT)
5126 return TRAVERSE_EXIT;
5129 return TRAVERSE_CONTINUE;
5132 // Work out types for unspecified variables and constants.
5134 void
5135 Function::determine_types()
5137 if (this->block_ != NULL)
5138 this->block_->determine_types();
5141 // Return the function descriptor, the value you get when you refer to
5142 // the function in Go code without calling it.
5144 Expression*
5145 Function::descriptor(Gogo*, Named_object* no)
5147 go_assert(!this->is_method());
5148 go_assert(this->closure_var_ == NULL);
5149 if (this->descriptor_ == NULL)
5150 this->descriptor_ = Expression::make_func_descriptor(no);
5151 return this->descriptor_;
5154 // Get a pointer to the variable representing the defer stack for this
5155 // function, making it if necessary. The value of the variable is set
5156 // by the runtime routines to true if the function is returning,
5157 // rather than panicing through. A pointer to this variable is used
5158 // as a marker for the functions on the defer stack associated with
5159 // this function. A function-specific variable permits inlining a
5160 // function which uses defer.
5162 Expression*
5163 Function::defer_stack(Location location)
5165 if (this->defer_stack_ == NULL)
5167 Type* t = Type::lookup_bool_type();
5168 Expression* n = Expression::make_boolean(false, location);
5169 this->defer_stack_ = Statement::make_temporary(t, n, location);
5170 this->defer_stack_->set_is_address_taken();
5172 Expression* ref = Expression::make_temporary_reference(this->defer_stack_,
5173 location);
5174 return Expression::make_unary(OPERATOR_AND, ref, location);
5177 // Export the function.
5179 void
5180 Function::export_func(Export* exp, const std::string& name) const
5182 Function::export_func_with_type(exp, name, this->type_);
5185 // Export a function with a type.
5187 void
5188 Function::export_func_with_type(Export* exp, const std::string& name,
5189 const Function_type* fntype)
5191 exp->write_c_string("func ");
5193 if (fntype->is_method())
5195 exp->write_c_string("(");
5196 const Typed_identifier* receiver = fntype->receiver();
5197 exp->write_name(receiver->name());
5198 exp->write_escape(receiver->note());
5199 exp->write_c_string(" ");
5200 exp->write_type(receiver->type());
5201 exp->write_c_string(") ");
5204 exp->write_string(name);
5206 exp->write_c_string(" (");
5207 const Typed_identifier_list* parameters = fntype->parameters();
5208 if (parameters != NULL)
5210 size_t i = 0;
5211 bool is_varargs = fntype->is_varargs();
5212 bool first = true;
5213 for (Typed_identifier_list::const_iterator p = parameters->begin();
5214 p != parameters->end();
5215 ++p, ++i)
5217 if (first)
5218 first = false;
5219 else
5220 exp->write_c_string(", ");
5221 exp->write_name(p->name());
5222 exp->write_escape(p->note());
5223 exp->write_c_string(" ");
5224 if (!is_varargs || p + 1 != parameters->end())
5225 exp->write_type(p->type());
5226 else
5228 exp->write_c_string("...");
5229 exp->write_type(p->type()->array_type()->element_type());
5233 exp->write_c_string(")");
5235 const Typed_identifier_list* results = fntype->results();
5236 if (results != NULL)
5238 if (results->size() == 1 && results->begin()->name().empty())
5240 exp->write_c_string(" ");
5241 exp->write_type(results->begin()->type());
5243 else
5245 exp->write_c_string(" (");
5246 bool first = true;
5247 for (Typed_identifier_list::const_iterator p = results->begin();
5248 p != results->end();
5249 ++p)
5251 if (first)
5252 first = false;
5253 else
5254 exp->write_c_string(", ");
5255 exp->write_name(p->name());
5256 exp->write_escape(p->note());
5257 exp->write_c_string(" ");
5258 exp->write_type(p->type());
5260 exp->write_c_string(")");
5263 exp->write_c_string(";\n");
5266 // Import a function.
5268 void
5269 Function::import_func(Import* imp, std::string* pname,
5270 Typed_identifier** preceiver,
5271 Typed_identifier_list** pparameters,
5272 Typed_identifier_list** presults,
5273 bool* is_varargs)
5275 imp->require_c_string("func ");
5277 *preceiver = NULL;
5278 if (imp->peek_char() == '(')
5280 imp->require_c_string("(");
5281 std::string name = imp->read_name();
5282 std::string escape_note = imp->read_escape();
5283 imp->require_c_string(" ");
5284 Type* rtype = imp->read_type();
5285 *preceiver = new Typed_identifier(name, rtype, imp->location());
5286 (*preceiver)->set_note(escape_note);
5287 imp->require_c_string(") ");
5290 *pname = imp->read_identifier();
5292 Typed_identifier_list* parameters;
5293 *is_varargs = false;
5294 imp->require_c_string(" (");
5295 if (imp->peek_char() == ')')
5296 parameters = NULL;
5297 else
5299 parameters = new Typed_identifier_list();
5300 while (true)
5302 std::string name = imp->read_name();
5303 std::string escape_note = imp->read_escape();
5304 imp->require_c_string(" ");
5306 if (imp->match_c_string("..."))
5308 imp->advance(3);
5309 *is_varargs = true;
5312 Type* ptype = imp->read_type();
5313 if (*is_varargs)
5314 ptype = Type::make_array_type(ptype, NULL);
5315 Typed_identifier t = Typed_identifier(name, ptype, imp->location());
5316 t.set_note(escape_note);
5317 parameters->push_back(t);
5318 if (imp->peek_char() != ',')
5319 break;
5320 go_assert(!*is_varargs);
5321 imp->require_c_string(", ");
5324 imp->require_c_string(")");
5325 *pparameters = parameters;
5327 Typed_identifier_list* results;
5328 if (imp->peek_char() != ' ')
5329 results = NULL;
5330 else
5332 results = new Typed_identifier_list();
5333 imp->require_c_string(" ");
5334 if (imp->peek_char() != '(')
5336 Type* rtype = imp->read_type();
5337 results->push_back(Typed_identifier("", rtype, imp->location()));
5339 else
5341 imp->require_c_string("(");
5342 while (true)
5344 std::string name = imp->read_name();
5345 std::string note = imp->read_escape();
5346 imp->require_c_string(" ");
5347 Type* rtype = imp->read_type();
5348 Typed_identifier t = Typed_identifier(name, rtype,
5349 imp->location());
5350 t.set_note(note);
5351 results->push_back(t);
5352 if (imp->peek_char() != ',')
5353 break;
5354 imp->require_c_string(", ");
5356 imp->require_c_string(")");
5359 imp->require_c_string(";\n");
5360 *presults = results;
5363 // Get the backend representation.
5365 Bfunction*
5366 Function::get_or_make_decl(Gogo* gogo, Named_object* no)
5368 if (this->fndecl_ == NULL)
5370 bool is_visible = false;
5371 bool is_init_fn = false;
5372 Type* rtype = NULL;
5373 if (no->package() != NULL)
5375 else if (this->enclosing_ != NULL || Gogo::is_thunk(no))
5377 else if (Gogo::unpack_hidden_name(no->name()) == "init"
5378 && !this->type_->is_method())
5380 else if (no->name() == gogo->get_init_fn_name())
5382 is_visible = true;
5383 is_init_fn = true;
5385 else if (Gogo::unpack_hidden_name(no->name()) == "main"
5386 && gogo->is_main_package())
5387 is_visible = true;
5388 // Methods have to be public even if they are hidden because
5389 // they can be pulled into type descriptors when using
5390 // anonymous fields.
5391 else if (!Gogo::is_hidden_name(no->name())
5392 || this->type_->is_method())
5394 if (!this->is_unnamed_type_stub_method_)
5395 is_visible = true;
5396 if (this->type_->is_method())
5397 rtype = this->type_->receiver()->type();
5400 std::string asm_name;
5401 if (!this->asm_name_.empty())
5403 asm_name = this->asm_name_;
5405 // If an assembler name is explicitly specified, there must
5406 // be some reason to refer to the symbol from a different
5407 // object file.
5408 is_visible = true;
5410 else if (is_init_fn)
5412 // These names appear in the export data and are used
5413 // directly in the assembler code. If we change this here
5414 // we need to change Gogo::init_imports.
5415 asm_name = no->name();
5417 else
5418 asm_name = gogo->function_asm_name(no->name(), NULL, rtype);
5420 // If a function calls the predeclared recover function, we
5421 // can't inline it, because recover behaves differently in a
5422 // function passed directly to defer. If this is a recover
5423 // thunk that we built to test whether a function can be
5424 // recovered, we can't inline it, because that will mess up
5425 // our return address comparison.
5426 bool is_inlinable = !(this->calls_recover_ || this->is_recover_thunk_);
5428 // If a function calls __go_set_defer_retaddr, then mark it as
5429 // uninlinable. This prevents the GCC backend from splitting
5430 // the function; splitting the function is a bad idea because we
5431 // want the return address label to be in the same function as
5432 // the call.
5433 if (this->calls_defer_retaddr_)
5434 is_inlinable = false;
5436 // Check the //go:noinline compiler directive.
5437 if ((this->pragmas_ & GOPRAGMA_NOINLINE) != 0)
5438 is_inlinable = false;
5440 // If this is a thunk created to call a function which calls
5441 // the predeclared recover function, we need to disable
5442 // stack splitting for the thunk.
5443 bool disable_split_stack = this->is_recover_thunk_;
5445 // Check the //go:nosplit compiler directive.
5446 if ((this->pragmas_ & GOPRAGMA_NOSPLIT) != 0)
5447 disable_split_stack = true;
5449 // This should go into a unique section if that has been
5450 // requested elsewhere, or if this is a nointerface function.
5451 // We want to put a nointerface function into a unique section
5452 // because there is a good chance that the linker garbage
5453 // collection can discard it.
5454 bool in_unique_section = (this->in_unique_section_
5455 || (this->is_method() && this->nointerface()));
5457 Btype* functype = this->type_->get_backend_fntype(gogo);
5458 this->fndecl_ =
5459 gogo->backend()->function(functype, no->get_id(gogo), asm_name,
5460 is_visible, false, is_inlinable,
5461 disable_split_stack, false,
5462 in_unique_section, this->location());
5464 return this->fndecl_;
5467 // Get the backend representation.
5469 Bfunction*
5470 Function_declaration::get_or_make_decl(Gogo* gogo, Named_object* no)
5472 if (this->fndecl_ == NULL)
5474 bool does_not_return = false;
5476 // Let Go code use an asm declaration to pick up a builtin
5477 // function.
5478 if (!this->asm_name_.empty())
5480 Bfunction* builtin_decl =
5481 gogo->backend()->lookup_builtin(this->asm_name_);
5482 if (builtin_decl != NULL)
5484 this->fndecl_ = builtin_decl;
5485 return this->fndecl_;
5488 if (this->asm_name_ == "runtime.gopanic"
5489 || this->asm_name_ == "__go_runtime_error")
5490 does_not_return = true;
5493 std::string asm_name;
5494 if (this->asm_name_.empty())
5496 Type* rtype = NULL;
5497 if (this->fntype_->is_method())
5498 rtype = this->fntype_->receiver()->type();
5499 asm_name = gogo->function_asm_name(no->name(), no->package(), rtype);
5501 else if (go_id_needs_encoding(no->get_id(gogo)))
5502 asm_name = go_encode_id(no->get_id(gogo));
5504 Btype* functype = this->fntype_->get_backend_fntype(gogo);
5505 this->fndecl_ =
5506 gogo->backend()->function(functype, no->get_id(gogo), asm_name,
5507 true, true, true, false, does_not_return,
5508 false, this->location());
5511 return this->fndecl_;
5514 // Build the descriptor for a function declaration. This won't
5515 // necessarily happen if the package has just a declaration for the
5516 // function and no other reference to it, but we may still need the
5517 // descriptor for references from other packages.
5518 void
5519 Function_declaration::build_backend_descriptor(Gogo* gogo)
5521 if (this->descriptor_ != NULL)
5523 Translate_context context(gogo, NULL, NULL, NULL);
5524 this->descriptor_->get_backend(&context);
5528 // Check that the types used in this declaration's signature are defined.
5529 // Reports errors for any undefined type.
5531 void
5532 Function_declaration::check_types() const
5534 // Calling Type::base will give errors for any undefined types.
5535 Function_type* fntype = this->type();
5536 if (fntype->receiver() != NULL)
5537 fntype->receiver()->type()->base();
5538 if (fntype->parameters() != NULL)
5540 const Typed_identifier_list* params = fntype->parameters();
5541 for (Typed_identifier_list::const_iterator p = params->begin();
5542 p != params->end();
5543 ++p)
5544 p->type()->base();
5548 // Return the function's decl after it has been built.
5550 Bfunction*
5551 Function::get_decl() const
5553 go_assert(this->fndecl_ != NULL);
5554 return this->fndecl_;
5557 // Build the backend representation for the function code.
5559 void
5560 Function::build(Gogo* gogo, Named_object* named_function)
5562 Translate_context context(gogo, named_function, NULL, NULL);
5564 // A list of parameter variables for this function.
5565 std::vector<Bvariable*> param_vars;
5567 // Variables that need to be declared for this function and their
5568 // initial values.
5569 std::vector<Bvariable*> vars;
5570 std::vector<Bexpression*> var_inits;
5571 std::vector<Statement*> var_decls_stmts;
5572 for (Bindings::const_definitions_iterator p =
5573 this->block_->bindings()->begin_definitions();
5574 p != this->block_->bindings()->end_definitions();
5575 ++p)
5577 Location loc = (*p)->location();
5578 if ((*p)->is_variable() && (*p)->var_value()->is_parameter())
5580 Bvariable* bvar = (*p)->get_backend_variable(gogo, named_function);
5581 Bvariable* parm_bvar = bvar;
5583 // We always pass the receiver to a method as a pointer. If
5584 // the receiver is declared as a non-pointer type, then we
5585 // copy the value into a local variable.
5586 if ((*p)->var_value()->is_receiver()
5587 && (*p)->var_value()->type()->points_to() == NULL)
5589 std::string name = (*p)->name() + ".pointer";
5590 Type* var_type = (*p)->var_value()->type();
5591 Variable* parm_var =
5592 new Variable(Type::make_pointer_type(var_type), NULL, false,
5593 true, false, loc);
5594 Named_object* parm_no =
5595 Named_object::make_variable(name, NULL, parm_var);
5596 parm_bvar = parm_no->get_backend_variable(gogo, named_function);
5598 vars.push_back(bvar);
5599 Expression* parm_ref =
5600 Expression::make_var_reference(parm_no, loc);
5601 parm_ref =
5602 Expression::make_dereference(parm_ref,
5603 Expression::NIL_CHECK_DEFAULT,
5604 loc);
5605 if ((*p)->var_value()->is_in_heap())
5606 parm_ref = Expression::make_heap_expression(parm_ref, loc);
5607 var_inits.push_back(parm_ref->get_backend(&context));
5609 else if ((*p)->var_value()->is_in_heap())
5611 // If we take the address of a parameter, then we need
5612 // to copy it into the heap.
5613 std::string parm_name = (*p)->name() + ".param";
5614 Variable* parm_var = new Variable((*p)->var_value()->type(), NULL,
5615 false, true, false, loc);
5616 Named_object* parm_no =
5617 Named_object::make_variable(parm_name, NULL, parm_var);
5618 parm_bvar = parm_no->get_backend_variable(gogo, named_function);
5620 vars.push_back(bvar);
5621 Expression* var_ref =
5622 Expression::make_var_reference(parm_no, loc);
5623 var_ref = Expression::make_heap_expression(var_ref, loc);
5624 var_inits.push_back(var_ref->get_backend(&context));
5626 param_vars.push_back(parm_bvar);
5628 else if ((*p)->is_result_variable())
5630 Bvariable* bvar = (*p)->get_backend_variable(gogo, named_function);
5632 Type* type = (*p)->result_var_value()->type();
5633 Bexpression* init;
5634 if (!(*p)->result_var_value()->is_in_heap())
5636 Btype* btype = type->get_backend(gogo);
5637 init = gogo->backend()->zero_expression(btype);
5639 else
5640 init = Expression::make_allocation(type,
5641 loc)->get_backend(&context);
5643 vars.push_back(bvar);
5644 var_inits.push_back(init);
5646 else if (this->defer_stack_ != NULL
5647 && (*p)->is_variable()
5648 && (*p)->var_value()->is_non_escaping_address_taken()
5649 && !(*p)->var_value()->is_in_heap())
5651 // Local variable captured by deferred closure needs to be live
5652 // until the end of the function. We create a top-level
5653 // declaration for it.
5654 // TODO: we don't need to do this if the variable is not captured
5655 // by the defer closure. There is no easy way to check it here,
5656 // so we do this for all address-taken variables for now.
5657 Variable* var = (*p)->var_value();
5658 Temporary_statement* ts =
5659 Statement::make_temporary(var->type(), NULL, var->location());
5660 ts->set_is_address_taken();
5661 var->set_toplevel_decl(ts);
5662 var_decls_stmts.push_back(ts);
5665 if (!gogo->backend()->function_set_parameters(this->fndecl_, param_vars))
5667 go_assert(saw_errors());
5668 return;
5671 // If we need a closure variable, make sure to create it.
5672 // It gets installed in the function as a side effect of creation.
5673 if (this->closure_var_ != NULL)
5675 go_assert(this->closure_var_->var_value()->is_closure());
5676 this->closure_var_->get_backend_variable(gogo, named_function);
5679 if (this->block_ != NULL)
5681 // Declare variables if necessary.
5682 Bblock* var_decls = NULL;
5683 std::vector<Bstatement*> var_decls_bstmt_list;
5684 Bstatement* defer_init = NULL;
5685 if (!vars.empty() || this->defer_stack_ != NULL)
5687 var_decls =
5688 gogo->backend()->block(this->fndecl_, NULL, vars,
5689 this->block_->start_location(),
5690 this->block_->end_location());
5692 if (this->defer_stack_ != NULL)
5694 Translate_context dcontext(gogo, named_function, this->block_,
5695 var_decls);
5696 defer_init = this->defer_stack_->get_backend(&dcontext);
5697 var_decls_bstmt_list.push_back(defer_init);
5698 for (std::vector<Statement*>::iterator p = var_decls_stmts.begin();
5699 p != var_decls_stmts.end();
5700 ++p)
5702 Bstatement* bstmt = (*p)->get_backend(&dcontext);
5703 var_decls_bstmt_list.push_back(bstmt);
5708 // Build the backend representation for all the statements in the
5709 // function.
5710 Translate_context context(gogo, named_function, NULL, NULL);
5711 Bblock* code_block = this->block_->get_backend(&context);
5713 // Initialize variables if necessary.
5714 std::vector<Bstatement*> init;
5715 go_assert(vars.size() == var_inits.size());
5716 for (size_t i = 0; i < vars.size(); ++i)
5718 Bstatement* init_stmt =
5719 gogo->backend()->init_statement(this->fndecl_, vars[i],
5720 var_inits[i]);
5721 init.push_back(init_stmt);
5723 Bstatement* var_init = gogo->backend()->statement_list(init);
5725 // Initialize all variables before executing this code block.
5726 Bstatement* code_stmt = gogo->backend()->block_statement(code_block);
5727 code_stmt = gogo->backend()->compound_statement(var_init, code_stmt);
5729 // If we have a defer stack, initialize it at the start of a
5730 // function.
5731 Bstatement* except = NULL;
5732 Bstatement* fini = NULL;
5733 if (defer_init != NULL)
5735 // Clean up the defer stack when we leave the function.
5736 this->build_defer_wrapper(gogo, named_function, &except, &fini);
5738 // Wrap the code for this function in an exception handler to handle
5739 // defer calls.
5740 code_stmt =
5741 gogo->backend()->exception_handler_statement(code_stmt,
5742 except, fini,
5743 this->location_);
5746 // Stick the code into the block we built for the receiver, if
5747 // we built one.
5748 if (var_decls != NULL)
5750 var_decls_bstmt_list.push_back(code_stmt);
5751 gogo->backend()->block_add_statements(var_decls, var_decls_bstmt_list);
5752 code_stmt = gogo->backend()->block_statement(var_decls);
5755 if (!gogo->backend()->function_set_body(this->fndecl_, code_stmt))
5757 go_assert(saw_errors());
5758 return;
5762 // If we created a descriptor for the function, make sure we emit it.
5763 if (this->descriptor_ != NULL)
5765 Translate_context context(gogo, NULL, NULL, NULL);
5766 this->descriptor_->get_backend(&context);
5770 // Build the wrappers around function code needed if the function has
5771 // any defer statements. This sets *EXCEPT to an exception handler
5772 // and *FINI to a finally handler.
5774 void
5775 Function::build_defer_wrapper(Gogo* gogo, Named_object* named_function,
5776 Bstatement** except, Bstatement** fini)
5778 Location end_loc = this->block_->end_location();
5780 // Add an exception handler. This is used if a panic occurs. Its
5781 // purpose is to stop the stack unwinding if a deferred function
5782 // calls recover. There are more details in
5783 // libgo/runtime/go-unwind.c.
5785 std::vector<Bstatement*> stmts;
5786 Expression* call = Runtime::make_call(Runtime::CHECKDEFER, end_loc, 1,
5787 this->defer_stack(end_loc));
5788 Translate_context context(gogo, named_function, NULL, NULL);
5789 Bexpression* defer = call->get_backend(&context);
5790 stmts.push_back(gogo->backend()->expression_statement(this->fndecl_, defer));
5792 Bstatement* ret_bstmt = this->return_value(gogo, named_function, end_loc);
5793 if (ret_bstmt != NULL)
5794 stmts.push_back(ret_bstmt);
5796 go_assert(*except == NULL);
5797 *except = gogo->backend()->statement_list(stmts);
5799 call = Runtime::make_call(Runtime::CHECKDEFER, end_loc, 1,
5800 this->defer_stack(end_loc));
5801 defer = call->get_backend(&context);
5803 call = Runtime::make_call(Runtime::DEFERRETURN, end_loc, 1,
5804 this->defer_stack(end_loc));
5805 Bexpression* undefer = call->get_backend(&context);
5806 Bstatement* function_defer =
5807 gogo->backend()->function_defer_statement(this->fndecl_, undefer, defer,
5808 end_loc);
5809 stmts = std::vector<Bstatement*>(1, function_defer);
5810 if (this->type_->results() != NULL
5811 && !this->type_->results()->empty()
5812 && !this->type_->results()->front().name().empty())
5814 // If the result variables are named, and we are returning from
5815 // this function rather than panicing through it, we need to
5816 // return them again, because they might have been changed by a
5817 // defer function. The runtime routines set the defer_stack
5818 // variable to true if we are returning from this function.
5820 ret_bstmt = this->return_value(gogo, named_function, end_loc);
5821 Bexpression* nil = Expression::make_nil(end_loc)->get_backend(&context);
5822 Bexpression* ret =
5823 gogo->backend()->compound_expression(ret_bstmt, nil, end_loc);
5824 Expression* ref =
5825 Expression::make_temporary_reference(this->defer_stack_, end_loc);
5826 Bexpression* bref = ref->get_backend(&context);
5827 ret = gogo->backend()->conditional_expression(this->fndecl_,
5828 NULL, bref, ret, NULL,
5829 end_loc);
5830 stmts.push_back(gogo->backend()->expression_statement(this->fndecl_, ret));
5833 go_assert(*fini == NULL);
5834 *fini = gogo->backend()->statement_list(stmts);
5837 // Return the statement that assigns values to this function's result struct.
5839 Bstatement*
5840 Function::return_value(Gogo* gogo, Named_object* named_function,
5841 Location location) const
5843 const Typed_identifier_list* results = this->type_->results();
5844 if (results == NULL || results->empty())
5845 return NULL;
5847 go_assert(this->results_ != NULL);
5848 if (this->results_->size() != results->size())
5850 go_assert(saw_errors());
5851 return gogo->backend()->error_statement();
5854 std::vector<Bexpression*> vals(results->size());
5855 for (size_t i = 0; i < vals.size(); ++i)
5857 Named_object* no = (*this->results_)[i];
5858 Bvariable* bvar = no->get_backend_variable(gogo, named_function);
5859 Bexpression* val = gogo->backend()->var_expression(bvar, location);
5860 if (no->result_var_value()->is_in_heap())
5862 Btype* bt = no->result_var_value()->type()->get_backend(gogo);
5863 val = gogo->backend()->indirect_expression(bt, val, true, location);
5865 vals[i] = val;
5867 return gogo->backend()->return_statement(this->fndecl_, vals, location);
5870 // Class Block.
5872 Block::Block(Block* enclosing, Location location)
5873 : enclosing_(enclosing), statements_(),
5874 bindings_(new Bindings(enclosing == NULL
5875 ? NULL
5876 : enclosing->bindings())),
5877 start_location_(location),
5878 end_location_(Linemap::unknown_location())
5882 // Add a statement to a block.
5884 void
5885 Block::add_statement(Statement* statement)
5887 this->statements_.push_back(statement);
5890 // Add a statement to the front of a block. This is slow but is only
5891 // used for reference counts of parameters.
5893 void
5894 Block::add_statement_at_front(Statement* statement)
5896 this->statements_.insert(this->statements_.begin(), statement);
5899 // Replace a statement in a block.
5901 void
5902 Block::replace_statement(size_t index, Statement* s)
5904 go_assert(index < this->statements_.size());
5905 this->statements_[index] = s;
5908 // Add a statement before another statement.
5910 void
5911 Block::insert_statement_before(size_t index, Statement* s)
5913 go_assert(index < this->statements_.size());
5914 this->statements_.insert(this->statements_.begin() + index, s);
5917 // Add a statement after another statement.
5919 void
5920 Block::insert_statement_after(size_t index, Statement* s)
5922 go_assert(index < this->statements_.size());
5923 this->statements_.insert(this->statements_.begin() + index + 1, s);
5926 // Traverse the tree.
5929 Block::traverse(Traverse* traverse)
5931 unsigned int traverse_mask = traverse->traverse_mask();
5933 if ((traverse_mask & Traverse::traverse_blocks) != 0)
5935 int t = traverse->block(this);
5936 if (t == TRAVERSE_EXIT)
5937 return TRAVERSE_EXIT;
5938 else if (t == TRAVERSE_SKIP_COMPONENTS)
5939 return TRAVERSE_CONTINUE;
5942 if ((traverse_mask
5943 & (Traverse::traverse_variables
5944 | Traverse::traverse_constants
5945 | Traverse::traverse_expressions
5946 | Traverse::traverse_types)) != 0)
5948 const unsigned int e_or_t = (Traverse::traverse_expressions
5949 | Traverse::traverse_types);
5950 const unsigned int e_or_t_or_s = (e_or_t
5951 | Traverse::traverse_statements);
5952 for (Bindings::const_definitions_iterator pb =
5953 this->bindings_->begin_definitions();
5954 pb != this->bindings_->end_definitions();
5955 ++pb)
5957 int t = TRAVERSE_CONTINUE;
5958 switch ((*pb)->classification())
5960 case Named_object::NAMED_OBJECT_CONST:
5961 if ((traverse_mask & Traverse::traverse_constants) != 0)
5962 t = traverse->constant(*pb, false);
5963 if (t == TRAVERSE_CONTINUE
5964 && (traverse_mask & e_or_t) != 0)
5966 Type* tc = (*pb)->const_value()->type();
5967 if (tc != NULL
5968 && Type::traverse(tc, traverse) == TRAVERSE_EXIT)
5969 return TRAVERSE_EXIT;
5970 t = (*pb)->const_value()->traverse_expression(traverse);
5972 break;
5974 case Named_object::NAMED_OBJECT_VAR:
5975 case Named_object::NAMED_OBJECT_RESULT_VAR:
5976 if ((traverse_mask & Traverse::traverse_variables) != 0)
5977 t = traverse->variable(*pb);
5978 if (t == TRAVERSE_CONTINUE
5979 && (traverse_mask & e_or_t) != 0)
5981 if ((*pb)->is_result_variable()
5982 || (*pb)->var_value()->has_type())
5984 Type* tv = ((*pb)->is_variable()
5985 ? (*pb)->var_value()->type()
5986 : (*pb)->result_var_value()->type());
5987 if (tv != NULL
5988 && Type::traverse(tv, traverse) == TRAVERSE_EXIT)
5989 return TRAVERSE_EXIT;
5992 if (t == TRAVERSE_CONTINUE
5993 && (traverse_mask & e_or_t_or_s) != 0
5994 && (*pb)->is_variable())
5995 t = (*pb)->var_value()->traverse_expression(traverse,
5996 traverse_mask);
5997 break;
5999 case Named_object::NAMED_OBJECT_FUNC:
6000 case Named_object::NAMED_OBJECT_FUNC_DECLARATION:
6001 go_unreachable();
6003 case Named_object::NAMED_OBJECT_TYPE:
6004 if ((traverse_mask & e_or_t) != 0)
6005 t = Type::traverse((*pb)->type_value(), traverse);
6006 break;
6008 case Named_object::NAMED_OBJECT_TYPE_DECLARATION:
6009 case Named_object::NAMED_OBJECT_UNKNOWN:
6010 case Named_object::NAMED_OBJECT_ERRONEOUS:
6011 break;
6013 case Named_object::NAMED_OBJECT_PACKAGE:
6014 case Named_object::NAMED_OBJECT_SINK:
6015 go_unreachable();
6017 default:
6018 go_unreachable();
6021 if (t == TRAVERSE_EXIT)
6022 return TRAVERSE_EXIT;
6026 // No point in checking traverse_mask here--if we got here we always
6027 // want to walk the statements. The traversal can insert new
6028 // statements before or after the current statement. Inserting
6029 // statements before the current statement requires updating I via
6030 // the pointer; those statements will not be traversed. Any new
6031 // statements inserted after the current statement will be traversed
6032 // in their turn.
6033 for (size_t i = 0; i < this->statements_.size(); ++i)
6035 if (this->statements_[i]->traverse(this, &i, traverse) == TRAVERSE_EXIT)
6036 return TRAVERSE_EXIT;
6039 return TRAVERSE_CONTINUE;
6042 // Work out types for unspecified variables and constants.
6044 void
6045 Block::determine_types()
6047 for (Bindings::const_definitions_iterator pb =
6048 this->bindings_->begin_definitions();
6049 pb != this->bindings_->end_definitions();
6050 ++pb)
6052 if ((*pb)->is_variable())
6053 (*pb)->var_value()->determine_type();
6054 else if ((*pb)->is_const())
6055 (*pb)->const_value()->determine_type();
6058 for (std::vector<Statement*>::const_iterator ps = this->statements_.begin();
6059 ps != this->statements_.end();
6060 ++ps)
6061 (*ps)->determine_types();
6064 // Return true if the statements in this block may fall through.
6066 bool
6067 Block::may_fall_through() const
6069 if (this->statements_.empty())
6070 return true;
6071 return this->statements_.back()->may_fall_through();
6074 // Convert a block to the backend representation.
6076 Bblock*
6077 Block::get_backend(Translate_context* context)
6079 Gogo* gogo = context->gogo();
6080 Named_object* function = context->function();
6081 std::vector<Bvariable*> vars;
6082 vars.reserve(this->bindings_->size_definitions());
6083 for (Bindings::const_definitions_iterator pv =
6084 this->bindings_->begin_definitions();
6085 pv != this->bindings_->end_definitions();
6086 ++pv)
6088 if ((*pv)->is_variable() && !(*pv)->var_value()->is_parameter())
6089 vars.push_back((*pv)->get_backend_variable(gogo, function));
6092 go_assert(function != NULL);
6093 Bfunction* bfunction =
6094 function->func_value()->get_or_make_decl(gogo, function);
6095 Bblock* ret = context->backend()->block(bfunction, context->bblock(),
6096 vars, this->start_location_,
6097 this->end_location_);
6099 Translate_context subcontext(gogo, function, this, ret);
6100 std::vector<Bstatement*> bstatements;
6101 bstatements.reserve(this->statements_.size());
6102 for (std::vector<Statement*>::const_iterator p = this->statements_.begin();
6103 p != this->statements_.end();
6104 ++p)
6105 bstatements.push_back((*p)->get_backend(&subcontext));
6107 context->backend()->block_add_statements(ret, bstatements);
6109 return ret;
6112 // Class Bindings_snapshot.
6114 Bindings_snapshot::Bindings_snapshot(const Block* b, Location location)
6115 : block_(b), counts_(), location_(location)
6117 while (b != NULL)
6119 this->counts_.push_back(b->bindings()->size_definitions());
6120 b = b->enclosing();
6124 // Report errors appropriate for a goto from B to this.
6126 void
6127 Bindings_snapshot::check_goto_from(const Block* b, Location loc)
6129 size_t dummy;
6130 if (!this->check_goto_block(loc, b, this->block_, &dummy))
6131 return;
6132 this->check_goto_defs(loc, this->block_,
6133 this->block_->bindings()->size_definitions(),
6134 this->counts_[0]);
6137 // Report errors appropriate for a goto from this to B.
6139 void
6140 Bindings_snapshot::check_goto_to(const Block* b)
6142 size_t index;
6143 if (!this->check_goto_block(this->location_, this->block_, b, &index))
6144 return;
6145 this->check_goto_defs(this->location_, b, this->counts_[index],
6146 b->bindings()->size_definitions());
6149 // Report errors appropriate for a goto at LOC from BFROM to BTO.
6150 // Return true if all is well, false if we reported an error. If this
6151 // returns true, it sets *PINDEX to the number of blocks BTO is above
6152 // BFROM.
6154 bool
6155 Bindings_snapshot::check_goto_block(Location loc, const Block* bfrom,
6156 const Block* bto, size_t* pindex)
6158 // It is an error if BTO is not either BFROM or above BFROM.
6159 size_t index = 0;
6160 for (const Block* pb = bfrom; pb != bto; pb = pb->enclosing(), ++index)
6162 if (pb == NULL)
6164 go_error_at(loc, "goto jumps into block");
6165 go_inform(bto->start_location(), "goto target block starts here");
6166 return false;
6169 *pindex = index;
6170 return true;
6173 // Report errors appropriate for a goto at LOC ending at BLOCK, where
6174 // CFROM is the number of names defined at the point of the goto and
6175 // CTO is the number of names defined at the point of the label.
6177 void
6178 Bindings_snapshot::check_goto_defs(Location loc, const Block* block,
6179 size_t cfrom, size_t cto)
6181 if (cfrom < cto)
6183 Bindings::const_definitions_iterator p =
6184 block->bindings()->begin_definitions();
6185 for (size_t i = 0; i < cfrom; ++i)
6187 go_assert(p != block->bindings()->end_definitions());
6188 ++p;
6190 go_assert(p != block->bindings()->end_definitions());
6192 std::string n = (*p)->message_name();
6193 go_error_at(loc, "goto jumps over declaration of %qs", n.c_str());
6194 go_inform((*p)->location(), "%qs defined here", n.c_str());
6198 // Class Function_declaration.
6200 // Return the function descriptor.
6202 Expression*
6203 Function_declaration::descriptor(Gogo*, Named_object* no)
6205 go_assert(!this->fntype_->is_method());
6206 if (this->descriptor_ == NULL)
6207 this->descriptor_ = Expression::make_func_descriptor(no);
6208 return this->descriptor_;
6211 // Class Variable.
6213 Variable::Variable(Type* type, Expression* init, bool is_global,
6214 bool is_parameter, bool is_receiver,
6215 Location location)
6216 : type_(type), init_(init), preinit_(NULL), location_(location),
6217 backend_(NULL), is_global_(is_global), is_parameter_(is_parameter),
6218 is_closure_(false), is_receiver_(is_receiver),
6219 is_varargs_parameter_(false), is_used_(false),
6220 is_address_taken_(false), is_non_escaping_address_taken_(false),
6221 seen_(false), init_is_lowered_(false), init_is_flattened_(false),
6222 type_from_init_tuple_(false), type_from_range_index_(false),
6223 type_from_range_value_(false), type_from_chan_element_(false),
6224 is_type_switch_var_(false), determined_type_(false),
6225 in_unique_section_(false), escapes_(true),
6226 toplevel_decl_(NULL)
6228 go_assert(type != NULL || init != NULL);
6229 go_assert(!is_parameter || init == NULL);
6232 // Traverse the initializer expression.
6235 Variable::traverse_expression(Traverse* traverse, unsigned int traverse_mask)
6237 if (this->preinit_ != NULL)
6239 if (this->preinit_->traverse(traverse) == TRAVERSE_EXIT)
6240 return TRAVERSE_EXIT;
6242 if (this->init_ != NULL
6243 && ((traverse_mask
6244 & (Traverse::traverse_expressions | Traverse::traverse_types))
6245 != 0))
6247 if (Expression::traverse(&this->init_, traverse) == TRAVERSE_EXIT)
6248 return TRAVERSE_EXIT;
6250 return TRAVERSE_CONTINUE;
6253 // Lower the initialization expression after parsing is complete.
6255 void
6256 Variable::lower_init_expression(Gogo* gogo, Named_object* function,
6257 Statement_inserter* inserter)
6259 Named_object* dep = gogo->var_depends_on(this);
6260 if (dep != NULL && dep->is_variable())
6261 dep->var_value()->lower_init_expression(gogo, function, inserter);
6263 if (this->init_ != NULL && !this->init_is_lowered_)
6265 if (this->seen_)
6267 // We will give an error elsewhere, this is just to prevent
6268 // an infinite loop.
6269 return;
6271 this->seen_ = true;
6273 Statement_inserter global_inserter;
6274 if (this->is_global_)
6276 global_inserter = Statement_inserter(gogo, this);
6277 inserter = &global_inserter;
6280 gogo->lower_expression(function, inserter, &this->init_);
6282 this->seen_ = false;
6284 this->init_is_lowered_ = true;
6288 // Flatten the initialization expression after ordering evaluations.
6290 void
6291 Variable::flatten_init_expression(Gogo* gogo, Named_object* function,
6292 Statement_inserter* inserter)
6294 Named_object* dep = gogo->var_depends_on(this);
6295 if (dep != NULL && dep->is_variable())
6296 dep->var_value()->flatten_init_expression(gogo, function, inserter);
6298 if (this->init_ != NULL && !this->init_is_flattened_)
6300 if (this->seen_)
6302 // We will give an error elsewhere, this is just to prevent
6303 // an infinite loop.
6304 return;
6306 this->seen_ = true;
6308 Statement_inserter global_inserter;
6309 if (this->is_global_)
6311 global_inserter = Statement_inserter(gogo, this);
6312 inserter = &global_inserter;
6315 gogo->flatten_expression(function, inserter, &this->init_);
6317 // If an interface conversion is needed, we need a temporary
6318 // variable.
6319 if (this->type_ != NULL
6320 && !Type::are_identical(this->type_, this->init_->type(), false,
6321 NULL)
6322 && this->init_->type()->interface_type() != NULL
6323 && !this->init_->is_variable())
6325 Temporary_statement* temp =
6326 Statement::make_temporary(NULL, this->init_, this->location_);
6327 inserter->insert(temp);
6328 this->init_ = Expression::make_temporary_reference(temp,
6329 this->location_);
6332 this->seen_ = false;
6333 this->init_is_flattened_ = true;
6337 // Get the preinit block.
6339 Block*
6340 Variable::preinit_block(Gogo* gogo)
6342 go_assert(this->is_global_);
6343 if (this->preinit_ == NULL)
6344 this->preinit_ = new Block(NULL, this->location());
6346 // If a global variable has a preinitialization statement, then we
6347 // need to have an initialization function.
6348 gogo->set_need_init_fn();
6350 return this->preinit_;
6353 // Add a statement to be run before the initialization expression.
6355 void
6356 Variable::add_preinit_statement(Gogo* gogo, Statement* s)
6358 Block* b = this->preinit_block(gogo);
6359 b->add_statement(s);
6360 b->set_end_location(s->location());
6363 // Whether this variable has a type.
6365 bool
6366 Variable::has_type() const
6368 if (this->type_ == NULL)
6369 return false;
6371 // A variable created in a type switch case nil does not actually
6372 // have a type yet. It will be changed to use the initializer's
6373 // type in determine_type.
6374 if (this->is_type_switch_var_
6375 && this->type_->is_nil_constant_as_type())
6376 return false;
6378 return true;
6381 // In an assignment which sets a variable to a tuple of EXPR, return
6382 // the type of the first element of the tuple.
6384 Type*
6385 Variable::type_from_tuple(Expression* expr, bool report_error) const
6387 if (expr->map_index_expression() != NULL)
6389 Map_type* mt = expr->map_index_expression()->get_map_type();
6390 if (mt == NULL)
6391 return Type::make_error_type();
6392 return mt->val_type();
6394 else if (expr->receive_expression() != NULL)
6396 Expression* channel = expr->receive_expression()->channel();
6397 Type* channel_type = channel->type();
6398 if (channel_type->channel_type() == NULL)
6399 return Type::make_error_type();
6400 return channel_type->channel_type()->element_type();
6402 else
6404 if (report_error)
6405 go_error_at(this->location(), "invalid tuple definition");
6406 return Type::make_error_type();
6410 // Given EXPR used in a range clause, return either the index type or
6411 // the value type of the range, depending upon GET_INDEX_TYPE.
6413 Type*
6414 Variable::type_from_range(Expression* expr, bool get_index_type,
6415 bool report_error) const
6417 Type* t = expr->type();
6418 if (t->array_type() != NULL
6419 || (t->points_to() != NULL
6420 && t->points_to()->array_type() != NULL
6421 && !t->points_to()->is_slice_type()))
6423 if (get_index_type)
6424 return Type::lookup_integer_type("int");
6425 else
6426 return t->deref()->array_type()->element_type();
6428 else if (t->is_string_type())
6430 if (get_index_type)
6431 return Type::lookup_integer_type("int");
6432 else
6433 return Type::lookup_integer_type("int32");
6435 else if (t->map_type() != NULL)
6437 if (get_index_type)
6438 return t->map_type()->key_type();
6439 else
6440 return t->map_type()->val_type();
6442 else if (t->channel_type() != NULL)
6444 if (get_index_type)
6445 return t->channel_type()->element_type();
6446 else
6448 if (report_error)
6449 go_error_at(this->location(),
6450 ("invalid definition of value variable "
6451 "for channel range"));
6452 return Type::make_error_type();
6455 else
6457 if (report_error)
6458 go_error_at(this->location(), "invalid type for range clause");
6459 return Type::make_error_type();
6463 // EXPR should be a channel. Return the channel's element type.
6465 Type*
6466 Variable::type_from_chan_element(Expression* expr, bool report_error) const
6468 Type* t = expr->type();
6469 if (t->channel_type() != NULL)
6470 return t->channel_type()->element_type();
6471 else
6473 if (report_error)
6474 go_error_at(this->location(), "expected channel");
6475 return Type::make_error_type();
6479 // Return the type of the Variable. This may be called before
6480 // Variable::determine_type is called, which means that we may need to
6481 // get the type from the initializer. FIXME: If we combine lowering
6482 // with type determination, then this should be unnecessary.
6484 Type*
6485 Variable::type()
6487 // A variable in a type switch with a nil case will have the wrong
6488 // type here. This gets fixed up in determine_type, below.
6489 Type* type = this->type_;
6490 Expression* init = this->init_;
6491 if (this->is_type_switch_var_
6492 && type != NULL
6493 && this->type_->is_nil_constant_as_type())
6495 Type_guard_expression* tge = this->init_->type_guard_expression();
6496 go_assert(tge != NULL);
6497 init = tge->expr();
6498 type = NULL;
6501 if (this->seen_)
6503 if (this->type_ == NULL || !this->type_->is_error_type())
6505 go_error_at(this->location_, "variable initializer refers to itself");
6506 this->type_ = Type::make_error_type();
6508 return this->type_;
6511 this->seen_ = true;
6513 if (type != NULL)
6515 else if (this->type_from_init_tuple_)
6516 type = this->type_from_tuple(init, false);
6517 else if (this->type_from_range_index_ || this->type_from_range_value_)
6518 type = this->type_from_range(init, this->type_from_range_index_, false);
6519 else if (this->type_from_chan_element_)
6520 type = this->type_from_chan_element(init, false);
6521 else
6523 go_assert(init != NULL);
6524 type = init->type();
6525 go_assert(type != NULL);
6527 // Variables should not have abstract types.
6528 if (type->is_abstract())
6529 type = type->make_non_abstract_type();
6531 if (type->is_void_type())
6532 type = Type::make_error_type();
6535 this->seen_ = false;
6537 return type;
6540 // Fetch the type from a const pointer, in which case it should have
6541 // been set already.
6543 Type*
6544 Variable::type() const
6546 go_assert(this->type_ != NULL);
6547 return this->type_;
6550 // Set the type if necessary.
6552 void
6553 Variable::determine_type()
6555 if (this->determined_type_)
6556 return;
6557 this->determined_type_ = true;
6559 if (this->preinit_ != NULL)
6560 this->preinit_->determine_types();
6562 // A variable in a type switch with a nil case will have the wrong
6563 // type here. It will have an initializer which is a type guard.
6564 // We want to initialize it to the value without the type guard, and
6565 // use the type of that value as well.
6566 if (this->is_type_switch_var_
6567 && this->type_ != NULL
6568 && this->type_->is_nil_constant_as_type())
6570 Type_guard_expression* tge = this->init_->type_guard_expression();
6571 go_assert(tge != NULL);
6572 this->type_ = NULL;
6573 this->init_ = tge->expr();
6576 if (this->init_ == NULL)
6577 go_assert(this->type_ != NULL && !this->type_->is_abstract());
6578 else if (this->type_from_init_tuple_)
6580 Expression *init = this->init_;
6581 init->determine_type_no_context();
6582 this->type_ = this->type_from_tuple(init, true);
6583 this->init_ = NULL;
6585 else if (this->type_from_range_index_ || this->type_from_range_value_)
6587 Expression* init = this->init_;
6588 init->determine_type_no_context();
6589 this->type_ = this->type_from_range(init, this->type_from_range_index_,
6590 true);
6591 this->init_ = NULL;
6593 else if (this->type_from_chan_element_)
6595 Expression* init = this->init_;
6596 init->determine_type_no_context();
6597 this->type_ = this->type_from_chan_element(init, true);
6598 this->init_ = NULL;
6600 else
6602 Type_context context(this->type_, false);
6603 this->init_->determine_type(&context);
6604 if (this->type_ == NULL)
6606 Type* type = this->init_->type();
6607 go_assert(type != NULL);
6608 if (type->is_abstract())
6609 type = type->make_non_abstract_type();
6611 if (type->is_void_type())
6613 go_error_at(this->location_, "variable has no type");
6614 type = Type::make_error_type();
6616 else if (type->is_nil_type())
6618 go_error_at(this->location_, "variable defined to nil type");
6619 type = Type::make_error_type();
6621 else if (type->is_call_multiple_result_type())
6623 go_error_at(this->location_,
6624 "single variable set to multiple-value function call");
6625 type = Type::make_error_type();
6628 this->type_ = type;
6633 // Get the initial value of a variable. This does not
6634 // consider whether the variable is in the heap--it returns the
6635 // initial value as though it were always stored in the stack.
6637 Bexpression*
6638 Variable::get_init(Gogo* gogo, Named_object* function)
6640 go_assert(this->preinit_ == NULL);
6641 Location loc = this->location();
6642 if (this->init_ == NULL)
6644 go_assert(!this->is_parameter_);
6645 if (this->is_global_ || this->is_in_heap())
6646 return NULL;
6647 Btype* btype = this->type()->get_backend(gogo);
6648 return gogo->backend()->zero_expression(btype);
6650 else
6652 Translate_context context(gogo, function, NULL, NULL);
6653 Expression* init = Expression::make_cast(this->type(), this->init_, loc);
6654 return init->get_backend(&context);
6658 // Get the initial value of a variable when a block is required.
6659 // VAR_DECL is the decl to set; it may be NULL for a sink variable.
6661 Bstatement*
6662 Variable::get_init_block(Gogo* gogo, Named_object* function,
6663 Bvariable* var_decl)
6665 go_assert(this->preinit_ != NULL);
6667 // We want to add the variable assignment to the end of the preinit
6668 // block.
6670 Translate_context context(gogo, function, NULL, NULL);
6671 Bblock* bblock = this->preinit_->get_backend(&context);
6672 Bfunction* bfunction =
6673 function->func_value()->get_or_make_decl(gogo, function);
6675 // It's possible to have pre-init statements without an initializer
6676 // if the pre-init statements set the variable.
6677 Bstatement* decl_init = NULL;
6678 if (this->init_ != NULL)
6680 if (var_decl == NULL)
6682 Bexpression* init_bexpr = this->init_->get_backend(&context);
6683 decl_init = gogo->backend()->expression_statement(bfunction,
6684 init_bexpr);
6686 else
6688 Location loc = this->location();
6689 Expression* val_expr =
6690 Expression::make_cast(this->type(), this->init_, loc);
6691 Bexpression* val = val_expr->get_backend(&context);
6692 Bexpression* var_ref =
6693 gogo->backend()->var_expression(var_decl, loc);
6694 decl_init = gogo->backend()->assignment_statement(bfunction, var_ref,
6695 val, loc);
6698 Bstatement* block_stmt = gogo->backend()->block_statement(bblock);
6699 if (decl_init != NULL)
6700 block_stmt = gogo->backend()->compound_statement(block_stmt, decl_init);
6701 return block_stmt;
6704 // Export the variable
6706 void
6707 Variable::export_var(Export* exp, const std::string& name) const
6709 go_assert(this->is_global_);
6710 exp->write_c_string("var ");
6711 exp->write_string(name);
6712 exp->write_c_string(" ");
6713 exp->write_type(this->type());
6714 exp->write_c_string(";\n");
6717 // Import a variable.
6719 void
6720 Variable::import_var(Import* imp, std::string* pname, Type** ptype)
6722 imp->require_c_string("var ");
6723 *pname = imp->read_identifier();
6724 imp->require_c_string(" ");
6725 *ptype = imp->read_type();
6726 imp->require_c_string(";\n");
6729 // Convert a variable to the backend representation.
6731 Bvariable*
6732 Variable::get_backend_variable(Gogo* gogo, Named_object* function,
6733 const Package* package, const std::string& name)
6735 if (this->backend_ == NULL)
6737 Backend* backend = gogo->backend();
6738 Type* type = this->type_;
6739 if (type->is_error_type()
6740 || (type->is_undefined()
6741 && (!this->is_global_ || package == NULL)))
6742 this->backend_ = backend->error_variable();
6743 else
6745 bool is_parameter = this->is_parameter_;
6746 if (this->is_receiver_ && type->points_to() == NULL)
6747 is_parameter = false;
6748 if (this->is_in_heap())
6750 is_parameter = false;
6751 type = Type::make_pointer_type(type);
6754 const std::string n = Gogo::unpack_hidden_name(name);
6755 Btype* btype = type->get_backend(gogo);
6757 Bvariable* bvar;
6758 if (Map_type::is_zero_value(this))
6759 bvar = Map_type::backend_zero_value(gogo);
6760 else if (this->is_global_)
6762 std::string var_name(package != NULL
6763 ? package->package_name()
6764 : gogo->package_name());
6765 var_name.push_back('.');
6766 var_name.append(n);
6768 std::string asm_name(gogo->global_var_asm_name(name, package));
6770 bool is_hidden = Gogo::is_hidden_name(name);
6771 // Hack to export runtime.writeBarrier. FIXME.
6772 // This is because go:linkname doesn't work on variables.
6773 if (gogo->compiling_runtime()
6774 && var_name == "runtime.writeBarrier")
6775 is_hidden = false;
6777 bvar = backend->global_variable(var_name,
6778 asm_name,
6779 btype,
6780 package != NULL,
6781 is_hidden,
6782 this->in_unique_section_,
6783 this->location_);
6785 else if (function == NULL)
6787 go_assert(saw_errors());
6788 bvar = backend->error_variable();
6790 else
6792 Bfunction* bfunction = function->func_value()->get_decl();
6793 bool is_address_taken = (this->is_non_escaping_address_taken_
6794 && !this->is_in_heap());
6795 if (this->is_closure())
6796 bvar = backend->static_chain_variable(bfunction, n, btype,
6797 this->location_);
6798 else if (is_parameter)
6799 bvar = backend->parameter_variable(bfunction, n, btype,
6800 is_address_taken,
6801 this->location_);
6802 else
6804 Bvariable* bvar_decl = NULL;
6805 if (this->toplevel_decl_ != NULL)
6807 Translate_context context(gogo, NULL, NULL, NULL);
6808 bvar_decl = this->toplevel_decl_->temporary_statement()
6809 ->get_backend_variable(&context);
6811 bvar = backend->local_variable(bfunction, n, btype,
6812 bvar_decl,
6813 is_address_taken,
6814 this->location_);
6817 this->backend_ = bvar;
6820 return this->backend_;
6823 // Class Result_variable.
6825 // Convert a result variable to the backend representation.
6827 Bvariable*
6828 Result_variable::get_backend_variable(Gogo* gogo, Named_object* function,
6829 const std::string& name)
6831 if (this->backend_ == NULL)
6833 Backend* backend = gogo->backend();
6834 Type* type = this->type_;
6835 if (type->is_error())
6836 this->backend_ = backend->error_variable();
6837 else
6839 if (this->is_in_heap())
6840 type = Type::make_pointer_type(type);
6841 Btype* btype = type->get_backend(gogo);
6842 Bfunction* bfunction = function->func_value()->get_decl();
6843 std::string n = Gogo::unpack_hidden_name(name);
6844 bool is_address_taken = (this->is_non_escaping_address_taken_
6845 && !this->is_in_heap());
6846 this->backend_ = backend->local_variable(bfunction, n, btype,
6847 NULL, is_address_taken,
6848 this->location_);
6851 return this->backend_;
6854 // Class Named_constant.
6856 // Traverse the initializer expression.
6859 Named_constant::traverse_expression(Traverse* traverse)
6861 return Expression::traverse(&this->expr_, traverse);
6864 // Determine the type of the constant.
6866 void
6867 Named_constant::determine_type()
6869 if (this->type_ != NULL)
6871 Type_context context(this->type_, false);
6872 this->expr_->determine_type(&context);
6874 else
6876 // A constant may have an abstract type.
6877 Type_context context(NULL, true);
6878 this->expr_->determine_type(&context);
6879 this->type_ = this->expr_->type();
6880 go_assert(this->type_ != NULL);
6884 // Indicate that we found and reported an error for this constant.
6886 void
6887 Named_constant::set_error()
6889 this->type_ = Type::make_error_type();
6890 this->expr_ = Expression::make_error(this->location_);
6893 // Export a constant.
6895 void
6896 Named_constant::export_const(Export* exp, const std::string& name) const
6898 exp->write_c_string("const ");
6899 exp->write_string(name);
6900 exp->write_c_string(" ");
6901 if (!this->type_->is_abstract())
6903 exp->write_type(this->type_);
6904 exp->write_c_string(" ");
6906 exp->write_c_string("= ");
6907 this->expr()->export_expression(exp);
6908 exp->write_c_string(";\n");
6911 // Import a constant.
6913 void
6914 Named_constant::import_const(Import* imp, std::string* pname, Type** ptype,
6915 Expression** pexpr)
6917 imp->require_c_string("const ");
6918 *pname = imp->read_identifier();
6919 imp->require_c_string(" ");
6920 if (imp->peek_char() == '=')
6921 *ptype = NULL;
6922 else
6924 *ptype = imp->read_type();
6925 imp->require_c_string(" ");
6927 imp->require_c_string("= ");
6928 *pexpr = Expression::import_expression(imp);
6929 imp->require_c_string(";\n");
6932 // Get the backend representation.
6934 Bexpression*
6935 Named_constant::get_backend(Gogo* gogo, Named_object* const_no)
6937 if (this->bconst_ == NULL)
6939 Translate_context subcontext(gogo, NULL, NULL, NULL);
6940 Type* type = this->type();
6941 Location loc = this->location();
6943 Expression* const_ref = Expression::make_const_reference(const_no, loc);
6944 Bexpression* const_decl = const_ref->get_backend(&subcontext);
6945 if (type != NULL && type->is_numeric_type())
6947 Btype* btype = type->get_backend(gogo);
6948 std::string name = const_no->get_id(gogo);
6949 const_decl =
6950 gogo->backend()->named_constant_expression(btype, name,
6951 const_decl, loc);
6953 this->bconst_ = const_decl;
6955 return this->bconst_;
6958 // Add a method.
6960 Named_object*
6961 Type_declaration::add_method(const std::string& name, Function* function)
6963 Named_object* ret = Named_object::make_function(name, NULL, function);
6964 this->methods_.push_back(ret);
6965 return ret;
6968 // Add a method declaration.
6970 Named_object*
6971 Type_declaration::add_method_declaration(const std::string& name,
6972 Package* package,
6973 Function_type* type,
6974 Location location)
6976 Named_object* ret = Named_object::make_function_declaration(name, package,
6977 type, location);
6978 this->methods_.push_back(ret);
6979 return ret;
6982 // Return whether any methods are defined.
6984 bool
6985 Type_declaration::has_methods() const
6987 return !this->methods_.empty();
6990 // Define methods for the real type.
6992 void
6993 Type_declaration::define_methods(Named_type* nt)
6995 if (this->methods_.empty())
6996 return;
6998 while (nt->is_alias())
7000 Type *t = nt->real_type()->forwarded();
7001 if (t->named_type() != NULL)
7002 nt = t->named_type();
7003 else if (t->forward_declaration_type() != NULL)
7005 Named_object* no = t->forward_declaration_type()->named_object();
7006 Type_declaration* td = no->type_declaration_value();
7007 td->methods_.insert(td->methods_.end(), this->methods_.begin(),
7008 this->methods_.end());
7009 this->methods_.clear();
7010 return;
7012 else
7014 for (std::vector<Named_object*>::const_iterator p =
7015 this->methods_.begin();
7016 p != this->methods_.end();
7017 ++p)
7018 go_error_at((*p)->location(),
7019 ("invalid receiver type "
7020 "(receiver must be a named type"));
7021 return;
7025 for (std::vector<Named_object*>::const_iterator p = this->methods_.begin();
7026 p != this->methods_.end();
7027 ++p)
7029 if (!(*p)->func_value()->is_sink())
7030 nt->add_existing_method(*p);
7034 // We are using the type. Return true if we should issue a warning.
7036 bool
7037 Type_declaration::using_type()
7039 bool ret = !this->issued_warning_;
7040 this->issued_warning_ = true;
7041 return ret;
7044 // Class Unknown_name.
7046 // Set the real named object.
7048 void
7049 Unknown_name::set_real_named_object(Named_object* no)
7051 go_assert(this->real_named_object_ == NULL);
7052 go_assert(!no->is_unknown());
7053 this->real_named_object_ = no;
7056 // Class Named_object.
7058 Named_object::Named_object(const std::string& name,
7059 const Package* package,
7060 Classification classification)
7061 : name_(name), package_(package), classification_(classification),
7062 is_redefinition_(false)
7064 if (Gogo::is_sink_name(name))
7065 go_assert(classification == NAMED_OBJECT_SINK);
7068 // Make an unknown name. This is used by the parser. The name must
7069 // be resolved later. Unknown names are only added in the current
7070 // package.
7072 Named_object*
7073 Named_object::make_unknown_name(const std::string& name,
7074 Location location)
7076 Named_object* named_object = new Named_object(name, NULL,
7077 NAMED_OBJECT_UNKNOWN);
7078 Unknown_name* value = new Unknown_name(location);
7079 named_object->u_.unknown_value = value;
7080 return named_object;
7083 // Make a constant.
7085 Named_object*
7086 Named_object::make_constant(const Typed_identifier& tid,
7087 const Package* package, Expression* expr,
7088 int iota_value)
7090 Named_object* named_object = new Named_object(tid.name(), package,
7091 NAMED_OBJECT_CONST);
7092 Named_constant* named_constant = new Named_constant(tid.type(), expr,
7093 iota_value,
7094 tid.location());
7095 named_object->u_.const_value = named_constant;
7096 return named_object;
7099 // Make a named type.
7101 Named_object*
7102 Named_object::make_type(const std::string& name, const Package* package,
7103 Type* type, Location location)
7105 Named_object* named_object = new Named_object(name, package,
7106 NAMED_OBJECT_TYPE);
7107 Named_type* named_type = Type::make_named_type(named_object, type, location);
7108 named_object->u_.type_value = named_type;
7109 return named_object;
7112 // Make a type declaration.
7114 Named_object*
7115 Named_object::make_type_declaration(const std::string& name,
7116 const Package* package,
7117 Location location)
7119 Named_object* named_object = new Named_object(name, package,
7120 NAMED_OBJECT_TYPE_DECLARATION);
7121 Type_declaration* type_declaration = new Type_declaration(location);
7122 named_object->u_.type_declaration = type_declaration;
7123 return named_object;
7126 // Make a variable.
7128 Named_object*
7129 Named_object::make_variable(const std::string& name, const Package* package,
7130 Variable* variable)
7132 Named_object* named_object = new Named_object(name, package,
7133 NAMED_OBJECT_VAR);
7134 named_object->u_.var_value = variable;
7135 return named_object;
7138 // Make a result variable.
7140 Named_object*
7141 Named_object::make_result_variable(const std::string& name,
7142 Result_variable* result)
7144 Named_object* named_object = new Named_object(name, NULL,
7145 NAMED_OBJECT_RESULT_VAR);
7146 named_object->u_.result_var_value = result;
7147 return named_object;
7150 // Make a sink. This is used for the special blank identifier _.
7152 Named_object*
7153 Named_object::make_sink()
7155 return new Named_object("_", NULL, NAMED_OBJECT_SINK);
7158 // Make a named function.
7160 Named_object*
7161 Named_object::make_function(const std::string& name, const Package* package,
7162 Function* function)
7164 Named_object* named_object = new Named_object(name, package,
7165 NAMED_OBJECT_FUNC);
7166 named_object->u_.func_value = function;
7167 return named_object;
7170 // Make a function declaration.
7172 Named_object*
7173 Named_object::make_function_declaration(const std::string& name,
7174 const Package* package,
7175 Function_type* fntype,
7176 Location location)
7178 Named_object* named_object = new Named_object(name, package,
7179 NAMED_OBJECT_FUNC_DECLARATION);
7180 Function_declaration *func_decl = new Function_declaration(fntype, location);
7181 named_object->u_.func_declaration_value = func_decl;
7182 return named_object;
7185 // Make a package.
7187 Named_object*
7188 Named_object::make_package(const std::string& alias, Package* package)
7190 Named_object* named_object = new Named_object(alias, NULL,
7191 NAMED_OBJECT_PACKAGE);
7192 named_object->u_.package_value = package;
7193 return named_object;
7196 // Return the name to use in an error message.
7198 std::string
7199 Named_object::message_name() const
7201 if (this->package_ == NULL)
7202 return Gogo::message_name(this->name_);
7203 std::string ret;
7204 if (this->package_->has_package_name())
7205 ret = this->package_->package_name();
7206 else
7207 ret = this->package_->pkgpath();
7208 ret = Gogo::message_name(ret);
7209 ret += '.';
7210 ret += Gogo::message_name(this->name_);
7211 return ret;
7214 // Set the type when a declaration is defined.
7216 void
7217 Named_object::set_type_value(Named_type* named_type)
7219 go_assert(this->classification_ == NAMED_OBJECT_TYPE_DECLARATION);
7220 Type_declaration* td = this->u_.type_declaration;
7221 td->define_methods(named_type);
7222 unsigned int index;
7223 Named_object* in_function = td->in_function(&index);
7224 if (in_function != NULL)
7225 named_type->set_in_function(in_function, index);
7226 delete td;
7227 this->classification_ = NAMED_OBJECT_TYPE;
7228 this->u_.type_value = named_type;
7231 // Define a function which was previously declared.
7233 void
7234 Named_object::set_function_value(Function* function)
7236 go_assert(this->classification_ == NAMED_OBJECT_FUNC_DECLARATION);
7237 if (this->func_declaration_value()->has_descriptor())
7239 Expression* descriptor =
7240 this->func_declaration_value()->descriptor(NULL, NULL);
7241 function->set_descriptor(descriptor);
7243 this->classification_ = NAMED_OBJECT_FUNC;
7244 // FIXME: We should free the old value.
7245 this->u_.func_value = function;
7248 // Declare an unknown object as a type declaration.
7250 void
7251 Named_object::declare_as_type()
7253 go_assert(this->classification_ == NAMED_OBJECT_UNKNOWN);
7254 Unknown_name* unk = this->u_.unknown_value;
7255 this->classification_ = NAMED_OBJECT_TYPE_DECLARATION;
7256 this->u_.type_declaration = new Type_declaration(unk->location());
7257 delete unk;
7260 // Return the location of a named object.
7262 Location
7263 Named_object::location() const
7265 switch (this->classification_)
7267 default:
7268 case NAMED_OBJECT_UNINITIALIZED:
7269 go_unreachable();
7271 case NAMED_OBJECT_ERRONEOUS:
7272 return Linemap::unknown_location();
7274 case NAMED_OBJECT_UNKNOWN:
7275 return this->unknown_value()->location();
7277 case NAMED_OBJECT_CONST:
7278 return this->const_value()->location();
7280 case NAMED_OBJECT_TYPE:
7281 return this->type_value()->location();
7283 case NAMED_OBJECT_TYPE_DECLARATION:
7284 return this->type_declaration_value()->location();
7286 case NAMED_OBJECT_VAR:
7287 return this->var_value()->location();
7289 case NAMED_OBJECT_RESULT_VAR:
7290 return this->result_var_value()->location();
7292 case NAMED_OBJECT_SINK:
7293 go_unreachable();
7295 case NAMED_OBJECT_FUNC:
7296 return this->func_value()->location();
7298 case NAMED_OBJECT_FUNC_DECLARATION:
7299 return this->func_declaration_value()->location();
7301 case NAMED_OBJECT_PACKAGE:
7302 return this->package_value()->location();
7306 // Export a named object.
7308 void
7309 Named_object::export_named_object(Export* exp) const
7311 switch (this->classification_)
7313 default:
7314 case NAMED_OBJECT_UNINITIALIZED:
7315 case NAMED_OBJECT_UNKNOWN:
7316 go_unreachable();
7318 case NAMED_OBJECT_ERRONEOUS:
7319 break;
7321 case NAMED_OBJECT_CONST:
7322 this->const_value()->export_const(exp, this->name_);
7323 break;
7325 case NAMED_OBJECT_TYPE:
7326 this->type_value()->export_named_type(exp, this->name_);
7327 break;
7329 case NAMED_OBJECT_TYPE_DECLARATION:
7330 go_error_at(this->type_declaration_value()->location(),
7331 "attempt to export %<%s%> which was declared but not defined",
7332 this->message_name().c_str());
7333 break;
7335 case NAMED_OBJECT_FUNC_DECLARATION:
7336 this->func_declaration_value()->export_func(exp, this->name_);
7337 break;
7339 case NAMED_OBJECT_VAR:
7340 this->var_value()->export_var(exp, this->name_);
7341 break;
7343 case NAMED_OBJECT_RESULT_VAR:
7344 case NAMED_OBJECT_SINK:
7345 go_unreachable();
7347 case NAMED_OBJECT_FUNC:
7348 this->func_value()->export_func(exp, this->name_);
7349 break;
7353 // Convert a variable to the backend representation.
7355 Bvariable*
7356 Named_object::get_backend_variable(Gogo* gogo, Named_object* function)
7358 if (this->classification_ == NAMED_OBJECT_VAR)
7359 return this->var_value()->get_backend_variable(gogo, function,
7360 this->package_, this->name_);
7361 else if (this->classification_ == NAMED_OBJECT_RESULT_VAR)
7362 return this->result_var_value()->get_backend_variable(gogo, function,
7363 this->name_);
7364 else
7365 go_unreachable();
7368 // Return the external identifier for this object.
7370 std::string
7371 Named_object::get_id(Gogo* gogo)
7373 go_assert(!this->is_variable()
7374 && !this->is_result_variable()
7375 && !this->is_type());
7376 std::string decl_name;
7377 if (this->is_function_declaration()
7378 && !this->func_declaration_value()->asm_name().empty())
7379 decl_name = this->func_declaration_value()->asm_name();
7380 else
7382 std::string package_name;
7383 if (this->package_ == NULL)
7384 package_name = gogo->package_name();
7385 else
7386 package_name = this->package_->package_name();
7388 // Note that this will be misleading if this is an unexported
7389 // method generated for an embedded imported type. In that case
7390 // the unexported method should have the package name of the
7391 // package from which it is imported, but we are going to give
7392 // it our package name. Fixing this would require knowing the
7393 // package name, but we only know the package path. It might be
7394 // better to use package paths here anyhow. This doesn't affect
7395 // the assembler code, because we always set that name in
7396 // Function::get_or_make_decl anyhow. FIXME.
7398 decl_name = package_name + '.' + Gogo::unpack_hidden_name(this->name_);
7400 Function_type* fntype;
7401 if (this->is_function())
7402 fntype = this->func_value()->type();
7403 else if (this->is_function_declaration())
7404 fntype = this->func_declaration_value()->type();
7405 else
7406 fntype = NULL;
7407 if (fntype != NULL && fntype->is_method())
7409 decl_name.push_back('.');
7410 decl_name.append(fntype->receiver()->type()->mangled_name(gogo));
7413 return decl_name;
7416 // Get the backend representation for this named object.
7418 void
7419 Named_object::get_backend(Gogo* gogo, std::vector<Bexpression*>& const_decls,
7420 std::vector<Btype*>& type_decls,
7421 std::vector<Bfunction*>& func_decls)
7423 // If this is a definition, avoid trying to get the backend
7424 // representation, as that can crash.
7425 if (this->is_redefinition_)
7427 go_assert(saw_errors());
7428 return;
7431 switch (this->classification_)
7433 case NAMED_OBJECT_CONST:
7434 if (!Gogo::is_erroneous_name(this->name_))
7435 const_decls.push_back(this->u_.const_value->get_backend(gogo, this));
7436 break;
7438 case NAMED_OBJECT_TYPE:
7440 Named_type* named_type = this->u_.type_value;
7441 if (!Gogo::is_erroneous_name(this->name_))
7442 type_decls.push_back(named_type->get_backend(gogo));
7444 // We need to produce a type descriptor for every named
7445 // type, and for a pointer to every named type, since
7446 // other files or packages might refer to them. We need
7447 // to do this even for hidden types, because they might
7448 // still be returned by some function. Simply calling the
7449 // type_descriptor method is enough to create the type
7450 // descriptor, even though we don't do anything with it.
7451 if (this->package_ == NULL && !saw_errors())
7453 named_type->
7454 type_descriptor_pointer(gogo, Linemap::predeclared_location());
7455 named_type->gc_symbol_pointer(gogo);
7456 Type* pn = Type::make_pointer_type(named_type);
7457 pn->type_descriptor_pointer(gogo, Linemap::predeclared_location());
7458 pn->gc_symbol_pointer(gogo);
7461 break;
7463 case NAMED_OBJECT_TYPE_DECLARATION:
7464 go_error_at(Linemap::unknown_location(),
7465 "reference to undefined type %qs",
7466 this->message_name().c_str());
7467 return;
7469 case NAMED_OBJECT_VAR:
7470 case NAMED_OBJECT_RESULT_VAR:
7471 case NAMED_OBJECT_SINK:
7472 go_unreachable();
7474 case NAMED_OBJECT_FUNC:
7476 Function* func = this->u_.func_value;
7477 if (!Gogo::is_erroneous_name(this->name_))
7478 func_decls.push_back(func->get_or_make_decl(gogo, this));
7480 if (func->block() != NULL)
7481 func->build(gogo, this);
7483 break;
7485 case NAMED_OBJECT_ERRONEOUS:
7486 break;
7488 default:
7489 go_unreachable();
7493 // Class Bindings.
7495 Bindings::Bindings(Bindings* enclosing)
7496 : enclosing_(enclosing), named_objects_(), bindings_()
7500 // Clear imports.
7502 void
7503 Bindings::clear_file_scope(Gogo* gogo)
7505 Contour::iterator p = this->bindings_.begin();
7506 while (p != this->bindings_.end())
7508 bool keep;
7509 if (p->second->package() != NULL)
7510 keep = false;
7511 else if (p->second->is_package())
7512 keep = false;
7513 else if (p->second->is_function()
7514 && !p->second->func_value()->type()->is_method()
7515 && Gogo::unpack_hidden_name(p->second->name()) == "init")
7516 keep = false;
7517 else
7518 keep = true;
7520 if (keep)
7521 ++p;
7522 else
7524 gogo->add_file_block_name(p->second->name(), p->second->location());
7525 p = this->bindings_.erase(p);
7530 // Look up a symbol.
7532 Named_object*
7533 Bindings::lookup(const std::string& name) const
7535 Contour::const_iterator p = this->bindings_.find(name);
7536 if (p != this->bindings_.end())
7537 return p->second->resolve();
7538 else if (this->enclosing_ != NULL)
7539 return this->enclosing_->lookup(name);
7540 else
7541 return NULL;
7544 // Look up a symbol locally.
7546 Named_object*
7547 Bindings::lookup_local(const std::string& name) const
7549 Contour::const_iterator p = this->bindings_.find(name);
7550 if (p == this->bindings_.end())
7551 return NULL;
7552 return p->second;
7555 // Remove an object from a set of bindings. This is used for a
7556 // special case in thunks for functions which call recover.
7558 void
7559 Bindings::remove_binding(Named_object* no)
7561 Contour::iterator pb = this->bindings_.find(no->name());
7562 go_assert(pb != this->bindings_.end());
7563 this->bindings_.erase(pb);
7564 for (std::vector<Named_object*>::iterator pn = this->named_objects_.begin();
7565 pn != this->named_objects_.end();
7566 ++pn)
7568 if (*pn == no)
7570 this->named_objects_.erase(pn);
7571 return;
7574 go_unreachable();
7577 // Add a method to the list of objects. This is not added to the
7578 // lookup table. This is so that we have a single list of objects
7579 // declared at the top level, which we walk through when it's time to
7580 // convert to trees.
7582 void
7583 Bindings::add_method(Named_object* method)
7585 this->named_objects_.push_back(method);
7588 // Add a generic Named_object to a Contour.
7590 Named_object*
7591 Bindings::add_named_object_to_contour(Contour* contour,
7592 Named_object* named_object)
7594 go_assert(named_object == named_object->resolve());
7595 const std::string& name(named_object->name());
7596 go_assert(!Gogo::is_sink_name(name));
7598 std::pair<Contour::iterator, bool> ins =
7599 contour->insert(std::make_pair(name, named_object));
7600 if (!ins.second)
7602 // The name was already there.
7603 if (named_object->package() != NULL
7604 && ins.first->second->package() == named_object->package()
7605 && (ins.first->second->classification()
7606 == named_object->classification()))
7608 // This is a second import of the same object.
7609 return ins.first->second;
7611 ins.first->second = this->new_definition(ins.first->second,
7612 named_object);
7613 return ins.first->second;
7615 else
7617 // Don't push declarations on the list. We push them on when
7618 // and if we find the definitions. That way we genericize the
7619 // functions in order.
7620 if (!named_object->is_type_declaration()
7621 && !named_object->is_function_declaration()
7622 && !named_object->is_unknown())
7623 this->named_objects_.push_back(named_object);
7624 return named_object;
7628 // We had an existing named object OLD_OBJECT, and we've seen a new
7629 // one NEW_OBJECT with the same name. FIXME: This does not free the
7630 // new object when we don't need it.
7632 Named_object*
7633 Bindings::new_definition(Named_object* old_object, Named_object* new_object)
7635 if (new_object->is_erroneous() && !old_object->is_erroneous())
7636 return new_object;
7638 std::string reason;
7639 switch (old_object->classification())
7641 default:
7642 case Named_object::NAMED_OBJECT_UNINITIALIZED:
7643 go_unreachable();
7645 case Named_object::NAMED_OBJECT_ERRONEOUS:
7646 return old_object;
7648 case Named_object::NAMED_OBJECT_UNKNOWN:
7650 Named_object* real = old_object->unknown_value()->real_named_object();
7651 if (real != NULL)
7652 return this->new_definition(real, new_object);
7653 go_assert(!new_object->is_unknown());
7654 old_object->unknown_value()->set_real_named_object(new_object);
7655 if (!new_object->is_type_declaration()
7656 && !new_object->is_function_declaration())
7657 this->named_objects_.push_back(new_object);
7658 return new_object;
7661 case Named_object::NAMED_OBJECT_CONST:
7662 break;
7664 case Named_object::NAMED_OBJECT_TYPE:
7665 if (new_object->is_type_declaration())
7666 return old_object;
7667 break;
7669 case Named_object::NAMED_OBJECT_TYPE_DECLARATION:
7670 if (new_object->is_type_declaration())
7671 return old_object;
7672 if (new_object->is_type())
7674 old_object->set_type_value(new_object->type_value());
7675 new_object->type_value()->set_named_object(old_object);
7676 this->named_objects_.push_back(old_object);
7677 return old_object;
7679 break;
7681 case Named_object::NAMED_OBJECT_VAR:
7682 case Named_object::NAMED_OBJECT_RESULT_VAR:
7683 // We have already given an error in the parser for cases where
7684 // one parameter or result variable redeclares another one.
7685 if ((new_object->is_variable()
7686 && new_object->var_value()->is_parameter())
7687 || new_object->is_result_variable())
7688 return old_object;
7689 break;
7691 case Named_object::NAMED_OBJECT_SINK:
7692 go_unreachable();
7694 case Named_object::NAMED_OBJECT_FUNC:
7695 if (new_object->is_function_declaration())
7697 if (!new_object->func_declaration_value()->asm_name().empty())
7698 go_error_at(Linemap::unknown_location(),
7699 ("sorry, not implemented: "
7700 "__asm__ for function definitions"));
7701 Function_type* old_type = old_object->func_value()->type();
7702 Function_type* new_type =
7703 new_object->func_declaration_value()->type();
7704 if (old_type->is_valid_redeclaration(new_type, &reason))
7705 return old_object;
7707 break;
7709 case Named_object::NAMED_OBJECT_FUNC_DECLARATION:
7711 if (new_object->is_function())
7713 Function_type* old_type =
7714 old_object->func_declaration_value()->type();
7715 Function_type* new_type = new_object->func_value()->type();
7716 if (old_type->is_valid_redeclaration(new_type, &reason))
7718 if (!old_object->func_declaration_value()->asm_name().empty())
7719 go_error_at(Linemap::unknown_location(),
7720 ("sorry, not implemented: "
7721 "__asm__ for function definitions"));
7722 old_object->set_function_value(new_object->func_value());
7723 this->named_objects_.push_back(old_object);
7724 return old_object;
7728 break;
7730 case Named_object::NAMED_OBJECT_PACKAGE:
7731 break;
7734 std::string n = old_object->message_name();
7735 if (reason.empty())
7736 go_error_at(new_object->location(), "redefinition of %qs", n.c_str());
7737 else
7738 go_error_at(new_object->location(), "redefinition of %qs: %s", n.c_str(),
7739 reason.c_str());
7740 old_object->set_is_redefinition();
7741 new_object->set_is_redefinition();
7743 go_inform(old_object->location(), "previous definition of %qs was here",
7744 n.c_str());
7746 return old_object;
7749 // Add a named type.
7751 Named_object*
7752 Bindings::add_named_type(Named_type* named_type)
7754 return this->add_named_object(named_type->named_object());
7757 // Add a function.
7759 Named_object*
7760 Bindings::add_function(const std::string& name, const Package* package,
7761 Function* function)
7763 return this->add_named_object(Named_object::make_function(name, package,
7764 function));
7767 // Add a function declaration.
7769 Named_object*
7770 Bindings::add_function_declaration(const std::string& name,
7771 const Package* package,
7772 Function_type* type,
7773 Location location)
7775 Named_object* no = Named_object::make_function_declaration(name, package,
7776 type, location);
7777 return this->add_named_object(no);
7780 // Define a type which was previously declared.
7782 void
7783 Bindings::define_type(Named_object* no, Named_type* type)
7785 no->set_type_value(type);
7786 this->named_objects_.push_back(no);
7789 // Mark all local variables as used. This is used for some types of
7790 // parse error.
7792 void
7793 Bindings::mark_locals_used()
7795 for (std::vector<Named_object*>::iterator p = this->named_objects_.begin();
7796 p != this->named_objects_.end();
7797 ++p)
7798 if ((*p)->is_variable())
7799 (*p)->var_value()->set_is_used();
7802 // Traverse bindings.
7805 Bindings::traverse(Traverse* traverse, bool is_global)
7807 unsigned int traverse_mask = traverse->traverse_mask();
7809 // We don't use an iterator because we permit the traversal to add
7810 // new global objects.
7811 const unsigned int e_or_t = (Traverse::traverse_expressions
7812 | Traverse::traverse_types);
7813 const unsigned int e_or_t_or_s = (e_or_t
7814 | Traverse::traverse_statements);
7815 for (size_t i = 0; i < this->named_objects_.size(); ++i)
7817 Named_object* p = this->named_objects_[i];
7818 int t = TRAVERSE_CONTINUE;
7819 switch (p->classification())
7821 case Named_object::NAMED_OBJECT_CONST:
7822 if ((traverse_mask & Traverse::traverse_constants) != 0)
7823 t = traverse->constant(p, is_global);
7824 if (t == TRAVERSE_CONTINUE
7825 && (traverse_mask & e_or_t) != 0)
7827 Type* tc = p->const_value()->type();
7828 if (tc != NULL
7829 && Type::traverse(tc, traverse) == TRAVERSE_EXIT)
7830 return TRAVERSE_EXIT;
7831 t = p->const_value()->traverse_expression(traverse);
7833 break;
7835 case Named_object::NAMED_OBJECT_VAR:
7836 case Named_object::NAMED_OBJECT_RESULT_VAR:
7837 if ((traverse_mask & Traverse::traverse_variables) != 0)
7838 t = traverse->variable(p);
7839 if (t == TRAVERSE_CONTINUE
7840 && (traverse_mask & e_or_t) != 0)
7842 if (p->is_result_variable()
7843 || p->var_value()->has_type())
7845 Type* tv = (p->is_variable()
7846 ? p->var_value()->type()
7847 : p->result_var_value()->type());
7848 if (tv != NULL
7849 && Type::traverse(tv, traverse) == TRAVERSE_EXIT)
7850 return TRAVERSE_EXIT;
7853 if (t == TRAVERSE_CONTINUE
7854 && (traverse_mask & e_or_t_or_s) != 0
7855 && p->is_variable())
7856 t = p->var_value()->traverse_expression(traverse, traverse_mask);
7857 break;
7859 case Named_object::NAMED_OBJECT_FUNC:
7860 if ((traverse_mask & Traverse::traverse_functions) != 0)
7861 t = traverse->function(p);
7863 if (t == TRAVERSE_CONTINUE
7864 && (traverse_mask
7865 & (Traverse::traverse_variables
7866 | Traverse::traverse_constants
7867 | Traverse::traverse_functions
7868 | Traverse::traverse_blocks
7869 | Traverse::traverse_statements
7870 | Traverse::traverse_expressions
7871 | Traverse::traverse_types)) != 0)
7872 t = p->func_value()->traverse(traverse);
7873 break;
7875 case Named_object::NAMED_OBJECT_PACKAGE:
7876 // These are traversed in Gogo::traverse.
7877 go_assert(is_global);
7878 break;
7880 case Named_object::NAMED_OBJECT_TYPE:
7881 if ((traverse_mask & e_or_t) != 0)
7882 t = Type::traverse(p->type_value(), traverse);
7883 break;
7885 case Named_object::NAMED_OBJECT_TYPE_DECLARATION:
7886 case Named_object::NAMED_OBJECT_FUNC_DECLARATION:
7887 case Named_object::NAMED_OBJECT_UNKNOWN:
7888 case Named_object::NAMED_OBJECT_ERRONEOUS:
7889 break;
7891 case Named_object::NAMED_OBJECT_SINK:
7892 default:
7893 go_unreachable();
7896 if (t == TRAVERSE_EXIT)
7897 return TRAVERSE_EXIT;
7900 // If we need to traverse types, check the function declarations,
7901 // which have types. Also check any methods of a type declaration.
7902 if ((traverse_mask & e_or_t) != 0)
7904 for (Bindings::const_declarations_iterator p =
7905 this->begin_declarations();
7906 p != this->end_declarations();
7907 ++p)
7909 if (p->second->is_function_declaration())
7911 if (Type::traverse(p->second->func_declaration_value()->type(),
7912 traverse)
7913 == TRAVERSE_EXIT)
7914 return TRAVERSE_EXIT;
7916 else if (p->second->is_type_declaration())
7918 const std::vector<Named_object*>* methods =
7919 p->second->type_declaration_value()->methods();
7920 for (std::vector<Named_object*>::const_iterator pm =
7921 methods->begin();
7922 pm != methods->end();
7923 pm++)
7925 Named_object* no = *pm;
7926 Type *t;
7927 if (no->is_function())
7928 t = no->func_value()->type();
7929 else if (no->is_function_declaration())
7930 t = no->func_declaration_value()->type();
7931 else
7932 continue;
7933 if (Type::traverse(t, traverse) == TRAVERSE_EXIT)
7934 return TRAVERSE_EXIT;
7940 // Traverse function declarations when needed.
7941 if ((traverse_mask & Traverse::traverse_func_declarations) != 0)
7943 for (Bindings::const_declarations_iterator p = this->begin_declarations();
7944 p != this->end_declarations();
7945 ++p)
7947 if (p->second->is_function_declaration())
7949 if (traverse->function_declaration(p->second) == TRAVERSE_EXIT)
7950 return TRAVERSE_EXIT;
7955 return TRAVERSE_CONTINUE;
7958 // Class Label.
7960 // Clear any references to this label.
7962 void
7963 Label::clear_refs()
7965 for (std::vector<Bindings_snapshot*>::iterator p = this->refs_.begin();
7966 p != this->refs_.end();
7967 ++p)
7968 delete *p;
7969 this->refs_.clear();
7972 // Get the backend representation for a label.
7974 Blabel*
7975 Label::get_backend_label(Translate_context* context)
7977 if (this->blabel_ == NULL)
7979 Function* function = context->function()->func_value();
7980 Bfunction* bfunction = function->get_decl();
7981 this->blabel_ = context->backend()->label(bfunction, this->name_,
7982 this->location_);
7984 return this->blabel_;
7987 // Return an expression for the address of this label.
7989 Bexpression*
7990 Label::get_addr(Translate_context* context, Location location)
7992 Blabel* label = this->get_backend_label(context);
7993 return context->backend()->label_address(label, location);
7996 // Return the dummy label that represents any instance of the blank label.
7998 Label*
7999 Label::create_dummy_label()
8001 static Label* dummy_label;
8002 if (dummy_label == NULL)
8004 dummy_label = new Label("_");
8005 dummy_label->set_is_used();
8007 return dummy_label;
8010 // Class Unnamed_label.
8012 // Get the backend representation for an unnamed label.
8014 Blabel*
8015 Unnamed_label::get_blabel(Translate_context* context)
8017 if (this->blabel_ == NULL)
8019 Function* function = context->function()->func_value();
8020 Bfunction* bfunction = function->get_decl();
8021 this->blabel_ = context->backend()->label(bfunction, "",
8022 this->location_);
8024 return this->blabel_;
8027 // Return a statement which defines this unnamed label.
8029 Bstatement*
8030 Unnamed_label::get_definition(Translate_context* context)
8032 Blabel* blabel = this->get_blabel(context);
8033 return context->backend()->label_definition_statement(blabel);
8036 // Return a goto statement to this unnamed label.
8038 Bstatement*
8039 Unnamed_label::get_goto(Translate_context* context, Location location)
8041 Blabel* blabel = this->get_blabel(context);
8042 return context->backend()->goto_statement(blabel, location);
8045 // Class Package.
8047 Package::Package(const std::string& pkgpath,
8048 const std::string& pkgpath_symbol, Location location)
8049 : pkgpath_(pkgpath), pkgpath_symbol_(pkgpath_symbol),
8050 package_name_(), bindings_(new Bindings(NULL)),
8051 location_(location)
8053 go_assert(!pkgpath.empty());
8056 // Set the package name.
8058 void
8059 Package::set_package_name(const std::string& package_name, Location location)
8061 go_assert(!package_name.empty());
8062 if (this->package_name_.empty())
8063 this->package_name_ = package_name;
8064 else if (this->package_name_ != package_name)
8065 go_error_at(location,
8066 ("saw two different packages with "
8067 "the same package path %s: %s, %s"),
8068 this->pkgpath_.c_str(), this->package_name_.c_str(),
8069 package_name.c_str());
8072 // Return the pkgpath symbol, which is a prefix for symbols defined in
8073 // this package.
8075 std::string
8076 Package::pkgpath_symbol() const
8078 if (this->pkgpath_symbol_.empty())
8079 return Gogo::pkgpath_for_symbol(this->pkgpath_);
8080 return this->pkgpath_symbol_;
8083 // Set the package path symbol.
8085 void
8086 Package::set_pkgpath_symbol(const std::string& pkgpath_symbol)
8088 go_assert(!pkgpath_symbol.empty());
8089 if (this->pkgpath_symbol_.empty())
8090 this->pkgpath_symbol_ = pkgpath_symbol;
8091 else
8092 go_assert(this->pkgpath_symbol_ == pkgpath_symbol);
8095 // Note that symbol from this package was and qualified by ALIAS.
8097 void
8098 Package::note_usage(const std::string& alias) const
8100 Aliases::const_iterator p = this->aliases_.find(alias);
8101 go_assert(p != this->aliases_.end());
8102 p->second->note_usage();
8105 // Forget a given usage. If forgetting this usage means this package becomes
8106 // unused, report that error.
8108 void
8109 Package::forget_usage(Expression* usage) const
8111 if (this->fake_uses_.empty())
8112 return;
8114 std::set<Expression*>::iterator p = this->fake_uses_.find(usage);
8115 go_assert(p != this->fake_uses_.end());
8116 this->fake_uses_.erase(p);
8118 if (this->fake_uses_.empty())
8119 go_error_at(this->location(), "imported and not used: %s",
8120 Gogo::message_name(this->package_name()).c_str());
8123 // Clear the used field for the next file. If the only usages of this package
8124 // are possibly fake, keep the fake usages for lowering.
8126 void
8127 Package::clear_used()
8129 std::string dot_alias = "." + this->package_name();
8130 Aliases::const_iterator p = this->aliases_.find(dot_alias);
8131 if (p != this->aliases_.end() && p->second->used() > this->fake_uses_.size())
8132 this->fake_uses_.clear();
8134 this->aliases_.clear();
8137 Package_alias*
8138 Package::add_alias(const std::string& alias, Location location)
8140 Aliases::const_iterator p = this->aliases_.find(alias);
8141 if (p == this->aliases_.end())
8143 std::pair<Aliases::iterator, bool> ret;
8144 ret = this->aliases_.insert(std::make_pair(alias,
8145 new Package_alias(location)));
8146 p = ret.first;
8148 return p->second;
8151 // Determine types of constants. Everything else in a package
8152 // (variables, function declarations) should already have a fixed
8153 // type. Constants may have abstract types.
8155 void
8156 Package::determine_types()
8158 Bindings* bindings = this->bindings_;
8159 for (Bindings::const_definitions_iterator p = bindings->begin_definitions();
8160 p != bindings->end_definitions();
8161 ++p)
8163 if ((*p)->is_const())
8164 (*p)->const_value()->determine_type();
8168 // Class Traverse.
8170 // Destructor.
8172 Traverse::~Traverse()
8174 if (this->types_seen_ != NULL)
8175 delete this->types_seen_;
8176 if (this->expressions_seen_ != NULL)
8177 delete this->expressions_seen_;
8180 // Record that we are looking at a type, and return true if we have
8181 // already seen it.
8183 bool
8184 Traverse::remember_type(const Type* type)
8186 if (type->is_error_type())
8187 return true;
8188 go_assert((this->traverse_mask() & traverse_types) != 0
8189 || (this->traverse_mask() & traverse_expressions) != 0);
8190 // We mostly only have to remember named types. But it turns out
8191 // that an interface type can refer to itself without using a name
8192 // by relying on interface inheritance, as in
8193 // type I interface { F() interface{I} }
8194 if (type->classification() != Type::TYPE_NAMED
8195 && type->classification() != Type::TYPE_INTERFACE)
8196 return false;
8197 if (this->types_seen_ == NULL)
8198 this->types_seen_ = new Types_seen();
8199 std::pair<Types_seen::iterator, bool> ins = this->types_seen_->insert(type);
8200 return !ins.second;
8203 // Record that we are looking at an expression, and return true if we
8204 // have already seen it. NB: this routine used to assert if the traverse
8205 // mask did not include expressions/types -- this is no longer the case,
8206 // since it can be useful to remember specific expressions during
8207 // walks that only cover statements.
8209 bool
8210 Traverse::remember_expression(const Expression* expression)
8212 if (this->expressions_seen_ == NULL)
8213 this->expressions_seen_ = new Expressions_seen();
8214 std::pair<Expressions_seen::iterator, bool> ins =
8215 this->expressions_seen_->insert(expression);
8216 return !ins.second;
8219 // The default versions of these functions should never be called: the
8220 // traversal mask indicates which functions may be called.
8223 Traverse::variable(Named_object*)
8225 go_unreachable();
8229 Traverse::constant(Named_object*, bool)
8231 go_unreachable();
8235 Traverse::function(Named_object*)
8237 go_unreachable();
8241 Traverse::block(Block*)
8243 go_unreachable();
8247 Traverse::statement(Block*, size_t*, Statement*)
8249 go_unreachable();
8253 Traverse::expression(Expression**)
8255 go_unreachable();
8259 Traverse::type(Type*)
8261 go_unreachable();
8265 Traverse::function_declaration(Named_object*)
8267 go_unreachable();
8270 // Class Statement_inserter.
8272 void
8273 Statement_inserter::insert(Statement* s)
8275 if (this->block_ != NULL)
8277 go_assert(this->pindex_ != NULL);
8278 this->block_->insert_statement_before(*this->pindex_, s);
8279 ++*this->pindex_;
8281 else if (this->var_ != NULL)
8282 this->var_->add_preinit_statement(this->gogo_, s);
8283 else
8284 go_assert(saw_errors());