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.
13 #include "statements.h"
14 #include "expressions.h"
24 Gogo::Gogo(Backend* backend, Linemap* linemap, int int_type_size,
30 globals_(new Bindings(NULL)),
32 imported_unsafe_(false),
39 unique_prefix_specified_(false),
42 specific_type_functions_(),
43 specific_type_functions_are_written_(false),
44 named_types_are_converted_(false)
46 const Location loc = Linemap::predeclared_location();
48 Named_type* uint8_type = Type::make_integer_type("uint8", true, 8,
49 RUNTIME_TYPE_KIND_UINT8);
50 this->add_named_type(uint8_type);
51 this->add_named_type(Type::make_integer_type("uint16", true, 16,
52 RUNTIME_TYPE_KIND_UINT16));
53 this->add_named_type(Type::make_integer_type("uint32", true, 32,
54 RUNTIME_TYPE_KIND_UINT32));
55 this->add_named_type(Type::make_integer_type("uint64", true, 64,
56 RUNTIME_TYPE_KIND_UINT64));
58 this->add_named_type(Type::make_integer_type("int8", false, 8,
59 RUNTIME_TYPE_KIND_INT8));
60 this->add_named_type(Type::make_integer_type("int16", false, 16,
61 RUNTIME_TYPE_KIND_INT16));
62 Named_type* int32_type = Type::make_integer_type("int32", false, 32,
63 RUNTIME_TYPE_KIND_INT32);
64 this->add_named_type(int32_type);
65 this->add_named_type(Type::make_integer_type("int64", false, 64,
66 RUNTIME_TYPE_KIND_INT64));
68 this->add_named_type(Type::make_float_type("float32", 32,
69 RUNTIME_TYPE_KIND_FLOAT32));
70 this->add_named_type(Type::make_float_type("float64", 64,
71 RUNTIME_TYPE_KIND_FLOAT64));
73 this->add_named_type(Type::make_complex_type("complex64", 64,
74 RUNTIME_TYPE_KIND_COMPLEX64));
75 this->add_named_type(Type::make_complex_type("complex128", 128,
76 RUNTIME_TYPE_KIND_COMPLEX128));
78 if (int_type_size < 32)
80 this->add_named_type(Type::make_integer_type("uint", true,
82 RUNTIME_TYPE_KIND_UINT));
83 Named_type* int_type = Type::make_integer_type("int", false, int_type_size,
84 RUNTIME_TYPE_KIND_INT);
85 this->add_named_type(int_type);
87 this->add_named_type(Type::make_integer_type("uintptr", true,
89 RUNTIME_TYPE_KIND_UINTPTR));
91 // "byte" is an alias for "uint8".
92 uint8_type->integer_type()->set_is_byte();
93 Named_object* byte_type = Named_object::make_type("byte", NULL, uint8_type,
95 this->add_named_type(byte_type->type_value());
97 // "rune" is an alias for "int32".
98 int32_type->integer_type()->set_is_rune();
99 Named_object* rune_type = Named_object::make_type("rune", NULL, int32_type,
101 this->add_named_type(rune_type->type_value());
103 this->add_named_type(Type::make_named_bool_type());
105 this->add_named_type(Type::make_named_string_type());
107 // "error" is interface { Error() string }.
109 Typed_identifier_list *methods = new Typed_identifier_list;
110 Typed_identifier_list *results = new Typed_identifier_list;
111 results->push_back(Typed_identifier("", Type::lookup_string_type(), loc));
112 Type *method_type = Type::make_function_type(NULL, NULL, results, loc);
113 methods->push_back(Typed_identifier("Error", method_type, loc));
114 Interface_type *error_iface = Type::make_interface_type(methods, loc);
115 error_iface->finalize_methods();
116 Named_type *error_type = Named_object::make_type("error", NULL, error_iface, loc)->type_value();
117 this->add_named_type(error_type);
120 this->globals_->add_constant(Typed_identifier("true",
121 Type::make_boolean_type(),
124 Expression::make_boolean(true, loc),
126 this->globals_->add_constant(Typed_identifier("false",
127 Type::make_boolean_type(),
130 Expression::make_boolean(false, loc),
133 this->globals_->add_constant(Typed_identifier("nil", Type::make_nil_type(),
136 Expression::make_nil(loc),
139 Type* abstract_int_type = Type::make_abstract_integer_type();
140 this->globals_->add_constant(Typed_identifier("iota", abstract_int_type,
143 Expression::make_iota(),
146 Function_type* new_type = Type::make_function_type(NULL, NULL, NULL, loc);
147 new_type->set_is_varargs();
148 new_type->set_is_builtin();
149 this->globals_->add_function_declaration("new", NULL, new_type, loc);
151 Function_type* make_type = Type::make_function_type(NULL, NULL, NULL, loc);
152 make_type->set_is_varargs();
153 make_type->set_is_builtin();
154 this->globals_->add_function_declaration("make", NULL, make_type, loc);
156 Typed_identifier_list* len_result = new Typed_identifier_list();
157 len_result->push_back(Typed_identifier("", int_type, loc));
158 Function_type* len_type = Type::make_function_type(NULL, NULL, len_result,
160 len_type->set_is_builtin();
161 this->globals_->add_function_declaration("len", NULL, len_type, loc);
163 Typed_identifier_list* cap_result = new Typed_identifier_list();
164 cap_result->push_back(Typed_identifier("", int_type, loc));
165 Function_type* cap_type = Type::make_function_type(NULL, NULL, len_result,
167 cap_type->set_is_builtin();
168 this->globals_->add_function_declaration("cap", NULL, cap_type, loc);
170 Function_type* print_type = Type::make_function_type(NULL, NULL, NULL, loc);
171 print_type->set_is_varargs();
172 print_type->set_is_builtin();
173 this->globals_->add_function_declaration("print", NULL, print_type, loc);
175 print_type = Type::make_function_type(NULL, NULL, NULL, loc);
176 print_type->set_is_varargs();
177 print_type->set_is_builtin();
178 this->globals_->add_function_declaration("println", NULL, print_type, loc);
180 Type *empty = Type::make_empty_interface_type(loc);
181 Typed_identifier_list* panic_parms = new Typed_identifier_list();
182 panic_parms->push_back(Typed_identifier("e", empty, loc));
183 Function_type *panic_type = Type::make_function_type(NULL, panic_parms,
185 panic_type->set_is_builtin();
186 this->globals_->add_function_declaration("panic", NULL, panic_type, loc);
188 Typed_identifier_list* recover_result = new Typed_identifier_list();
189 recover_result->push_back(Typed_identifier("", empty, loc));
190 Function_type* recover_type = Type::make_function_type(NULL, NULL,
193 recover_type->set_is_builtin();
194 this->globals_->add_function_declaration("recover", NULL, recover_type, loc);
196 Function_type* close_type = Type::make_function_type(NULL, NULL, NULL, loc);
197 close_type->set_is_varargs();
198 close_type->set_is_builtin();
199 this->globals_->add_function_declaration("close", NULL, close_type, loc);
201 Typed_identifier_list* copy_result = new Typed_identifier_list();
202 copy_result->push_back(Typed_identifier("", int_type, loc));
203 Function_type* copy_type = Type::make_function_type(NULL, NULL,
205 copy_type->set_is_varargs();
206 copy_type->set_is_builtin();
207 this->globals_->add_function_declaration("copy", NULL, copy_type, loc);
209 Function_type* append_type = Type::make_function_type(NULL, NULL, NULL, loc);
210 append_type->set_is_varargs();
211 append_type->set_is_builtin();
212 this->globals_->add_function_declaration("append", NULL, append_type, loc);
214 Function_type* complex_type = Type::make_function_type(NULL, NULL, NULL, loc);
215 complex_type->set_is_varargs();
216 complex_type->set_is_builtin();
217 this->globals_->add_function_declaration("complex", NULL, complex_type, loc);
219 Function_type* real_type = Type::make_function_type(NULL, NULL, NULL, loc);
220 real_type->set_is_varargs();
221 real_type->set_is_builtin();
222 this->globals_->add_function_declaration("real", NULL, real_type, loc);
224 Function_type* imag_type = Type::make_function_type(NULL, NULL, NULL, loc);
225 imag_type->set_is_varargs();
226 imag_type->set_is_builtin();
227 this->globals_->add_function_declaration("imag", NULL, imag_type, loc);
229 Function_type* delete_type = Type::make_function_type(NULL, NULL, NULL, loc);
230 delete_type->set_is_varargs();
231 delete_type->set_is_builtin();
232 this->globals_->add_function_declaration("delete", NULL, delete_type, loc);
235 // Munge name for use in an error message.
238 Gogo::message_name(const std::string& name)
240 return go_localize_identifier(Gogo::unpack_hidden_name(name).c_str());
243 // Get the package name.
246 Gogo::package_name() const
248 go_assert(this->package_ != NULL);
249 return this->package_->name();
252 // Set the package name.
255 Gogo::set_package_name(const std::string& package_name,
258 if (this->package_ != NULL && this->package_->name() != package_name)
260 error_at(location, "expected package %<%s%>",
261 Gogo::message_name(this->package_->name()).c_str());
265 // If the user did not specify a unique prefix, we always use "go".
266 // This in effect requires that the package name be unique.
267 if (this->unique_prefix_.empty())
268 this->unique_prefix_ = "go";
270 this->package_ = this->register_package(package_name, this->unique_prefix_,
273 // We used to permit people to qualify symbols with the current
274 // package name (e.g., P.x), but we no longer do.
275 // this->globals_->add_package(package_name, this->package_);
277 if (this->is_main_package())
279 // Declare "main" as a function which takes no parameters and
281 Location uloc = Linemap::unknown_location();
282 this->declare_function("main",
283 Type::make_function_type (NULL, NULL, NULL, uloc),
288 // Return whether this is the "main" package. This is not true if
289 // -fgo-prefix was used.
292 Gogo::is_main_package() const
294 return this->package_name() == "main" && !this->unique_prefix_specified_;
300 Gogo::import_package(const std::string& filename,
301 const std::string& local_name,
302 bool is_local_name_exported,
305 if (filename == "unsafe")
307 this->import_unsafe(local_name, is_local_name_exported, location);
311 Imports::const_iterator p = this->imports_.find(filename);
312 if (p != this->imports_.end())
314 Package* package = p->second;
315 package->set_location(location);
316 package->set_is_imported();
317 std::string ln = local_name;
318 bool is_ln_exported = is_local_name_exported;
321 ln = package->name();
322 is_ln_exported = Lex::is_exported_name(ln);
326 Bindings* bindings = package->bindings();
327 for (Bindings::const_declarations_iterator p =
328 bindings->begin_declarations();
329 p != bindings->end_declarations();
331 this->add_named_object(p->second);
334 package->set_uses_sink_alias();
337 ln = this->pack_hidden_name(ln, is_ln_exported);
338 this->package_->bindings()->add_package(ln, package);
343 Import::Stream* stream = Import::open_package(filename, location);
346 error_at(location, "import file %qs not found", filename.c_str());
350 Import imp(stream, location);
351 imp.register_builtin_types(this);
352 Package* package = imp.import(this, local_name, is_local_name_exported);
355 if (package->name() == this->package_name()
356 && package->unique_prefix() == this->unique_prefix())
358 ("imported package uses same package name and prefix "
359 "as package being compiled (see -fgo-prefix option)"));
361 this->imports_.insert(std::make_pair(filename, package));
362 package->set_is_imported();
368 // Add an import control function for an imported package to the list.
371 Gogo::add_import_init_fn(const std::string& package_name,
372 const std::string& init_name, int prio)
374 for (std::set<Import_init>::const_iterator p =
375 this->imported_init_fns_.begin();
376 p != this->imported_init_fns_.end();
379 if (p->init_name() == init_name
380 && (p->package_name() != package_name || p->priority() != prio))
382 error("duplicate package initialization name %qs",
383 Gogo::message_name(init_name).c_str());
384 inform(UNKNOWN_LOCATION, "used by package %qs at priority %d",
385 Gogo::message_name(p->package_name()).c_str(),
387 inform(UNKNOWN_LOCATION, " and by package %qs at priority %d",
388 Gogo::message_name(package_name).c_str(), prio);
393 this->imported_init_fns_.insert(Import_init(package_name, init_name,
397 // Return whether we are at the global binding level.
400 Gogo::in_global_scope() const
402 return this->functions_.empty();
405 // Return the current binding contour.
408 Gogo::current_bindings()
410 if (!this->functions_.empty())
411 return this->functions_.back().blocks.back()->bindings();
412 else if (this->package_ != NULL)
413 return this->package_->bindings();
415 return this->globals_;
419 Gogo::current_bindings() const
421 if (!this->functions_.empty())
422 return this->functions_.back().blocks.back()->bindings();
423 else if (this->package_ != NULL)
424 return this->package_->bindings();
426 return this->globals_;
429 // Return the current block.
432 Gogo::current_block()
434 if (this->functions_.empty())
437 return this->functions_.back().blocks.back();
440 // Look up a name in the current binding contour. If PFUNCTION is not
441 // NULL, set it to the function in which the name is defined, or NULL
442 // if the name is defined in global scope.
445 Gogo::lookup(const std::string& name, Named_object** pfunction) const
447 if (pfunction != NULL)
450 if (Gogo::is_sink_name(name))
451 return Named_object::make_sink();
453 for (Open_functions::const_reverse_iterator p = this->functions_.rbegin();
454 p != this->functions_.rend();
457 Named_object* ret = p->blocks.back()->bindings()->lookup(name);
460 if (pfunction != NULL)
461 *pfunction = p->function;
466 if (this->package_ != NULL)
468 Named_object* ret = this->package_->bindings()->lookup(name);
471 if (ret->package() != NULL)
472 ret->package()->set_used();
477 // We do not look in the global namespace. If we did, the global
478 // namespace would effectively hide names which were defined in
479 // package scope which we have not yet seen. Instead,
480 // define_global_names is called after parsing is over to connect
481 // undefined names at package scope with names defined at global
487 // Look up a name in the current block, without searching enclosing
491 Gogo::lookup_in_block(const std::string& name) const
493 go_assert(!this->functions_.empty());
494 go_assert(!this->functions_.back().blocks.empty());
495 return this->functions_.back().blocks.back()->bindings()->lookup_local(name);
498 // Look up a name in the global namespace.
501 Gogo::lookup_global(const char* name) const
503 return this->globals_->lookup(name);
506 // Add an imported package.
509 Gogo::add_imported_package(const std::string& real_name,
510 const std::string& alias_arg,
511 bool is_alias_exported,
512 const std::string& unique_prefix,
514 bool* padd_to_globals)
516 // FIXME: Now that we compile packages as a whole, should we permit
517 // importing the current package?
518 if (this->package_name() == real_name
519 && this->unique_prefix() == unique_prefix)
521 *padd_to_globals = false;
522 if (!alias_arg.empty() && alias_arg != ".")
524 std::string alias = this->pack_hidden_name(alias_arg,
526 this->package_->bindings()->add_package(alias, this->package_);
528 return this->package_;
530 else if (alias_arg == ".")
532 *padd_to_globals = true;
533 return this->register_package(real_name, unique_prefix, location);
535 else if (alias_arg == "_")
537 Package* ret = this->register_package(real_name, unique_prefix, location);
538 ret->set_uses_sink_alias();
543 *padd_to_globals = false;
544 std::string alias = alias_arg;
548 is_alias_exported = Lex::is_exported_name(alias);
550 alias = this->pack_hidden_name(alias, is_alias_exported);
551 Named_object* no = this->add_package(real_name, alias, unique_prefix,
553 if (!no->is_package())
555 return no->package_value();
562 Gogo::add_package(const std::string& real_name, const std::string& alias,
563 const std::string& unique_prefix, Location location)
565 go_assert(this->in_global_scope());
567 // Register the package. Note that we might have already seen it in
568 // an earlier import.
569 Package* package = this->register_package(real_name, unique_prefix, location);
571 return this->package_->bindings()->add_package(alias, package);
574 // Register a package. This package may or may not be imported. This
575 // returns the Package structure for the package, creating if it
579 Gogo::register_package(const std::string& package_name,
580 const std::string& unique_prefix,
583 go_assert(!unique_prefix.empty() && !package_name.empty());
584 std::string name = unique_prefix + '.' + package_name;
585 Package* package = NULL;
586 std::pair<Packages::iterator, bool> ins =
587 this->packages_.insert(std::make_pair(name, package));
590 // We have seen this package name before.
591 package = ins.first->second;
592 go_assert(package != NULL);
593 go_assert(package->name() == package_name
594 && package->unique_prefix() == unique_prefix);
595 if (Linemap::is_unknown_location(package->location()))
596 package->set_location(location);
600 // First time we have seen this package name.
601 package = new Package(package_name, unique_prefix, location);
602 go_assert(ins.first->second == NULL);
603 ins.first->second = package;
609 // Start compiling a function.
612 Gogo::start_function(const std::string& name, Function_type* type,
613 bool add_method_to_type, Location location)
615 bool at_top_level = this->functions_.empty();
617 Block* block = new Block(NULL, location);
619 Function* enclosing = (at_top_level
621 : this->functions_.back().function->func_value());
623 Function* function = new Function(type, enclosing, block, location);
625 if (type->is_method())
627 const Typed_identifier* receiver = type->receiver();
628 Variable* this_param = new Variable(receiver->type(), NULL, false,
629 true, true, location);
630 std::string rname = receiver->name();
631 if (rname.empty() || Gogo::is_sink_name(rname))
633 // We need to give receivers a name since they wind up in
634 // DECL_ARGUMENTS. FIXME.
635 static unsigned int count;
637 snprintf(buf, sizeof buf, "r.%u", count);
641 block->bindings()->add_variable(rname, NULL, this_param);
644 const Typed_identifier_list* parameters = type->parameters();
645 bool is_varargs = type->is_varargs();
646 if (parameters != NULL)
648 for (Typed_identifier_list::const_iterator p = parameters->begin();
649 p != parameters->end();
652 Variable* param = new Variable(p->type(), NULL, false, true, false,
654 if (is_varargs && p + 1 == parameters->end())
655 param->set_is_varargs_parameter();
657 std::string pname = p->name();
658 if (pname.empty() || Gogo::is_sink_name(pname))
660 // We need to give parameters a name since they wind up
661 // in DECL_ARGUMENTS. FIXME.
662 static unsigned int count;
664 snprintf(buf, sizeof buf, "p.%u", count);
668 block->bindings()->add_variable(pname, NULL, param);
672 function->create_result_variables(this);
674 const std::string* pname;
675 std::string nested_name;
676 bool is_init = false;
677 if (Gogo::unpack_hidden_name(name) == "init" && !type->is_method())
679 if ((type->parameters() != NULL && !type->parameters()->empty())
680 || (type->results() != NULL && !type->results()->empty()))
682 "func init must have no arguments and no return values");
683 // There can be multiple "init" functions, so give them each a
685 static int init_count;
687 snprintf(buf, sizeof buf, ".$init%d", init_count);
690 pname = &nested_name;
693 else if (!name.empty())
697 // Invent a name for a nested function.
698 static int nested_count;
700 snprintf(buf, sizeof buf, ".$nested%d", nested_count);
703 pname = &nested_name;
707 if (Gogo::is_sink_name(*pname))
709 static int sink_count;
711 snprintf(buf, sizeof buf, ".$sink%d", sink_count);
713 ret = Named_object::make_function(buf, NULL, function);
715 else if (!type->is_method())
717 ret = this->package_->bindings()->add_function(*pname, NULL, function);
718 if (!ret->is_function() || ret->func_value() != function)
720 // Redefinition error. Invent a name to avoid knockon
722 static int redefinition_count;
724 snprintf(buf, sizeof buf, ".$redefined%d", redefinition_count);
725 ++redefinition_count;
726 ret = this->package_->bindings()->add_function(buf, NULL, function);
731 if (!add_method_to_type)
732 ret = Named_object::make_function(name, NULL, function);
735 go_assert(at_top_level);
736 Type* rtype = type->receiver()->type();
738 // We want to look through the pointer created by the
739 // parser, without getting an error if the type is not yet
741 if (rtype->classification() == Type::TYPE_POINTER)
742 rtype = rtype->points_to();
744 if (rtype->is_error_type())
745 ret = Named_object::make_function(name, NULL, function);
746 else if (rtype->named_type() != NULL)
748 ret = rtype->named_type()->add_method(name, function);
749 if (!ret->is_function())
751 // Redefinition error.
752 ret = Named_object::make_function(name, NULL, function);
755 else if (rtype->forward_declaration_type() != NULL)
757 Named_object* type_no =
758 rtype->forward_declaration_type()->named_object();
759 if (type_no->is_unknown())
761 // If we are seeing methods it really must be a
762 // type. Declare it as such. An alternative would
763 // be to support lists of methods for unknown
764 // expressions. Either way the error messages if
765 // this is not a type are going to get confusing.
766 Named_object* declared =
767 this->declare_package_type(type_no->name(),
768 type_no->location());
770 == type_no->unknown_value()->real_named_object());
772 ret = rtype->forward_declaration_type()->add_method(name,
778 this->package_->bindings()->add_method(ret);
781 this->functions_.resize(this->functions_.size() + 1);
782 Open_function& of(this->functions_.back());
784 of.blocks.push_back(block);
788 this->init_functions_.push_back(ret);
789 this->need_init_fn_ = true;
795 // Finish compiling a function.
798 Gogo::finish_function(Location location)
800 this->finish_block(location);
801 go_assert(this->functions_.back().blocks.empty());
802 this->functions_.pop_back();
805 // Return the current function.
808 Gogo::current_function() const
810 go_assert(!this->functions_.empty());
811 return this->functions_.back().function;
814 // Start a new block.
817 Gogo::start_block(Location location)
819 go_assert(!this->functions_.empty());
820 Block* block = new Block(this->current_block(), location);
821 this->functions_.back().blocks.push_back(block);
827 Gogo::finish_block(Location location)
829 go_assert(!this->functions_.empty());
830 go_assert(!this->functions_.back().blocks.empty());
831 Block* block = this->functions_.back().blocks.back();
832 this->functions_.back().blocks.pop_back();
833 block->set_end_location(location);
837 // Add an erroneous name.
840 Gogo::add_erroneous_name(const std::string& name)
842 return this->package_->bindings()->add_erroneous_name(name);
845 // Add an unknown name.
848 Gogo::add_unknown_name(const std::string& name, Location location)
850 return this->package_->bindings()->add_unknown_name(name, location);
853 // Declare a function.
856 Gogo::declare_function(const std::string& name, Function_type* type,
859 if (!type->is_method())
860 return this->current_bindings()->add_function_declaration(name, NULL, type,
864 // We don't bother to add this to the list of global
866 Type* rtype = type->receiver()->type();
868 // We want to look through the pointer created by the
869 // parser, without getting an error if the type is not yet
871 if (rtype->classification() == Type::TYPE_POINTER)
872 rtype = rtype->points_to();
874 if (rtype->is_error_type())
876 else if (rtype->named_type() != NULL)
877 return rtype->named_type()->add_method_declaration(name, NULL, type,
879 else if (rtype->forward_declaration_type() != NULL)
881 Forward_declaration_type* ftype = rtype->forward_declaration_type();
882 return ftype->add_method_declaration(name, NULL, type, location);
889 // Add a label definition.
892 Gogo::add_label_definition(const std::string& label_name,
895 go_assert(!this->functions_.empty());
896 Function* func = this->functions_.back().function->func_value();
897 Label* label = func->add_label_definition(this, label_name, location);
898 this->add_statement(Statement::make_label_statement(label, location));
902 // Add a label reference.
905 Gogo::add_label_reference(const std::string& label_name,
906 Location location, bool issue_goto_errors)
908 go_assert(!this->functions_.empty());
909 Function* func = this->functions_.back().function->func_value();
910 return func->add_label_reference(this, label_name, location,
914 // Return the current binding state.
917 Gogo::bindings_snapshot(Location location)
919 return new Bindings_snapshot(this->current_block(), location);
925 Gogo::add_statement(Statement* statement)
927 go_assert(!this->functions_.empty()
928 && !this->functions_.back().blocks.empty());
929 this->functions_.back().blocks.back()->add_statement(statement);
935 Gogo::add_block(Block* block, Location location)
937 go_assert(!this->functions_.empty()
938 && !this->functions_.back().blocks.empty());
939 Statement* statement = Statement::make_block_statement(block, location);
940 this->functions_.back().blocks.back()->add_statement(statement);
946 Gogo::add_constant(const Typed_identifier& tid, Expression* expr,
949 return this->current_bindings()->add_constant(tid, NULL, expr, iota_value);
955 Gogo::add_type(const std::string& name, Type* type, Location location)
957 Named_object* no = this->current_bindings()->add_type(name, NULL, type,
959 if (!this->in_global_scope() && no->is_type())
960 no->type_value()->set_in_function(this->functions_.back().function);
966 Gogo::add_named_type(Named_type* type)
968 go_assert(this->in_global_scope());
969 this->current_bindings()->add_named_type(type);
975 Gogo::declare_type(const std::string& name, Location location)
977 Bindings* bindings = this->current_bindings();
978 Named_object* no = bindings->add_type_declaration(name, NULL, location);
979 if (!this->in_global_scope() && no->is_type_declaration())
981 Named_object* f = this->functions_.back().function;
982 no->type_declaration_value()->set_in_function(f);
987 // Declare a type at the package level.
990 Gogo::declare_package_type(const std::string& name, Location location)
992 return this->package_->bindings()->add_type_declaration(name, NULL, location);
995 // Declare a function at the package level.
998 Gogo::declare_package_function(const std::string& name, Function_type* type,
1001 return this->package_->bindings()->add_function_declaration(name, NULL, type,
1005 // Define a type which was already declared.
1008 Gogo::define_type(Named_object* no, Named_type* type)
1010 this->current_bindings()->define_type(no, type);
1016 Gogo::add_variable(const std::string& name, Variable* variable)
1018 Named_object* no = this->current_bindings()->add_variable(name, NULL,
1021 // In a function the middle-end wants to see a DECL_EXPR node.
1023 && no->is_variable()
1024 && !no->var_value()->is_parameter()
1025 && !this->functions_.empty())
1026 this->add_statement(Statement::make_variable_declaration(no));
1031 // Add a sink--a reference to the blank identifier _.
1036 return Named_object::make_sink();
1039 // Add a named object.
1042 Gogo::add_named_object(Named_object* no)
1044 this->current_bindings()->add_named_object(no);
1047 // Mark all local variables used. This is used when some types of
1048 // parse error occur.
1051 Gogo::mark_locals_used()
1053 for (Open_functions::iterator pf = this->functions_.begin();
1054 pf != this->functions_.end();
1057 for (std::vector<Block*>::iterator pb = pf->blocks.begin();
1058 pb != pf->blocks.end();
1060 (*pb)->bindings()->mark_locals_used();
1064 // Record that we've seen an interface type.
1067 Gogo::record_interface_type(Interface_type* itype)
1069 this->interface_types_.push_back(itype);
1072 // Return a name for a thunk object.
1077 static int thunk_count;
1078 char thunk_name[50];
1079 snprintf(thunk_name, sizeof thunk_name, "$thunk%d", thunk_count);
1084 // Return whether a function is a thunk.
1087 Gogo::is_thunk(const Named_object* no)
1089 return no->name().compare(0, 6, "$thunk") == 0;
1092 // Define the global names. We do this only after parsing all the
1093 // input files, because the program might define the global names
1097 Gogo::define_global_names()
1099 for (Bindings::const_declarations_iterator p =
1100 this->globals_->begin_declarations();
1101 p != this->globals_->end_declarations();
1104 Named_object* global_no = p->second;
1105 std::string name(Gogo::pack_hidden_name(global_no->name(), false));
1106 Named_object* no = this->package_->bindings()->lookup(name);
1110 if (no->is_type_declaration())
1112 if (global_no->is_type())
1114 if (no->type_declaration_value()->has_methods())
1115 error_at(no->location(),
1116 "may not define methods for global type");
1117 no->set_type_value(global_no->type_value());
1121 error_at(no->location(), "expected type");
1122 Type* errtype = Type::make_error_type();
1124 Named_object::make_type("erroneous_type", NULL, errtype,
1125 Linemap::predeclared_location());
1126 no->set_type_value(err->type_value());
1129 else if (no->is_unknown())
1130 no->unknown_value()->set_real_named_object(global_no);
1134 // Clear out names in file scope.
1137 Gogo::clear_file_scope()
1139 this->package_->bindings()->clear_file_scope();
1141 // Warn about packages which were imported but not used.
1142 for (Packages::iterator p = this->packages_.begin();
1143 p != this->packages_.end();
1146 Package* package = p->second;
1147 if (package != this->package_
1148 && package->is_imported()
1150 && !package->uses_sink_alias()
1152 error_at(package->location(), "imported and not used: %s",
1153 Gogo::message_name(package->name()).c_str());
1154 package->clear_is_imported();
1155 package->clear_uses_sink_alias();
1156 package->clear_used();
1160 // Queue up a type specific function for later writing. These are
1161 // written out in write_specific_type_functions, called after the
1162 // parse tree is lowered.
1165 Gogo::queue_specific_type_function(Type* type, Named_type* name,
1166 const std::string& hash_name,
1167 Function_type* hash_fntype,
1168 const std::string& equal_name,
1169 Function_type* equal_fntype)
1171 go_assert(!this->specific_type_functions_are_written_);
1172 go_assert(!this->in_global_scope());
1173 Specific_type_function* tsf = new Specific_type_function(type, name,
1178 this->specific_type_functions_.push_back(tsf);
1181 // Look for types which need specific hash or equality functions.
1183 class Specific_type_functions : public Traverse
1186 Specific_type_functions(Gogo* gogo)
1187 : Traverse(traverse_types),
1199 Specific_type_functions::type(Type* t)
1201 Named_object* hash_fn;
1202 Named_object* equal_fn;
1203 switch (t->classification())
1205 case Type::TYPE_NAMED:
1207 Named_type* nt = t->named_type();
1208 if (!t->compare_is_identity(this->gogo_) && t->is_comparable())
1209 t->type_functions(this->gogo_, nt, NULL, NULL, &hash_fn, &equal_fn);
1211 // If this is a struct type, we don't want to make functions
1212 // for the unnamed struct.
1213 Type* rt = nt->real_type();
1214 if (rt->struct_type() == NULL)
1216 if (Type::traverse(rt, this) == TRAVERSE_EXIT)
1217 return TRAVERSE_EXIT;
1221 // If this type is defined in another package, then we don't
1222 // need to worry about the unexported fields.
1223 bool is_defined_elsewhere = nt->named_object()->package() != NULL;
1224 const Struct_field_list* fields = rt->struct_type()->fields();
1225 for (Struct_field_list::const_iterator p = fields->begin();
1229 if (is_defined_elsewhere
1230 && Gogo::is_hidden_name(p->field_name()))
1232 if (Type::traverse(p->type(), this) == TRAVERSE_EXIT)
1233 return TRAVERSE_EXIT;
1237 return TRAVERSE_SKIP_COMPONENTS;
1240 case Type::TYPE_STRUCT:
1241 case Type::TYPE_ARRAY:
1242 if (!t->compare_is_identity(this->gogo_) && t->is_comparable())
1243 t->type_functions(this->gogo_, NULL, NULL, NULL, &hash_fn, &equal_fn);
1250 return TRAVERSE_CONTINUE;
1253 // Write out type specific functions.
1256 Gogo::write_specific_type_functions()
1258 Specific_type_functions stf(this);
1259 this->traverse(&stf);
1261 while (!this->specific_type_functions_.empty())
1263 Specific_type_function* tsf = this->specific_type_functions_.back();
1264 this->specific_type_functions_.pop_back();
1265 tsf->type->write_specific_type_functions(this, tsf->name,
1272 this->specific_type_functions_are_written_ = true;
1275 // Traverse the tree.
1278 Gogo::traverse(Traverse* traverse)
1280 // Traverse the current package first for consistency. The other
1281 // packages will only contain imported types, constants, and
1283 if (this->package_->bindings()->traverse(traverse, true) == TRAVERSE_EXIT)
1285 for (Packages::const_iterator p = this->packages_.begin();
1286 p != this->packages_.end();
1289 if (p->second != this->package_)
1291 if (p->second->bindings()->traverse(traverse, true) == TRAVERSE_EXIT)
1297 // Add a type to verify. This is used for types of sink variables, in
1298 // order to give appropriate error messages.
1301 Gogo::add_type_to_verify(Type* type)
1303 this->verify_types_.push_back(type);
1306 // Traversal class used to verify types.
1308 class Verify_types : public Traverse
1312 : Traverse(traverse_types)
1319 // Verify that a type is correct.
1322 Verify_types::type(Type* t)
1325 return TRAVERSE_SKIP_COMPONENTS;
1326 return TRAVERSE_CONTINUE;
1329 // Verify that all types are correct.
1332 Gogo::verify_types()
1334 Verify_types traverse;
1335 this->traverse(&traverse);
1337 for (std::vector<Type*>::iterator p = this->verify_types_.begin();
1338 p != this->verify_types_.end();
1341 this->verify_types_.clear();
1344 // Traversal class used to lower parse tree.
1346 class Lower_parse_tree : public Traverse
1349 Lower_parse_tree(Gogo* gogo, Named_object* function)
1350 : Traverse(traverse_variables
1351 | traverse_constants
1352 | traverse_functions
1353 | traverse_statements
1354 | traverse_expressions),
1355 gogo_(gogo), function_(function), iota_value_(-1), inserter_()
1359 set_inserter(const Statement_inserter* inserter)
1360 { this->inserter_ = *inserter; }
1363 variable(Named_object*);
1366 constant(Named_object*, bool);
1369 function(Named_object*);
1372 statement(Block*, size_t* pindex, Statement*);
1375 expression(Expression**);
1380 // The function we are traversing.
1381 Named_object* function_;
1382 // Value to use for the predeclared constant iota.
1384 // Current statement inserter for use by expressions.
1385 Statement_inserter inserter_;
1391 Lower_parse_tree::variable(Named_object* no)
1393 if (!no->is_variable())
1394 return TRAVERSE_CONTINUE;
1396 if (no->is_variable() && no->var_value()->is_global())
1398 // Global variables can have loops in their initialization
1399 // expressions. This is handled in lower_init_expression.
1400 no->var_value()->lower_init_expression(this->gogo_, this->function_,
1402 return TRAVERSE_CONTINUE;
1405 // This is a local variable. We are going to return
1406 // TRAVERSE_SKIP_COMPONENTS here because we want to traverse the
1407 // initialization expression when we reach the variable declaration
1408 // statement. However, that means that we need to traverse the type
1410 if (no->var_value()->has_type())
1412 Type* type = no->var_value()->type();
1415 if (Type::traverse(type, this) == TRAVERSE_EXIT)
1416 return TRAVERSE_EXIT;
1419 go_assert(!no->var_value()->has_pre_init());
1421 return TRAVERSE_SKIP_COMPONENTS;
1424 // Lower constants. We handle constants specially so that we can set
1425 // the right value for the predeclared constant iota. This works in
1426 // conjunction with the way we lower Const_expression objects.
1429 Lower_parse_tree::constant(Named_object* no, bool)
1431 Named_constant* nc = no->const_value();
1433 // Don't get into trouble if the constant's initializer expression
1434 // refers to the constant itself.
1436 return TRAVERSE_CONTINUE;
1439 go_assert(this->iota_value_ == -1);
1440 this->iota_value_ = nc->iota_value();
1441 nc->traverse_expression(this);
1442 this->iota_value_ = -1;
1444 nc->clear_lowering();
1446 // We will traverse the expression a second time, but that will be
1449 return TRAVERSE_CONTINUE;
1452 // Lower function closure types. Record the function while lowering
1453 // it, so that we can pass it down when lowering an expression.
1456 Lower_parse_tree::function(Named_object* no)
1458 no->func_value()->set_closure_type();
1460 go_assert(this->function_ == NULL);
1461 this->function_ = no;
1462 int t = no->func_value()->traverse(this);
1463 this->function_ = NULL;
1465 if (t == TRAVERSE_EXIT)
1467 return TRAVERSE_SKIP_COMPONENTS;
1470 // Lower statement parse trees.
1473 Lower_parse_tree::statement(Block* block, size_t* pindex, Statement* sorig)
1475 // Because we explicitly traverse the statement's contents
1476 // ourselves, we want to skip block statements here. There is
1477 // nothing to lower in a block statement.
1478 if (sorig->is_block_statement())
1479 return TRAVERSE_CONTINUE;
1481 Statement_inserter hold_inserter(this->inserter_);
1482 this->inserter_ = Statement_inserter(block, pindex);
1484 // Lower the expressions first.
1485 int t = sorig->traverse_contents(this);
1486 if (t == TRAVERSE_EXIT)
1488 this->inserter_ = hold_inserter;
1492 // Keep lowering until nothing changes.
1493 Statement* s = sorig;
1496 Statement* snew = s->lower(this->gogo_, this->function_, block,
1501 t = s->traverse_contents(this);
1502 if (t == TRAVERSE_EXIT)
1504 this->inserter_ = hold_inserter;
1510 block->replace_statement(*pindex, s);
1512 this->inserter_ = hold_inserter;
1513 return TRAVERSE_SKIP_COMPONENTS;
1516 // Lower expression parse trees.
1519 Lower_parse_tree::expression(Expression** pexpr)
1521 // We have to lower all subexpressions first, so that we can get
1522 // their type if necessary. This is awkward, because we don't have
1523 // a postorder traversal pass.
1524 if ((*pexpr)->traverse_subexpressions(this) == TRAVERSE_EXIT)
1525 return TRAVERSE_EXIT;
1526 // Keep lowering until nothing changes.
1529 Expression* e = *pexpr;
1530 Expression* enew = e->lower(this->gogo_, this->function_,
1531 &this->inserter_, this->iota_value_);
1534 if (enew->traverse_subexpressions(this) == TRAVERSE_EXIT)
1535 return TRAVERSE_EXIT;
1538 return TRAVERSE_SKIP_COMPONENTS;
1541 // Lower the parse tree. This is called after the parse is complete,
1542 // when all names should be resolved.
1545 Gogo::lower_parse_tree()
1547 Lower_parse_tree lower_parse_tree(this, NULL);
1548 this->traverse(&lower_parse_tree);
1554 Gogo::lower_block(Named_object* function, Block* block)
1556 Lower_parse_tree lower_parse_tree(this, function);
1557 block->traverse(&lower_parse_tree);
1560 // Lower an expression. INSERTER may be NULL, in which case the
1561 // expression had better not need to create any temporaries.
1564 Gogo::lower_expression(Named_object* function, Statement_inserter* inserter,
1567 Lower_parse_tree lower_parse_tree(this, function);
1568 if (inserter != NULL)
1569 lower_parse_tree.set_inserter(inserter);
1570 lower_parse_tree.expression(pexpr);
1573 // Lower a constant. This is called when lowering a reference to a
1574 // constant. We have to make sure that the constant has already been
1578 Gogo::lower_constant(Named_object* no)
1580 go_assert(no->is_const());
1581 Lower_parse_tree lower(this, NULL);
1582 lower.constant(no, false);
1585 // Look for interface types to finalize methods of inherited
1588 class Finalize_methods : public Traverse
1591 Finalize_methods(Gogo* gogo)
1592 : Traverse(traverse_types),
1603 // Finalize the methods of an interface type.
1606 Finalize_methods::type(Type* t)
1608 // Check the classification so that we don't finalize the methods
1609 // twice for a named interface type.
1610 switch (t->classification())
1612 case Type::TYPE_INTERFACE:
1613 t->interface_type()->finalize_methods();
1616 case Type::TYPE_NAMED:
1618 // We have to finalize the methods of the real type first.
1619 // But if the real type is a struct type, then we only want to
1620 // finalize the methods of the field types, not of the struct
1621 // type itself. We don't want to add methods to the struct,
1622 // since it has a name.
1623 Named_type* nt = t->named_type();
1624 Type* rt = nt->real_type();
1625 if (rt->classification() != Type::TYPE_STRUCT)
1627 if (Type::traverse(rt, this) == TRAVERSE_EXIT)
1628 return TRAVERSE_EXIT;
1632 if (rt->struct_type()->traverse_field_types(this) == TRAVERSE_EXIT)
1633 return TRAVERSE_EXIT;
1636 nt->finalize_methods(this->gogo_);
1638 // If this type is defined in a different package, then finalize the
1639 // types of all the methods, since we won't see them otherwise.
1640 if (nt->named_object()->package() != NULL && nt->has_any_methods())
1642 const Methods* methods = nt->methods();
1643 for (Methods::const_iterator p = methods->begin();
1644 p != methods->end();
1647 if (Type::traverse(p->second->type(), this) == TRAVERSE_EXIT)
1648 return TRAVERSE_EXIT;
1652 return TRAVERSE_SKIP_COMPONENTS;
1655 case Type::TYPE_STRUCT:
1656 // Traverse the field types first in case there is an embedded
1657 // field with methods that the struct should inherit.
1658 if (t->struct_type()->traverse_field_types(this) == TRAVERSE_EXIT)
1659 return TRAVERSE_EXIT;
1660 t->struct_type()->finalize_methods(this->gogo_);
1661 return TRAVERSE_SKIP_COMPONENTS;
1667 return TRAVERSE_CONTINUE;
1670 // Finalize method lists and build stub methods for types.
1673 Gogo::finalize_methods()
1675 Finalize_methods finalize(this);
1676 this->traverse(&finalize);
1679 // Set types for unspecified variables and constants.
1682 Gogo::determine_types()
1684 Bindings* bindings = this->current_bindings();
1685 for (Bindings::const_definitions_iterator p = bindings->begin_definitions();
1686 p != bindings->end_definitions();
1689 if ((*p)->is_function())
1690 (*p)->func_value()->determine_types();
1691 else if ((*p)->is_variable())
1692 (*p)->var_value()->determine_type();
1693 else if ((*p)->is_const())
1694 (*p)->const_value()->determine_type();
1696 // See if a variable requires us to build an initialization
1697 // function. We know that we will see all global variables
1699 if (!this->need_init_fn_ && (*p)->is_variable())
1701 Variable* variable = (*p)->var_value();
1703 // If this is a global variable which requires runtime
1704 // initialization, we need an initialization function.
1705 if (!variable->is_global())
1707 else if (variable->init() == NULL)
1709 else if (variable->type()->interface_type() != NULL)
1710 this->need_init_fn_ = true;
1711 else if (variable->init()->is_constant())
1713 else if (!variable->init()->is_composite_literal())
1714 this->need_init_fn_ = true;
1715 else if (variable->init()->is_nonconstant_composite_literal())
1716 this->need_init_fn_ = true;
1718 // If this is a global variable which holds a pointer value,
1719 // then we need an initialization function to register it as a
1721 if (variable->is_global() && variable->type()->has_pointer())
1722 this->need_init_fn_ = true;
1726 // Determine the types of constants in packages.
1727 for (Packages::const_iterator p = this->packages_.begin();
1728 p != this->packages_.end();
1730 p->second->determine_types();
1733 // Traversal class used for type checking.
1735 class Check_types_traverse : public Traverse
1738 Check_types_traverse(Gogo* gogo)
1739 : Traverse(traverse_variables
1740 | traverse_constants
1741 | traverse_functions
1742 | traverse_statements
1743 | traverse_expressions),
1748 variable(Named_object*);
1751 constant(Named_object*, bool);
1754 function(Named_object*);
1757 statement(Block*, size_t* pindex, Statement*);
1760 expression(Expression**);
1767 // Check that a variable initializer has the right type.
1770 Check_types_traverse::variable(Named_object* named_object)
1772 if (named_object->is_variable())
1774 Variable* var = named_object->var_value();
1776 // Give error if variable type is not defined.
1777 var->type()->base();
1779 Expression* init = var->init();
1782 && !Type::are_assignable(var->type(), init->type(), &reason))
1785 error_at(var->location(), "incompatible type in initialization");
1787 error_at(var->location(),
1788 "incompatible type in initialization (%s)",
1792 else if (!var->is_used()
1793 && !var->is_global()
1794 && !var->is_parameter()
1795 && !var->is_receiver()
1796 && !var->type()->is_error()
1797 && (init == NULL || !init->is_error_expression())
1798 && !Lex::is_invalid_identifier(named_object->name()))
1799 error_at(var->location(), "%qs declared and not used",
1800 named_object->message_name().c_str());
1802 return TRAVERSE_CONTINUE;
1805 // Check that a constant initializer has the right type.
1808 Check_types_traverse::constant(Named_object* named_object, bool)
1810 Named_constant* constant = named_object->const_value();
1811 Type* ctype = constant->type();
1812 if (ctype->integer_type() == NULL
1813 && ctype->float_type() == NULL
1814 && ctype->complex_type() == NULL
1815 && !ctype->is_boolean_type()
1816 && !ctype->is_string_type())
1818 if (ctype->is_nil_type())
1819 error_at(constant->location(), "const initializer cannot be nil");
1820 else if (!ctype->is_error())
1821 error_at(constant->location(), "invalid constant type");
1822 constant->set_error();
1824 else if (!constant->expr()->is_constant())
1826 error_at(constant->expr()->location(), "expression is not constant");
1827 constant->set_error();
1829 else if (!Type::are_assignable(constant->type(), constant->expr()->type(),
1832 error_at(constant->location(),
1833 "initialization expression has wrong type");
1834 constant->set_error();
1836 return TRAVERSE_CONTINUE;
1839 // There are no types to check in a function, but this is where we
1840 // issue warnings about labels which are defined but not referenced.
1843 Check_types_traverse::function(Named_object* no)
1845 no->func_value()->check_labels();
1846 return TRAVERSE_CONTINUE;
1849 // Check that types are valid in a statement.
1852 Check_types_traverse::statement(Block*, size_t*, Statement* s)
1854 s->check_types(this->gogo_);
1855 return TRAVERSE_CONTINUE;
1858 // Check that types are valid in an expression.
1861 Check_types_traverse::expression(Expression** expr)
1863 (*expr)->check_types(this->gogo_);
1864 return TRAVERSE_CONTINUE;
1867 // Check that types are valid.
1872 Check_types_traverse traverse(this);
1873 this->traverse(&traverse);
1876 // Check the types in a single block.
1879 Gogo::check_types_in_block(Block* block)
1881 Check_types_traverse traverse(this);
1882 block->traverse(&traverse);
1885 // A traversal class used to find a single shortcut operator within an
1888 class Find_shortcut : public Traverse
1892 : Traverse(traverse_blocks
1893 | traverse_statements
1894 | traverse_expressions),
1898 // A pointer to the expression which was found, or NULL if none was
1902 { return this->found_; }
1907 { return TRAVERSE_SKIP_COMPONENTS; }
1910 statement(Block*, size_t*, Statement*)
1911 { return TRAVERSE_SKIP_COMPONENTS; }
1914 expression(Expression**);
1917 Expression** found_;
1920 // Find a shortcut expression.
1923 Find_shortcut::expression(Expression** pexpr)
1925 Expression* expr = *pexpr;
1926 Binary_expression* be = expr->binary_expression();
1928 return TRAVERSE_CONTINUE;
1929 Operator op = be->op();
1930 if (op != OPERATOR_OROR && op != OPERATOR_ANDAND)
1931 return TRAVERSE_CONTINUE;
1932 go_assert(this->found_ == NULL);
1933 this->found_ = pexpr;
1934 return TRAVERSE_EXIT;
1937 // A traversal class used to turn shortcut operators into explicit if
1940 class Shortcuts : public Traverse
1943 Shortcuts(Gogo* gogo)
1944 : Traverse(traverse_variables
1945 | traverse_statements),
1951 variable(Named_object*);
1954 statement(Block*, size_t*, Statement*);
1957 // Convert a shortcut operator.
1959 convert_shortcut(Block* enclosing, Expression** pshortcut);
1965 // Remove shortcut operators in a single statement.
1968 Shortcuts::statement(Block* block, size_t* pindex, Statement* s)
1970 // FIXME: This approach doesn't work for switch statements, because
1971 // we add the new statements before the whole switch when we need to
1972 // instead add them just before the switch expression. The right
1973 // fix is probably to lower switch statements with nonconstant cases
1974 // to a series of conditionals.
1975 if (s->switch_statement() != NULL)
1976 return TRAVERSE_CONTINUE;
1980 Find_shortcut find_shortcut;
1982 // If S is a variable declaration, then ordinary traversal won't
1983 // do anything. We want to explicitly traverse the
1984 // initialization expression if there is one.
1985 Variable_declaration_statement* vds = s->variable_declaration_statement();
1986 Expression* init = NULL;
1988 s->traverse_contents(&find_shortcut);
1991 init = vds->var()->var_value()->init();
1993 return TRAVERSE_CONTINUE;
1994 init->traverse(&init, &find_shortcut);
1996 Expression** pshortcut = find_shortcut.found();
1997 if (pshortcut == NULL)
1998 return TRAVERSE_CONTINUE;
2000 Statement* snew = this->convert_shortcut(block, pshortcut);
2001 block->insert_statement_before(*pindex, snew);
2004 if (pshortcut == &init)
2005 vds->var()->var_value()->set_init(init);
2009 // Remove shortcut operators in the initializer of a global variable.
2012 Shortcuts::variable(Named_object* no)
2014 if (no->is_result_variable())
2015 return TRAVERSE_CONTINUE;
2016 Variable* var = no->var_value();
2017 Expression* init = var->init();
2018 if (!var->is_global() || init == NULL)
2019 return TRAVERSE_CONTINUE;
2023 Find_shortcut find_shortcut;
2024 init->traverse(&init, &find_shortcut);
2025 Expression** pshortcut = find_shortcut.found();
2026 if (pshortcut == NULL)
2027 return TRAVERSE_CONTINUE;
2029 Statement* snew = this->convert_shortcut(NULL, pshortcut);
2030 var->add_preinit_statement(this->gogo_, snew);
2031 if (pshortcut == &init)
2032 var->set_init(init);
2036 // Given an expression which uses a shortcut operator, return a
2037 // statement which implements it, and update *PSHORTCUT accordingly.
2040 Shortcuts::convert_shortcut(Block* enclosing, Expression** pshortcut)
2042 Binary_expression* shortcut = (*pshortcut)->binary_expression();
2043 Expression* left = shortcut->left();
2044 Expression* right = shortcut->right();
2045 Location loc = shortcut->location();
2047 Block* retblock = new Block(enclosing, loc);
2048 retblock->set_end_location(loc);
2050 Temporary_statement* ts = Statement::make_temporary(Type::lookup_bool_type(),
2052 retblock->add_statement(ts);
2054 Block* block = new Block(retblock, loc);
2055 block->set_end_location(loc);
2056 Expression* tmpref = Expression::make_temporary_reference(ts, loc);
2057 Statement* assign = Statement::make_assignment(tmpref, right, loc);
2058 block->add_statement(assign);
2060 Expression* cond = Expression::make_temporary_reference(ts, loc);
2061 if (shortcut->binary_expression()->op() == OPERATOR_OROR)
2062 cond = Expression::make_unary(OPERATOR_NOT, cond, loc);
2064 Statement* if_statement = Statement::make_if_statement(cond, block, NULL,
2066 retblock->add_statement(if_statement);
2068 *pshortcut = Expression::make_temporary_reference(ts, loc);
2072 // Now convert any shortcut operators in LEFT and RIGHT.
2073 Shortcuts shortcuts(this->gogo_);
2074 retblock->traverse(&shortcuts);
2076 return Statement::make_block_statement(retblock, loc);
2079 // Turn shortcut operators into explicit if statements. Doing this
2080 // considerably simplifies the order of evaluation rules.
2083 Gogo::remove_shortcuts()
2085 Shortcuts shortcuts(this);
2086 this->traverse(&shortcuts);
2089 // A traversal class which finds all the expressions which must be
2090 // evaluated in order within a statement or larger expression. This
2091 // is used to implement the rules about order of evaluation.
2093 class Find_eval_ordering : public Traverse
2096 typedef std::vector<Expression**> Expression_pointers;
2099 Find_eval_ordering()
2100 : Traverse(traverse_blocks
2101 | traverse_statements
2102 | traverse_expressions),
2108 { return this->exprs_.size(); }
2110 typedef Expression_pointers::const_iterator const_iterator;
2114 { return this->exprs_.begin(); }
2118 { return this->exprs_.end(); }
2123 { return TRAVERSE_SKIP_COMPONENTS; }
2126 statement(Block*, size_t*, Statement*)
2127 { return TRAVERSE_SKIP_COMPONENTS; }
2130 expression(Expression**);
2133 // A list of pointers to expressions with side-effects.
2134 Expression_pointers exprs_;
2137 // If an expression must be evaluated in order, put it on the list.
2140 Find_eval_ordering::expression(Expression** expression_pointer)
2142 // We have to look at subexpressions before this one.
2143 if ((*expression_pointer)->traverse_subexpressions(this) == TRAVERSE_EXIT)
2144 return TRAVERSE_EXIT;
2145 if ((*expression_pointer)->must_eval_in_order())
2146 this->exprs_.push_back(expression_pointer);
2147 return TRAVERSE_SKIP_COMPONENTS;
2150 // A traversal class for ordering evaluations.
2152 class Order_eval : public Traverse
2155 Order_eval(Gogo* gogo)
2156 : Traverse(traverse_variables
2157 | traverse_statements),
2162 variable(Named_object*);
2165 statement(Block*, size_t*, Statement*);
2172 // Implement the order of evaluation rules for a statement.
2175 Order_eval::statement(Block* block, size_t* pindex, Statement* s)
2177 // FIXME: This approach doesn't work for switch statements, because
2178 // we add the new statements before the whole switch when we need to
2179 // instead add them just before the switch expression. The right
2180 // fix is probably to lower switch statements with nonconstant cases
2181 // to a series of conditionals.
2182 if (s->switch_statement() != NULL)
2183 return TRAVERSE_CONTINUE;
2185 Find_eval_ordering find_eval_ordering;
2187 // If S is a variable declaration, then ordinary traversal won't do
2188 // anything. We want to explicitly traverse the initialization
2189 // expression if there is one.
2190 Variable_declaration_statement* vds = s->variable_declaration_statement();
2191 Expression* init = NULL;
2192 Expression* orig_init = NULL;
2194 s->traverse_contents(&find_eval_ordering);
2197 init = vds->var()->var_value()->init();
2199 return TRAVERSE_CONTINUE;
2202 // It might seem that this could be
2203 // init->traverse_subexpressions. Unfortunately that can fail
2206 // newvar, err := call(arg())
2207 // Here newvar will have an init of call result 0 of
2208 // call(arg()). If we only traverse subexpressions, we will
2209 // only find arg(), and we won't bother to move anything out.
2210 // Then we get to the assignment to err, we will traverse the
2211 // whole statement, and this time we will find both call() and
2212 // arg(), and so we will move them out. This will cause them to
2213 // be put into temporary variables before the assignment to err
2214 // but after the declaration of newvar. To avoid that problem,
2215 // we traverse the entire expression here.
2216 Expression::traverse(&init, &find_eval_ordering);
2219 if (find_eval_ordering.size() <= 1)
2221 // If there is only one expression with a side-effect, we can
2222 // leave it in place.
2223 return TRAVERSE_CONTINUE;
2226 bool is_thunk = s->thunk_statement() != NULL;
2227 for (Find_eval_ordering::const_iterator p = find_eval_ordering.begin();
2228 p != find_eval_ordering.end();
2231 Expression** pexpr = *p;
2233 // The last expression in a thunk will be the call passed to go
2234 // or defer, which we must not evaluate early.
2235 if (is_thunk && p + 1 == find_eval_ordering.end())
2238 Location loc = (*pexpr)->location();
2240 if ((*pexpr)->call_expression() == NULL
2241 || (*pexpr)->call_expression()->result_count() < 2)
2243 Temporary_statement* ts = Statement::make_temporary(NULL, *pexpr,
2246 *pexpr = Expression::make_temporary_reference(ts, loc);
2250 // A call expression which returns multiple results needs to
2251 // be handled specially. We can't create a temporary
2252 // because there is no type to give it. Any actual uses of
2253 // the values will be done via Call_result_expressions.
2254 s = Statement::make_statement(*pexpr, true);
2257 block->insert_statement_before(*pindex, s);
2261 if (init != orig_init)
2262 vds->var()->var_value()->set_init(init);
2264 return TRAVERSE_CONTINUE;
2267 // Implement the order of evaluation rules for the initializer of a
2271 Order_eval::variable(Named_object* no)
2273 if (no->is_result_variable())
2274 return TRAVERSE_CONTINUE;
2275 Variable* var = no->var_value();
2276 Expression* init = var->init();
2277 if (!var->is_global() || init == NULL)
2278 return TRAVERSE_CONTINUE;
2280 Find_eval_ordering find_eval_ordering;
2281 Expression::traverse(&init, &find_eval_ordering);
2283 if (find_eval_ordering.size() <= 1)
2285 // If there is only one expression with a side-effect, we can
2286 // leave it in place.
2287 return TRAVERSE_SKIP_COMPONENTS;
2290 Expression* orig_init = init;
2292 for (Find_eval_ordering::const_iterator p = find_eval_ordering.begin();
2293 p != find_eval_ordering.end();
2296 Expression** pexpr = *p;
2297 Location loc = (*pexpr)->location();
2299 if ((*pexpr)->call_expression() == NULL
2300 || (*pexpr)->call_expression()->result_count() < 2)
2302 Temporary_statement* ts = Statement::make_temporary(NULL, *pexpr,
2305 *pexpr = Expression::make_temporary_reference(ts, loc);
2309 // A call expression which returns multiple results needs to
2310 // be handled specially.
2311 s = Statement::make_statement(*pexpr, true);
2313 var->add_preinit_statement(this->gogo_, s);
2316 if (init != orig_init)
2317 var->set_init(init);
2319 return TRAVERSE_SKIP_COMPONENTS;
2322 // Use temporary variables to implement the order of evaluation rules.
2325 Gogo::order_evaluations()
2327 Order_eval order_eval(this);
2328 this->traverse(&order_eval);
2331 // Traversal to convert calls to the predeclared recover function to
2332 // pass in an argument indicating whether it can recover from a panic
2335 class Convert_recover : public Traverse
2338 Convert_recover(Named_object* arg)
2339 : Traverse(traverse_expressions),
2345 expression(Expression**);
2348 // The argument to pass to the function.
2352 // Convert calls to recover.
2355 Convert_recover::expression(Expression** pp)
2357 Call_expression* ce = (*pp)->call_expression();
2358 if (ce != NULL && ce->is_recover_call())
2359 ce->set_recover_arg(Expression::make_var_reference(this->arg_,
2361 return TRAVERSE_CONTINUE;
2364 // Traversal for build_recover_thunks.
2366 class Build_recover_thunks : public Traverse
2369 Build_recover_thunks(Gogo* gogo)
2370 : Traverse(traverse_functions),
2375 function(Named_object*);
2379 can_recover_arg(Location);
2385 // If this function calls recover, turn it into a thunk.
2388 Build_recover_thunks::function(Named_object* orig_no)
2390 Function* orig_func = orig_no->func_value();
2391 if (!orig_func->calls_recover()
2392 || orig_func->is_recover_thunk()
2393 || orig_func->has_recover_thunk())
2394 return TRAVERSE_CONTINUE;
2396 Gogo* gogo = this->gogo_;
2397 Location location = orig_func->location();
2402 Function_type* orig_fntype = orig_func->type();
2403 Typed_identifier_list* new_params = new Typed_identifier_list();
2404 std::string receiver_name;
2405 if (orig_fntype->is_method())
2407 const Typed_identifier* receiver = orig_fntype->receiver();
2408 snprintf(buf, sizeof buf, "rt.%u", count);
2410 receiver_name = buf;
2411 new_params->push_back(Typed_identifier(receiver_name, receiver->type(),
2412 receiver->location()));
2414 const Typed_identifier_list* orig_params = orig_fntype->parameters();
2415 if (orig_params != NULL && !orig_params->empty())
2417 for (Typed_identifier_list::const_iterator p = orig_params->begin();
2418 p != orig_params->end();
2421 snprintf(buf, sizeof buf, "pt.%u", count);
2423 new_params->push_back(Typed_identifier(buf, p->type(),
2427 snprintf(buf, sizeof buf, "pr.%u", count);
2429 std::string can_recover_name = buf;
2430 new_params->push_back(Typed_identifier(can_recover_name,
2431 Type::lookup_bool_type(),
2432 orig_fntype->location()));
2434 const Typed_identifier_list* orig_results = orig_fntype->results();
2435 Typed_identifier_list* new_results;
2436 if (orig_results == NULL || orig_results->empty())
2440 new_results = new Typed_identifier_list();
2441 for (Typed_identifier_list::const_iterator p = orig_results->begin();
2442 p != orig_results->end();
2444 new_results->push_back(Typed_identifier("", p->type(), p->location()));
2447 Function_type *new_fntype = Type::make_function_type(NULL, new_params,
2449 orig_fntype->location());
2450 if (orig_fntype->is_varargs())
2451 new_fntype->set_is_varargs();
2453 std::string name = orig_no->name() + "$recover";
2454 Named_object *new_no = gogo->start_function(name, new_fntype, false,
2456 Function *new_func = new_no->func_value();
2457 if (orig_func->enclosing() != NULL)
2458 new_func->set_enclosing(orig_func->enclosing());
2460 // We build the code for the original function attached to the new
2461 // function, and then swap the original and new function bodies.
2462 // This means that existing references to the original function will
2463 // then refer to the new function. That makes this code a little
2464 // confusing, in that the reference to NEW_NO really refers to the
2465 // other function, not the one we are building.
2467 Expression* closure = NULL;
2468 if (orig_func->needs_closure())
2470 Named_object* orig_closure_no = orig_func->closure_var();
2471 Variable* orig_closure_var = orig_closure_no->var_value();
2472 Variable* new_var = new Variable(orig_closure_var->type(), NULL, false,
2473 true, false, location);
2474 snprintf(buf, sizeof buf, "closure.%u", count);
2476 Named_object* new_closure_no = Named_object::make_variable(buf, NULL,
2478 new_func->set_closure_var(new_closure_no);
2479 closure = Expression::make_var_reference(new_closure_no, location);
2482 Expression* fn = Expression::make_func_reference(new_no, closure, location);
2484 Expression_list* args = new Expression_list();
2485 if (new_params != NULL)
2487 // Note that we skip the last parameter, which is the boolean
2488 // indicating whether recover can succed.
2489 for (Typed_identifier_list::const_iterator p = new_params->begin();
2490 p + 1 != new_params->end();
2493 Named_object* p_no = gogo->lookup(p->name(), NULL);
2494 go_assert(p_no != NULL
2495 && p_no->is_variable()
2496 && p_no->var_value()->is_parameter());
2497 args->push_back(Expression::make_var_reference(p_no, location));
2500 args->push_back(this->can_recover_arg(location));
2502 gogo->start_block(location);
2504 Call_expression* call = Expression::make_call(fn, args, false, location);
2506 // Any varargs call has already been lowered.
2507 call->set_varargs_are_lowered();
2510 if (orig_fntype->results() == NULL || orig_fntype->results()->empty())
2511 s = Statement::make_statement(call, true);
2514 Expression_list* vals = new Expression_list();
2515 size_t rc = orig_fntype->results()->size();
2517 vals->push_back(call);
2520 for (size_t i = 0; i < rc; ++i)
2521 vals->push_back(Expression::make_call_result(call, i));
2523 s = Statement::make_return_statement(vals, location);
2525 s->determine_types();
2526 gogo->add_statement(s);
2528 Block* b = gogo->finish_block(location);
2530 gogo->add_block(b, location);
2532 // Lower the call in case it returns multiple results.
2533 gogo->lower_block(new_no, b);
2535 gogo->finish_function(location);
2537 // Swap the function bodies and types.
2538 new_func->swap_for_recover(orig_func);
2539 orig_func->set_is_recover_thunk();
2540 new_func->set_calls_recover();
2541 new_func->set_has_recover_thunk();
2543 Bindings* orig_bindings = orig_func->block()->bindings();
2544 Bindings* new_bindings = new_func->block()->bindings();
2545 if (orig_fntype->is_method())
2547 // We changed the receiver to be a regular parameter. We have
2548 // to update the binding accordingly in both functions.
2549 Named_object* orig_rec_no = orig_bindings->lookup_local(receiver_name);
2550 go_assert(orig_rec_no != NULL
2551 && orig_rec_no->is_variable()
2552 && !orig_rec_no->var_value()->is_receiver());
2553 orig_rec_no->var_value()->set_is_receiver();
2555 const std::string& new_receiver_name(orig_fntype->receiver()->name());
2556 Named_object* new_rec_no = new_bindings->lookup_local(new_receiver_name);
2557 if (new_rec_no == NULL)
2558 go_assert(saw_errors());
2561 go_assert(new_rec_no->is_variable()
2562 && new_rec_no->var_value()->is_receiver());
2563 new_rec_no->var_value()->set_is_not_receiver();
2567 // Because we flipped blocks but not types, the can_recover
2568 // parameter appears in the (now) old bindings as a parameter.
2569 // Change it to a local variable, whereupon it will be discarded.
2570 Named_object* can_recover_no = orig_bindings->lookup_local(can_recover_name);
2571 go_assert(can_recover_no != NULL
2572 && can_recover_no->is_variable()
2573 && can_recover_no->var_value()->is_parameter());
2574 orig_bindings->remove_binding(can_recover_no);
2576 // Add the can_recover argument to the (now) new bindings, and
2577 // attach it to any recover statements.
2578 Variable* can_recover_var = new Variable(Type::lookup_bool_type(), NULL,
2579 false, true, false, location);
2580 can_recover_no = new_bindings->add_variable(can_recover_name, NULL,
2582 Convert_recover convert_recover(can_recover_no);
2583 new_func->traverse(&convert_recover);
2585 // Update the function pointers in any named results.
2586 new_func->update_result_variables();
2587 orig_func->update_result_variables();
2589 return TRAVERSE_CONTINUE;
2592 // Return the expression to pass for the .can_recover parameter to the
2593 // new function. This indicates whether a call to recover may return
2594 // non-nil. The expression is
2595 // __go_can_recover(__builtin_return_address()).
2598 Build_recover_thunks::can_recover_arg(Location location)
2600 static Named_object* builtin_return_address;
2601 if (builtin_return_address == NULL)
2603 const Location bloc = Linemap::predeclared_location();
2605 Typed_identifier_list* param_types = new Typed_identifier_list();
2606 Type* uint_type = Type::lookup_integer_type("uint");
2607 param_types->push_back(Typed_identifier("l", uint_type, bloc));
2609 Typed_identifier_list* return_types = new Typed_identifier_list();
2610 Type* voidptr_type = Type::make_pointer_type(Type::make_void_type());
2611 return_types->push_back(Typed_identifier("", voidptr_type, bloc));
2613 Function_type* fntype = Type::make_function_type(NULL, param_types,
2614 return_types, bloc);
2615 builtin_return_address =
2616 Named_object::make_function_declaration("__builtin_return_address",
2617 NULL, fntype, bloc);
2618 const char* n = "__builtin_return_address";
2619 builtin_return_address->func_declaration_value()->set_asm_name(n);
2622 static Named_object* can_recover;
2623 if (can_recover == NULL)
2625 const Location bloc = Linemap::predeclared_location();
2626 Typed_identifier_list* param_types = new Typed_identifier_list();
2627 Type* voidptr_type = Type::make_pointer_type(Type::make_void_type());
2628 param_types->push_back(Typed_identifier("a", voidptr_type, bloc));
2629 Type* boolean_type = Type::lookup_bool_type();
2630 Typed_identifier_list* results = new Typed_identifier_list();
2631 results->push_back(Typed_identifier("", boolean_type, bloc));
2632 Function_type* fntype = Type::make_function_type(NULL, param_types,
2634 can_recover = Named_object::make_function_declaration("__go_can_recover",
2637 can_recover->func_declaration_value()->set_asm_name("__go_can_recover");
2640 Expression* fn = Expression::make_func_reference(builtin_return_address,
2644 mpz_init_set_ui(zval, 0UL);
2645 Expression* zexpr = Expression::make_integer(&zval, NULL, location);
2647 Expression_list *args = new Expression_list();
2648 args->push_back(zexpr);
2650 Expression* call = Expression::make_call(fn, args, false, location);
2652 args = new Expression_list();
2653 args->push_back(call);
2655 fn = Expression::make_func_reference(can_recover, NULL, location);
2656 return Expression::make_call(fn, args, false, location);
2659 // Build thunks for functions which call recover. We build a new
2660 // function with an extra parameter, which is whether a call to
2661 // recover can succeed. We then move the body of this function to
2662 // that one. We then turn this function into a thunk which calls the
2663 // new one, passing the value of
2664 // __go_can_recover(__builtin_return_address()). The function will be
2665 // marked as not splitting the stack. This will cooperate with the
2666 // implementation of defer to make recover do the right thing.
2669 Gogo::build_recover_thunks()
2671 Build_recover_thunks build_recover_thunks(this);
2672 this->traverse(&build_recover_thunks);
2675 // Look for named types to see whether we need to create an interface
2678 class Build_method_tables : public Traverse
2681 Build_method_tables(Gogo* gogo,
2682 const std::vector<Interface_type*>& interfaces)
2683 : Traverse(traverse_types),
2684 gogo_(gogo), interfaces_(interfaces)
2693 // A list of locally defined interfaces which have hidden methods.
2694 const std::vector<Interface_type*>& interfaces_;
2697 // Build all required interface method tables for types. We need to
2698 // ensure that we have an interface method table for every interface
2699 // which has a hidden method, for every named type which implements
2700 // that interface. Normally we can just build interface method tables
2701 // as we need them. However, in some cases we can require an
2702 // interface method table for an interface defined in a different
2703 // package for a type defined in that package. If that interface and
2704 // type both use a hidden method, that is OK. However, we will not be
2705 // able to build that interface method table when we need it, because
2706 // the type's hidden method will be static. So we have to build it
2707 // here, and just refer it from other packages as needed.
2710 Gogo::build_interface_method_tables()
2715 std::vector<Interface_type*> hidden_interfaces;
2716 hidden_interfaces.reserve(this->interface_types_.size());
2717 for (std::vector<Interface_type*>::const_iterator pi =
2718 this->interface_types_.begin();
2719 pi != this->interface_types_.end();
2722 const Typed_identifier_list* methods = (*pi)->methods();
2723 if (methods == NULL)
2725 for (Typed_identifier_list::const_iterator pm = methods->begin();
2726 pm != methods->end();
2729 if (Gogo::is_hidden_name(pm->name()))
2731 hidden_interfaces.push_back(*pi);
2737 if (!hidden_interfaces.empty())
2739 // Now traverse the tree looking for all named types.
2740 Build_method_tables bmt(this, hidden_interfaces);
2741 this->traverse(&bmt);
2744 // We no longer need the list of interfaces.
2746 this->interface_types_.clear();
2749 // This is called for each type. For a named type, for each of the
2750 // interfaces with hidden methods that it implements, create the
2754 Build_method_tables::type(Type* type)
2756 Named_type* nt = type->named_type();
2759 for (std::vector<Interface_type*>::const_iterator p =
2760 this->interfaces_.begin();
2761 p != this->interfaces_.end();
2764 // We ask whether a pointer to the named type implements the
2765 // interface, because a pointer can implement more methods
2767 if ((*p)->implements_interface(Type::make_pointer_type(nt), NULL))
2769 nt->interface_method_table(this->gogo_, *p, false);
2770 nt->interface_method_table(this->gogo_, *p, true);
2774 return TRAVERSE_CONTINUE;
2777 // Traversal class used to check for return statements.
2779 class Check_return_statements_traverse : public Traverse
2782 Check_return_statements_traverse()
2783 : Traverse(traverse_functions)
2787 function(Named_object*);
2790 // Check that a function has a return statement if it needs one.
2793 Check_return_statements_traverse::function(Named_object* no)
2795 Function* func = no->func_value();
2796 const Function_type* fntype = func->type();
2797 const Typed_identifier_list* results = fntype->results();
2799 // We only need a return statement if there is a return value.
2800 if (results == NULL || results->empty())
2801 return TRAVERSE_CONTINUE;
2803 if (func->block()->may_fall_through())
2804 error_at(func->location(), "control reaches end of non-void function");
2806 return TRAVERSE_CONTINUE;
2809 // Check return statements.
2812 Gogo::check_return_statements()
2814 Check_return_statements_traverse traverse;
2815 this->traverse(&traverse);
2818 // Get the unique prefix to use before all exported symbols. This
2819 // must be unique across the entire link.
2822 Gogo::unique_prefix() const
2824 go_assert(!this->unique_prefix_.empty());
2825 return this->unique_prefix_;
2828 // Set the unique prefix to use before all exported symbols. This
2829 // comes from the command line option -fgo-prefix=XXX.
2832 Gogo::set_unique_prefix(const std::string& arg)
2834 go_assert(this->unique_prefix_.empty());
2835 this->unique_prefix_ = arg;
2836 this->unique_prefix_specified_ = true;
2839 // Work out the package priority. It is one more than the maximum
2840 // priority of an imported package.
2843 Gogo::package_priority() const
2846 for (Packages::const_iterator p = this->packages_.begin();
2847 p != this->packages_.end();
2849 if (p->second->priority() > priority)
2850 priority = p->second->priority();
2851 return priority + 1;
2854 // Export identifiers as requested.
2859 // For now we always stream to a section. Later we may want to
2860 // support streaming to a separate file.
2861 Stream_to_section stream;
2863 Export exp(&stream);
2864 exp.register_builtin_types(this);
2865 exp.export_globals(this->package_name(),
2866 this->unique_prefix(),
2867 this->package_priority(),
2869 (this->need_init_fn_ && !this->is_main_package()
2870 ? this->get_init_fn_name()
2872 this->imported_init_fns_,
2873 this->package_->bindings());
2876 // Find the blocks in order to convert named types defined in blocks.
2878 class Convert_named_types : public Traverse
2881 Convert_named_types(Gogo* gogo)
2882 : Traverse(traverse_blocks),
2888 block(Block* block);
2895 Convert_named_types::block(Block* block)
2897 this->gogo_->convert_named_types_in_bindings(block->bindings());
2898 return TRAVERSE_CONTINUE;
2901 // Convert all named types to the backend representation. Since named
2902 // types can refer to other types, this needs to be done in the right
2903 // sequence, which is handled by Named_type::convert. Here we arrange
2904 // to call that for each named type.
2907 Gogo::convert_named_types()
2909 this->convert_named_types_in_bindings(this->globals_);
2910 for (Packages::iterator p = this->packages_.begin();
2911 p != this->packages_.end();
2914 Package* package = p->second;
2915 this->convert_named_types_in_bindings(package->bindings());
2918 Convert_named_types cnt(this);
2919 this->traverse(&cnt);
2921 // Make all the builtin named types used for type descriptors, and
2922 // then convert them. They will only be written out if they are
2924 Type::make_type_descriptor_type();
2925 Type::make_type_descriptor_ptr_type();
2926 Function_type::make_function_type_descriptor_type();
2927 Pointer_type::make_pointer_type_descriptor_type();
2928 Struct_type::make_struct_type_descriptor_type();
2929 Array_type::make_array_type_descriptor_type();
2930 Array_type::make_slice_type_descriptor_type();
2931 Map_type::make_map_type_descriptor_type();
2932 Map_type::make_map_descriptor_type();
2933 Channel_type::make_chan_type_descriptor_type();
2934 Interface_type::make_interface_type_descriptor_type();
2935 Type::convert_builtin_named_types(this);
2937 Runtime::convert_types(this);
2939 this->named_types_are_converted_ = true;
2942 // Convert all names types in a set of bindings.
2945 Gogo::convert_named_types_in_bindings(Bindings* bindings)
2947 for (Bindings::const_definitions_iterator p = bindings->begin_definitions();
2948 p != bindings->end_definitions();
2951 if ((*p)->is_type())
2952 (*p)->type_value()->convert(this);
2958 Function::Function(Function_type* type, Function* enclosing, Block* block,
2960 : type_(type), enclosing_(enclosing), results_(NULL),
2961 closure_var_(NULL), block_(block), location_(location), fndecl_(NULL),
2962 defer_stack_(NULL), results_are_named_(false), calls_recover_(false),
2963 is_recover_thunk_(false), has_recover_thunk_(false)
2967 // Create the named result variables.
2970 Function::create_result_variables(Gogo* gogo)
2972 const Typed_identifier_list* results = this->type_->results();
2973 if (results == NULL || results->empty())
2976 if (!results->front().name().empty())
2977 this->results_are_named_ = true;
2979 this->results_ = new Results();
2980 this->results_->reserve(results->size());
2982 Block* block = this->block_;
2984 for (Typed_identifier_list::const_iterator p = results->begin();
2985 p != results->end();
2988 std::string name = p->name();
2989 if (name.empty() || Gogo::is_sink_name(name))
2991 static int result_counter;
2993 snprintf(buf, sizeof buf, "$ret%d", result_counter);
2995 name = gogo->pack_hidden_name(buf, false);
2997 Result_variable* result = new Result_variable(p->type(), this, index,
2999 Named_object* no = block->bindings()->add_result_variable(name, result);
3000 if (no->is_result_variable())
3001 this->results_->push_back(no);
3004 static int dummy_result_count;
3006 snprintf(buf, sizeof buf, "$dret%d", dummy_result_count);
3007 ++dummy_result_count;
3008 name = gogo->pack_hidden_name(buf, false);
3009 no = block->bindings()->add_result_variable(name, result);
3010 go_assert(no->is_result_variable());
3011 this->results_->push_back(no);
3016 // Update the named result variables when cloning a function which
3020 Function::update_result_variables()
3022 if (this->results_ == NULL)
3025 for (Results::iterator p = this->results_->begin();
3026 p != this->results_->end();
3028 (*p)->result_var_value()->set_function(this);
3031 // Return the closure variable, creating it if necessary.
3034 Function::closure_var()
3036 if (this->closure_var_ == NULL)
3038 // We don't know the type of the variable yet. We add fields as
3040 Location loc = this->type_->location();
3041 Struct_field_list* sfl = new Struct_field_list;
3042 Type* struct_type = Type::make_struct_type(sfl, loc);
3043 Variable* var = new Variable(Type::make_pointer_type(struct_type),
3044 NULL, false, true, false, loc);
3046 this->closure_var_ = Named_object::make_variable("closure", NULL, var);
3047 // Note that the new variable is not in any binding contour.
3049 return this->closure_var_;
3052 // Set the type of the closure variable.
3055 Function::set_closure_type()
3057 if (this->closure_var_ == NULL)
3059 Named_object* closure = this->closure_var_;
3060 Struct_type* st = closure->var_value()->type()->deref()->struct_type();
3061 unsigned int index = 0;
3062 for (Closure_fields::const_iterator p = this->closure_fields_.begin();
3063 p != this->closure_fields_.end();
3066 Named_object* no = p->first;
3068 snprintf(buf, sizeof buf, "%u", index);
3069 std::string n = no->name() + buf;
3071 if (no->is_variable())
3072 var_type = no->var_value()->type();
3074 var_type = no->result_var_value()->type();
3075 Type* field_type = Type::make_pointer_type(var_type);
3076 st->push_field(Struct_field(Typed_identifier(n, field_type, p->second)));
3080 // Return whether this function is a method.
3083 Function::is_method() const
3085 return this->type_->is_method();
3088 // Add a label definition.
3091 Function::add_label_definition(Gogo* gogo, const std::string& label_name,
3094 Label* lnull = NULL;
3095 std::pair<Labels::iterator, bool> ins =
3096 this->labels_.insert(std::make_pair(label_name, lnull));
3100 // This is a new label.
3101 label = new Label(label_name);
3102 ins.first->second = label;
3106 // The label was already in the hash table.
3107 label = ins.first->second;
3108 if (label->is_defined())
3110 error_at(location, "label %qs already defined",
3111 Gogo::message_name(label_name).c_str());
3112 inform(label->location(), "previous definition of %qs was here",
3113 Gogo::message_name(label_name).c_str());
3114 return new Label(label_name);
3118 label->define(location, gogo->bindings_snapshot(location));
3120 // Issue any errors appropriate for any previous goto's to this
3122 const std::vector<Bindings_snapshot*>& refs(label->refs());
3123 for (std::vector<Bindings_snapshot*>::const_iterator p = refs.begin();
3126 (*p)->check_goto_to(gogo->current_block());
3127 label->clear_refs();
3132 // Add a reference to a label.
3135 Function::add_label_reference(Gogo* gogo, const std::string& label_name,
3136 Location location, bool issue_goto_errors)
3138 Label* lnull = NULL;
3139 std::pair<Labels::iterator, bool> ins =
3140 this->labels_.insert(std::make_pair(label_name, lnull));
3144 // The label was already in the hash table.
3145 label = ins.first->second;
3149 go_assert(ins.first->second == NULL);
3150 label = new Label(label_name);
3151 ins.first->second = label;
3154 label->set_is_used();
3156 if (issue_goto_errors)
3158 Bindings_snapshot* snapshot = label->snapshot();
3159 if (snapshot != NULL)
3160 snapshot->check_goto_from(gogo->current_block(), location);
3162 label->add_snapshot_ref(gogo->bindings_snapshot(location));
3168 // Warn about labels that are defined but not used.
3171 Function::check_labels() const
3173 for (Labels::const_iterator p = this->labels_.begin();
3174 p != this->labels_.end();
3177 Label* label = p->second;
3178 if (!label->is_used())
3179 error_at(label->location(), "label %qs defined and not used",
3180 Gogo::message_name(label->name()).c_str());
3184 // Swap one function with another. This is used when building the
3185 // thunk we use to call a function which calls recover. It may not
3186 // work for any other case.
3189 Function::swap_for_recover(Function *x)
3191 go_assert(this->enclosing_ == x->enclosing_);
3192 std::swap(this->results_, x->results_);
3193 std::swap(this->closure_var_, x->closure_var_);
3194 std::swap(this->block_, x->block_);
3195 go_assert(this->location_ == x->location_);
3196 go_assert(this->fndecl_ == NULL && x->fndecl_ == NULL);
3197 go_assert(this->defer_stack_ == NULL && x->defer_stack_ == NULL);
3200 // Traverse the tree.
3203 Function::traverse(Traverse* traverse)
3205 unsigned int traverse_mask = traverse->traverse_mask();
3208 & (Traverse::traverse_types | Traverse::traverse_expressions))
3211 if (Type::traverse(this->type_, traverse) == TRAVERSE_EXIT)
3212 return TRAVERSE_EXIT;
3215 // FIXME: We should check traverse_functions here if nested
3216 // functions are stored in block bindings.
3217 if (this->block_ != NULL
3219 & (Traverse::traverse_variables
3220 | Traverse::traverse_constants
3221 | Traverse::traverse_blocks
3222 | Traverse::traverse_statements
3223 | Traverse::traverse_expressions
3224 | Traverse::traverse_types)) != 0)
3226 if (this->block_->traverse(traverse) == TRAVERSE_EXIT)
3227 return TRAVERSE_EXIT;
3230 return TRAVERSE_CONTINUE;
3233 // Work out types for unspecified variables and constants.
3236 Function::determine_types()
3238 if (this->block_ != NULL)
3239 this->block_->determine_types();
3242 // Get a pointer to the variable representing the defer stack for this
3243 // function, making it if necessary. The value of the variable is set
3244 // by the runtime routines to true if the function is returning,
3245 // rather than panicing through. A pointer to this variable is used
3246 // as a marker for the functions on the defer stack associated with
3247 // this function. A function-specific variable permits inlining a
3248 // function which uses defer.
3251 Function::defer_stack(Location location)
3253 if (this->defer_stack_ == NULL)
3255 Type* t = Type::lookup_bool_type();
3256 Expression* n = Expression::make_boolean(false, location);
3257 this->defer_stack_ = Statement::make_temporary(t, n, location);
3258 this->defer_stack_->set_is_address_taken();
3260 Expression* ref = Expression::make_temporary_reference(this->defer_stack_,
3262 return Expression::make_unary(OPERATOR_AND, ref, location);
3265 // Export the function.
3268 Function::export_func(Export* exp, const std::string& name) const
3270 Function::export_func_with_type(exp, name, this->type_);
3273 // Export a function with a type.
3276 Function::export_func_with_type(Export* exp, const std::string& name,
3277 const Function_type* fntype)
3279 exp->write_c_string("func ");
3281 if (fntype->is_method())
3283 exp->write_c_string("(");
3284 const Typed_identifier* receiver = fntype->receiver();
3285 exp->write_name(receiver->name());
3286 exp->write_c_string(" ");
3287 exp->write_type(receiver->type());
3288 exp->write_c_string(") ");
3291 exp->write_string(name);
3293 exp->write_c_string(" (");
3294 const Typed_identifier_list* parameters = fntype->parameters();
3295 if (parameters != NULL)
3297 bool is_varargs = fntype->is_varargs();
3299 for (Typed_identifier_list::const_iterator p = parameters->begin();
3300 p != parameters->end();
3306 exp->write_c_string(", ");
3307 exp->write_name(p->name());
3308 exp->write_c_string(" ");
3309 if (!is_varargs || p + 1 != parameters->end())
3310 exp->write_type(p->type());
3313 exp->write_c_string("...");
3314 exp->write_type(p->type()->array_type()->element_type());
3318 exp->write_c_string(")");
3320 const Typed_identifier_list* results = fntype->results();
3321 if (results != NULL)
3323 if (results->size() == 1 && results->begin()->name().empty())
3325 exp->write_c_string(" ");
3326 exp->write_type(results->begin()->type());
3330 exp->write_c_string(" (");
3332 for (Typed_identifier_list::const_iterator p = results->begin();
3333 p != results->end();
3339 exp->write_c_string(", ");
3340 exp->write_name(p->name());
3341 exp->write_c_string(" ");
3342 exp->write_type(p->type());
3344 exp->write_c_string(")");
3347 exp->write_c_string(";\n");
3350 // Import a function.
3353 Function::import_func(Import* imp, std::string* pname,
3354 Typed_identifier** preceiver,
3355 Typed_identifier_list** pparameters,
3356 Typed_identifier_list** presults,
3359 imp->require_c_string("func ");
3362 if (imp->peek_char() == '(')
3364 imp->require_c_string("(");
3365 std::string name = imp->read_name();
3366 imp->require_c_string(" ");
3367 Type* rtype = imp->read_type();
3368 *preceiver = new Typed_identifier(name, rtype, imp->location());
3369 imp->require_c_string(") ");
3372 *pname = imp->read_identifier();
3374 Typed_identifier_list* parameters;
3375 *is_varargs = false;
3376 imp->require_c_string(" (");
3377 if (imp->peek_char() == ')')
3381 parameters = new Typed_identifier_list();
3384 std::string name = imp->read_name();
3385 imp->require_c_string(" ");
3387 if (imp->match_c_string("..."))
3393 Type* ptype = imp->read_type();
3395 ptype = Type::make_array_type(ptype, NULL);
3396 parameters->push_back(Typed_identifier(name, ptype,
3398 if (imp->peek_char() != ',')
3400 go_assert(!*is_varargs);
3401 imp->require_c_string(", ");
3404 imp->require_c_string(")");
3405 *pparameters = parameters;
3407 Typed_identifier_list* results;
3408 if (imp->peek_char() != ' ')
3412 results = new Typed_identifier_list();
3413 imp->require_c_string(" ");
3414 if (imp->peek_char() != '(')
3416 Type* rtype = imp->read_type();
3417 results->push_back(Typed_identifier("", rtype, imp->location()));
3421 imp->require_c_string("(");
3424 std::string name = imp->read_name();
3425 imp->require_c_string(" ");
3426 Type* rtype = imp->read_type();
3427 results->push_back(Typed_identifier(name, rtype,
3429 if (imp->peek_char() != ',')
3431 imp->require_c_string(", ");
3433 imp->require_c_string(")");
3436 imp->require_c_string(";\n");
3437 *presults = results;
3442 Block::Block(Block* enclosing, Location location)
3443 : enclosing_(enclosing), statements_(),
3444 bindings_(new Bindings(enclosing == NULL
3446 : enclosing->bindings())),
3447 start_location_(location),
3448 end_location_(UNKNOWN_LOCATION)
3452 // Add a statement to a block.
3455 Block::add_statement(Statement* statement)
3457 this->statements_.push_back(statement);
3460 // Add a statement to the front of a block. This is slow but is only
3461 // used for reference counts of parameters.
3464 Block::add_statement_at_front(Statement* statement)
3466 this->statements_.insert(this->statements_.begin(), statement);
3469 // Replace a statement in a block.
3472 Block::replace_statement(size_t index, Statement* s)
3474 go_assert(index < this->statements_.size());
3475 this->statements_[index] = s;
3478 // Add a statement before another statement.
3481 Block::insert_statement_before(size_t index, Statement* s)
3483 go_assert(index < this->statements_.size());
3484 this->statements_.insert(this->statements_.begin() + index, s);
3487 // Add a statement after another statement.
3490 Block::insert_statement_after(size_t index, Statement* s)
3492 go_assert(index < this->statements_.size());
3493 this->statements_.insert(this->statements_.begin() + index + 1, s);
3496 // Traverse the tree.
3499 Block::traverse(Traverse* traverse)
3501 unsigned int traverse_mask = traverse->traverse_mask();
3503 if ((traverse_mask & Traverse::traverse_blocks) != 0)
3505 int t = traverse->block(this);
3506 if (t == TRAVERSE_EXIT)
3507 return TRAVERSE_EXIT;
3508 else if (t == TRAVERSE_SKIP_COMPONENTS)
3509 return TRAVERSE_CONTINUE;
3513 & (Traverse::traverse_variables
3514 | Traverse::traverse_constants
3515 | Traverse::traverse_expressions
3516 | Traverse::traverse_types)) != 0)
3518 const unsigned int e_or_t = (Traverse::traverse_expressions
3519 | Traverse::traverse_types);
3520 const unsigned int e_or_t_or_s = (e_or_t
3521 | Traverse::traverse_statements);
3522 for (Bindings::const_definitions_iterator pb =
3523 this->bindings_->begin_definitions();
3524 pb != this->bindings_->end_definitions();
3527 int t = TRAVERSE_CONTINUE;
3528 switch ((*pb)->classification())
3530 case Named_object::NAMED_OBJECT_CONST:
3531 if ((traverse_mask & Traverse::traverse_constants) != 0)
3532 t = traverse->constant(*pb, false);
3533 if (t == TRAVERSE_CONTINUE
3534 && (traverse_mask & e_or_t) != 0)
3536 Type* tc = (*pb)->const_value()->type();