1 // Copyright 2014 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
8 "cmd/compile/internal/syntax"
13 func (err *error_) recordAltDecl(obj Object) {
14 if pos := obj.Pos(); pos.IsKnown() {
15 // We use "other" rather than "previous" here because
16 // the first declaration seen may not be textually
17 // earlier in the source.
18 err.errorf(pos, "other declaration of %s", obj.Name())
22 func (check *Checker) declare(scope *Scope, id *syntax.Name, obj Object, pos syntax.Pos) {
23 // spec: "The blank identifier, represented by the underscore
24 // character _, may be used in a declaration like any other
25 // identifier but the declaration does not introduce a new
27 if obj.Name() != "_" {
28 if alt := scope.Insert(obj); alt != nil {
30 err.errorf(obj, "%s redeclared in this block", obj.Name())
31 err.recordAltDecl(alt)
38 check.recordDef(id, obj)
42 // pathString returns a string of the form a->b-> ... ->g for a path [a, b, ... g].
43 func pathString(path []Object) string {
45 for i, p := range path {
54 // objDecl type-checks the declaration of obj in its respective (file) context.
55 // For the meaning of def, see Checker.definedType, in typexpr.go.
56 func (check *Checker) objDecl(obj Object, def *Named) {
57 if check.conf.Trace && obj.Type() == nil {
58 if check.indent == 0 {
59 fmt.Println() // empty line between top-level objects for readability
61 check.trace(obj.Pos(), "-- checking %s (%s, objPath = %s)", obj, obj.color(), pathString(check.objPath))
65 check.trace(obj.Pos(), "=> %s (%s)", obj, obj.color())
69 // Funcs with m.instRecv set have not yet be completed. Complete them now
70 // so that they have a type when objDecl exits.
71 if m, _ := obj.(*Func); m != nil && m.instRecv != nil {
72 check.completeMethod(check.conf.Environment, m)
75 // Checking the declaration of obj means inferring its type
76 // (and possibly its value, for constants).
77 // An object's type (and thus the object) may be in one of
78 // three states which are expressed by colors:
80 // - an object whose type is not yet known is painted white (initial color)
81 // - an object whose type is in the process of being inferred is painted grey
82 // - an object whose type is fully inferred is painted black
84 // During type inference, an object's color changes from white to grey
85 // to black (pre-declared objects are painted black from the start).
86 // A black object (i.e., its type) can only depend on (refer to) other black
87 // ones. White and grey objects may depend on white and black objects.
88 // A dependency on a grey object indicates a cycle which may or may not be
91 // When objects turn grey, they are pushed on the object path (a stack);
92 // they are popped again when they turn black. Thus, if a grey object (a
93 // cycle) is encountered, it is on the object path, and all the objects
94 // it depends on are the remaining objects on that path. Color encoding
95 // is such that the color value of a grey object indicates the index of
96 // that object in the object path.
98 // During type-checking, white objects may be assigned a type without
99 // traversing through objDecl; e.g., when initializing constants and
100 // variables. Update the colors of those objects here (rather than
101 // everywhere where we set the type) to satisfy the color invariants.
102 if obj.color() == white && obj.Type() != nil {
109 assert(obj.Type() == nil)
110 // All color values other than white and black are considered grey.
111 // Because black and white are < grey, all values >= grey are grey.
112 // Use those values to encode the object's index into the object path.
113 obj.setColor(grey + color(check.push(obj)))
115 check.pop().setColor(black)
119 assert(obj.Type() != nil)
123 // Color values other than white or black are considered grey.
128 // In the existing code, this is marked by a non-nil type
129 // for the object except for constants and variables whose
130 // type may be non-nil (known), or nil if it depends on the
131 // not-yet known initialization value.
132 // In the former case, set the type to Typ[Invalid] because
133 // we have an initialization cycle. The cycle error will be
134 // reported later, when determining initialization order.
135 // TODO(gri) Report cycle here and simplify initialization
137 switch obj := obj.(type) {
139 if check.cycle(obj) || obj.typ == nil {
140 obj.typ = Typ[Invalid]
144 if check.cycle(obj) || obj.typ == nil {
145 obj.typ = Typ[Invalid]
149 if check.cycle(obj) {
151 // (without this, calling underlying()
152 // below may lead to an endless loop
153 // if we have a cycle for a defined
155 obj.typ = Typ[Invalid]
159 if check.cycle(obj) {
160 // Don't set obj.typ to Typ[Invalid] here
161 // because plenty of code type-asserts that
162 // functions have a *Signature type. Grey
163 // functions have their type set to an empty
164 // signature which makes it impossible to
165 // initialize a variable with the function.
171 assert(obj.Type() != nil)
175 d := check.objMap[obj]
177 check.dump("%v: %s should have been declared", obj.Pos(), obj)
181 // save/restore current context and setup object context
182 defer func(ctxt context) {
185 check.context = context{
189 // Const and var declarations must not have initialization
190 // cycles. We track them by remembering the current declaration
191 // in check.decl. Initialization expressions depending on other
192 // consts, vars, or functions, add dependencies to the current
194 switch obj := obj.(type) {
196 check.decl = d // new package-level const decl
197 check.constDecl(obj, d.vtyp, d.init, d.inherited)
199 check.decl = d // new package-level var decl
200 check.varDecl(obj, d.lhs, d.vtyp, d.init)
202 // invalid recursive types are detected via path
203 check.typeDecl(obj, d.tdecl, def)
204 check.collectMethods(obj) // methods can only be added to top-level types
206 // functions may be recursive - no need to track dependencies
207 check.funcDecl(obj, d)
213 // cycle checks if the cycle starting with obj is valid and
214 // reports an error if it is not.
215 func (check *Checker) cycle(obj Object) (isCycle bool) {
216 // The object map contains the package scope objects and the non-interface methods.
218 info := check.objMap[obj]
219 inObjMap := info != nil && (info.fdecl == nil || info.fdecl.Recv == nil) // exclude methods
220 isPkgObj := obj.Parent() == check.pkg.scope
221 if isPkgObj != inObjMap {
222 check.dump("%v: inconsistent object map for %s (isPkgObj = %v, inObjMap = %v)", obj.Pos(), obj, isPkgObj, inObjMap)
227 // Count cycle objects.
228 assert(obj.color() >= grey)
229 start := obj.color() - grey // index of obj in objPath
230 cycle := check.objPath[start:]
231 nval := 0 // number of (constant or variable) values in the cycle
232 ndef := 0 // number of type definitions in the cycle
233 for _, obj := range cycle {
234 switch obj := obj.(type) {
238 // Determine if the type name is an alias or not. For
239 // package-level objects, use the object map which
240 // provides syntactic information (which doesn't rely
241 // on the order in which the objects are set up). For
242 // local objects, we can rely on the order, so use
243 // the object's predicate.
244 // TODO(gri) It would be less fragile to always access
245 // the syntactic information. We should consider storing
246 // this information explicitly in the object.
248 if d := check.objMap[obj]; d != nil {
249 alias = d.tdecl.Alias // package-level object
251 alias = obj.IsAlias() // function local object
263 if check.conf.Trace {
264 check.trace(obj.Pos(), "## cycle detected: objPath = %s->%s (len = %d)", pathString(cycle), obj.Name(), len(cycle))
265 check.trace(obj.Pos(), "## cycle contains: %d values, %d type definitions", nval, ndef)
268 check.trace(obj.Pos(), "=> error: cycle is invalid")
273 // A cycle involving only constants and variables is invalid but we
274 // ignore them here because they are reported via the initialization
276 if nval == len(cycle) {
280 // A cycle involving only types (and possibly functions) must have at least
281 // one type definition to be permitted: If there is no type definition, we
282 // have a sequence of alias type names which will expand ad infinitum.
283 if nval == 0 && ndef > 0 {
284 return false // cycle is permitted
287 check.cycleError(cycle)
294 // validType verifies that the given type does not "expand" infinitely
295 // producing a cycle in the type graph. Cycles are detected by marking
297 // (Cycles involving alias types, as in "type A = [10]A" are detected
298 // earlier, via the objDecl cycle detection mechanism.)
299 func (check *Checker) validType(typ Type, path []Object) typeInfo {
301 unknown typeInfo = iota
307 switch t := typ.(type) {
309 return check.validType(t.elem, path)
312 for _, f := range t.fields {
313 if check.validType(f.typ, path) == invalid {
319 for _, etyp := range t.embeddeds {
320 if check.validType(etyp, path) == invalid {
326 t.resolve(check.conf.Environment)
328 // don't touch the type if it is from a different package or the Universe scope
329 // (doing so would lead to a race condition - was issue #35049)
330 if t.obj.pkg != check.pkg {
334 // don't report a 2nd error if we already know the type is invalid
335 // (e.g., if a cycle was detected earlier, via under).
336 if t.underlying == Typ[Invalid] {
344 t.info = check.validType(t.fromRHS, append(path, t.obj)) // only types of current package added to path
347 for i, tn := range path {
348 if t.obj.pkg != check.pkg {
349 panic("type cycle via package-external type")
352 check.cycleError(path[i:])
357 panic("cycle start not found")
365 // cycleError reports a declaration cycle starting with
366 // the object in cycle that is "first" in the source.
367 func (check *Checker) cycleError(cycle []Object) {
368 // TODO(gri) Should we start with the last (rather than the first) object in the cycle
369 // since that is the earliest point in the source where we start seeing the
370 // cycle? That would be more consistent with other error messages.
371 i := firstInSrc(cycle)
374 if check.conf.CompilerErrorMessages {
375 err.errorf(obj, "invalid recursive type %s", obj.Name())
377 err.errorf(obj, "illegal cycle in declaration of %s", obj.Name())
380 err.errorf(obj, "%s refers to", obj.Name())
387 err.errorf(obj, "%s", obj.Name())
391 // firstInSrc reports the index of the object with the "smallest"
392 // source position in path. path must not be empty.
393 func firstInSrc(path []Object) int {
394 fst, pos := 0, path[0].Pos()
395 for i, t := range path[1:] {
396 if t.Pos().Cmp(pos) < 0 {
397 fst, pos = i+1, t.Pos()
403 func (check *Checker) constDecl(obj *Const, typ, init syntax.Expr, inherited bool) {
404 assert(obj.typ == nil)
406 // use the correct value of iota and errpos
407 defer func(iota constant.Value, errpos syntax.Pos) {
409 check.errpos = errpos
410 }(check.iota, check.errpos)
414 // provide valid constant value under all circumstances
415 obj.val = constant.MakeUnknown()
417 // determine type, if any
421 // don't report an error if the type is an invalid C (defined) type
423 if under(t) != Typ[Invalid] {
424 check.errorf(typ, "invalid constant type %s", t)
426 obj.typ = Typ[Invalid]
432 // check initialization
436 // The initialization expression is inherited from a previous
437 // constant declaration, and (error) positions refer to that
438 // expression and not the current constant declaration. Use
439 // the constant identifier position for any errors during
440 // init expression evaluation since that is all we have
441 // (see issues #42991, #42992).
442 check.errpos = obj.pos
446 check.initConst(obj, &x)
449 func (check *Checker) varDecl(obj *Var, lhs []*Var, typ, init syntax.Expr) {
450 assert(obj.typ == nil)
452 // If we have undefined variable types due to errors,
453 // mark variables as used to avoid follow-on errors.
454 // Matches compiler behavior.
456 if obj.typ == Typ[Invalid] {
459 for _, lhs := range lhs {
460 if lhs.typ == Typ[Invalid] {
466 // determine type, if any
468 obj.typ = check.varType(typ)
469 // We cannot spread the type to all lhs variables if there
470 // are more than one since that would mark them as checked
471 // (see Checker.objDecl) and the assignment of init exprs,
472 // if any, would not be checked.
474 // TODO(gri) If we have no init expr, we should distribute
475 // a given type otherwise we need to re-evalate the type
476 // expr for each lhs variable, leading to duplicate work.
479 // check initialization
482 // error reported before by arityMatch
483 obj.typ = Typ[Invalid]
488 if lhs == nil || len(lhs) == 1 {
489 assert(lhs == nil || lhs[0] == obj)
492 check.initVar(obj, &x, "variable declaration")
497 // obj must be one of lhs
499 for _, lhs := range lhs {
506 panic("inconsistent lhs")
510 // We have multiple variables on the lhs and one init expr.
511 // Make sure all variables have been given the same type if
512 // one was specified, otherwise they assume the type of the
513 // init expression values (was issue #15755).
515 for _, lhs := range lhs {
520 check.initVars(lhs, []syntax.Expr{init}, nopos)
523 // isImportedConstraint reports whether typ is an imported type constraint.
524 func (check *Checker) isImportedConstraint(typ Type) bool {
525 named, _ := typ.(*Named)
526 if named == nil || named.obj.pkg == check.pkg || named.obj.pkg == nil {
529 u, _ := named.under().(*Interface)
530 return u != nil && u.IsConstraint()
533 func (check *Checker) typeDecl(obj *TypeName, tdecl *syntax.TypeDecl, def *Named) {
534 assert(obj.typ == nil)
538 check.validType(obj.typ, nil)
539 // If typ is local, an error was already reported where typ is specified/defined.
540 if check.isImportedConstraint(rhs) && !check.allowVersion(check.pkg, 1, 18) {
541 check.errorf(tdecl.Type.Pos(), "using type constraint %s requires go1.18 or later", rhs)
546 if alias && tdecl.TParamList != nil {
547 // The parser will ensure this but we may still get an invalid AST.
548 // Complain and continue as regular type definition.
549 check.error(tdecl, "generic type cannot be alias")
555 if !check.allowVersion(check.pkg, 1, 9) {
556 if check.conf.CompilerErrorMessages {
557 check.error(tdecl, "type aliases only supported as of -lang=go1.9")
559 check.error(tdecl, "type aliases requires go1.9 or later")
563 obj.typ = Typ[Invalid]
564 rhs = check.varType(tdecl.Type)
569 // type definition or generic type declaration
570 named := check.newNamed(obj, nil, nil, nil, nil)
571 def.setUnderlying(named)
573 if tdecl.TParamList != nil {
574 check.openScope(tdecl, "type parameters")
575 defer check.closeScope()
576 check.collectTypeParams(&named.tparams, tdecl.TParamList)
579 // determine underlying type of named
580 rhs = check.definedType(tdecl.Type, named)
583 // The underlying type of named may be itself a named type that is
592 // The type of C is the (named) type of A which is incomplete,
593 // and which has as its underlying type the named type B.
594 // Determine the (final, unnamed) underlying type by resolving
595 // any forward chain.
596 // TODO(gri) Investigate if we can just use named.fromRHS here
597 // and rely on lazy computation of the underlying type.
598 named.underlying = under(named)
600 // If the RHS is a type parameter, it must be from this type declaration.
601 if tpar, _ := named.underlying.(*TypeParam); tpar != nil && tparamIndex(named.TypeParams().list(), tpar) < 0 {
602 check.errorf(tdecl.Type, "cannot use function type parameter %s as RHS in type declaration", tpar)
603 named.underlying = Typ[Invalid]
607 func (check *Checker) collectTypeParams(dst **TypeParamList, list []*syntax.Field) {
608 tparams := make([]*TypeParam, len(list))
610 // Declare type parameters up-front.
611 // The scope of type parameters starts at the beginning of the type parameter
612 // list (so we can have mutually recursive parameterized type bounds).
613 for i, f := range list {
614 tparams[i] = check.declareTypeParam(f.Name)
617 // Set the type parameters before collecting the type constraints because
618 // the parameterized type may be used by the constraints (issue #47887).
619 // Example: type T[P T[P]] interface{}
620 *dst = bindTParams(tparams)
623 for i, f := range list {
624 // Optimization: Re-use the previous type bound if it hasn't changed.
625 // This also preserves the grouped output of type parameter lists
626 // when printing type strings.
627 if i == 0 || f.Type != list[i-1].Type {
628 bound = check.typ(f.Type)
630 tparams[i].bound = bound
634 for i, tpar := range tparams {
635 u := under(tpar.bound)
636 if _, ok := u.(*Interface); !ok && u != Typ[Invalid] {
637 check.errorf(list[i].Type, "%s is not an interface", tpar.bound)
643 func (check *Checker) declareTypeParam(name *syntax.Name) *TypeParam {
644 // Use Typ[Invalid] for the type constraint to ensure that a type
645 // is present even if the actual constraint has not been assigned
647 // TODO(gri) Need to systematically review all uses of type parameter
648 // constraints to make sure we don't rely on them if they
649 // are not properly set yet.
650 tname := NewTypeName(name.Pos(), check.pkg, name.Value, nil)
651 tpar := check.newTypeParam(tname, Typ[Invalid]) // assigns type to tname as a side-effect
652 check.declare(check.scope, name, tname, check.scope.pos) // TODO(gri) check scope position
656 func (check *Checker) collectMethods(obj *TypeName) {
657 // get associated methods
658 // (Checker.collectObjects only collects methods with non-blank names;
659 // Checker.resolveBaseTypeName ensures that obj is not an alias name
660 // if it has attached methods.)
661 methods := check.methods[obj]
665 delete(check.methods, obj)
666 assert(!check.objMap[obj].tdecl.Alias) // don't use TypeName.IsAlias (requires fully set up object)
668 // use an objset to check for name conflicts
671 // spec: "If the base type is a struct type, the non-blank method
672 // and field names must be distinct."
673 base := asNamed(obj.typ) // shouldn't fail but be conservative
675 u := safeUnderlying(base) // base should be expanded, but use safeUnderlying to be conservative
676 if t, _ := u.(*Struct); t != nil {
677 for _, fld := range t.fields {
679 assert(mset.insert(fld) == nil)
684 // Checker.Files may be called multiple times; additional package files
685 // may add methods to already type-checked types. Add pre-existing methods
686 // so that we can detect redeclarations.
687 for _, m := range base.methods {
688 assert(m.name != "_")
689 assert(mset.insert(m) == nil)
694 for _, m := range methods {
695 // spec: "For a base type, the non-blank names of methods bound
696 // to it must be unique."
697 assert(m.name != "_")
698 if alt := mset.insert(m); alt != nil {
702 err.errorf(m.pos, "field and method with the same name %s", m.name)
704 if check.conf.CompilerErrorMessages {
705 err.errorf(m.pos, "%s.%s redeclared in this block", obj.Name(), m.name)
707 err.errorf(m.pos, "method %s already declared for %s", m.name, obj)
712 err.recordAltDecl(alt)
718 base.resolve(nil) // TODO(mdempsky): Probably unnecessary.
719 base.methods = append(base.methods, m)
724 func (check *Checker) funcDecl(obj *Func, decl *declInfo) {
725 assert(obj.typ == nil)
727 // func declarations cannot use iota
728 assert(check.iota == nil)
730 sig := new(Signature)
731 obj.typ = sig // guard against cycles
733 // Avoid cycle error when referring to method while type-checking the signature.
734 // This avoids a nuisance in the best case (non-parameterized receiver type) and
735 // since the method is not a type, we get an error. If we have a parameterized
736 // receiver type, instantiating the receiver type leads to the instantiation of
737 // its methods, and we don't want a cycle error in that case.
738 // TODO(gri) review if this is correct and/or whether we still need this?
742 check.funcType(sig, fdecl.Recv, fdecl.TParamList, fdecl.Type)
745 if len(fdecl.TParamList) > 0 && fdecl.Body == nil {
746 check.softErrorf(fdecl, "parameterized function is missing function body")
749 // function body must be type-checked after global declarations
750 // (functions implemented elsewhere have no body)
751 if !check.conf.IgnoreFuncBodies && fdecl.Body != nil {
753 check.funcBody(decl, obj.name, sig, fdecl.Body, nil)
758 func (check *Checker) declStmt(list []syntax.Decl) {
761 first := -1 // index of first ConstDecl in the current group, or -1
762 var last *syntax.ConstDecl // last ConstDecl with init expressions, or nil
763 for index, decl := range list {
764 if _, ok := decl.(*syntax.ConstDecl); !ok {
765 first = -1 // we're not in a constant declaration
768 switch s := decl.(type) {
769 case *syntax.ConstDecl:
770 top := len(check.delayed)
772 // iota is the index of the current constDecl within the group
773 if first < 0 || list[index-1].(*syntax.ConstDecl).Group != s.Group {
777 iota := constant.MakeInt64(int64(index - first))
779 // determine which initialization expressions to use
782 case s.Type != nil || s.Values != nil:
786 last = new(syntax.ConstDecl) // make sure last exists
790 // declare all constants
791 lhs := make([]*Const, len(s.NameList))
792 values := unpackExpr(last.Values)
793 for i, name := range s.NameList {
794 obj := NewConst(name.Pos(), pkg, name.Value, nil, iota)
802 check.constDecl(obj, last.Type, init, inherited)
805 // Constants must always have init values.
806 check.arity(s.Pos(), s.NameList, values, true, inherited)
808 // process function literals in init expressions before scope changes
809 check.processDelayed(top)
811 // spec: "The scope of a constant or variable identifier declared
812 // inside a function begins at the end of the ConstSpec or VarSpec
813 // (ShortVarDecl for short variable declarations) and ends at the
814 // end of the innermost containing block."
815 scopePos := syntax.EndPos(s)
816 for i, name := range s.NameList {
817 check.declare(check.scope, name, lhs[i], scopePos)
820 case *syntax.VarDecl:
821 top := len(check.delayed)
823 lhs0 := make([]*Var, len(s.NameList))
824 for i, name := range s.NameList {
825 lhs0[i] = NewVar(name.Pos(), pkg, name.Value, nil)
828 // initialize all variables
829 values := unpackExpr(s.Values)
830 for i, obj := range lhs0 {
834 case len(s.NameList):
838 // rhs is expected to be a multi-valued expression
846 check.varDecl(obj, lhs, s.Type, init)
847 if len(values) == 1 {
848 // If we have a single lhs variable we are done either way.
849 // If we have a single rhs expression, it must be a multi-
850 // valued expression, in which case handling the first lhs
851 // variable will cause all lhs variables to have a type
852 // assigned, and we are done as well.
854 for _, obj := range lhs0 {
855 assert(obj.typ != nil)
862 // If we have no type, we must have values.
863 if s.Type == nil || values != nil {
864 check.arity(s.Pos(), s.NameList, values, false, false)
867 // process function literals in init expressions before scope changes
868 check.processDelayed(top)
870 // declare all variables
871 // (only at this point are the variable scopes (parents) set)
872 scopePos := syntax.EndPos(s) // see constant declarations
873 for i, name := range s.NameList {
874 // see constant declarations
875 check.declare(check.scope, name, lhs0[i], scopePos)
878 case *syntax.TypeDecl:
879 obj := NewTypeName(s.Name.Pos(), pkg, s.Name.Value, nil)
880 // spec: "The scope of a type identifier declared inside a function
881 // begins at the identifier in the TypeSpec and ends at the end of
882 // the innermost containing block."
883 scopePos := s.Name.Pos()
884 check.declare(check.scope, s.Name, obj, scopePos)
885 // mark and unmark type before calling typeDecl; its type is still nil (see Checker.objDecl)
886 obj.setColor(grey + color(check.push(obj)))
887 check.typeDecl(obj, s, nil)
888 check.pop().setColor(black)
891 check.errorf(s, invalidAST+"unknown syntax.Decl node %T", s)