src/cmd/compile/internal/types/pkg.go

   1 // Copyright 2017 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.
   4
   5 package types
   6
   7 import (
   8         "cmd/internal/obj"
   9         "cmd/internal/objabi"
  10         "fmt"
  11         "sort"
  12         "strings"
  13         "sync"
  14 )
  15
  16 // pkgMap maps a package path to a package.
  17 var pkgMap = make(map[string]*Pkg)
  18
  19 // MaxPkgHeight is a height greater than any likely package height.
  20 const MaxPkgHeight = 1e9
  21
  22 type Pkg struct {
  23         Path    string // string literal used in import statement, e.g. "runtime/internal/sys"
  24         Name    string // package name, e.g. "sys"
  25         Prefix  string // escaped path for use in symbol table
  26         Syms    map[string]*Sym
  27         Pathsym *obj.LSym
  28
  29         // Height is the package's height in the import graph. Leaf
  30         // packages (i.e., packages with no imports) have height 0,
  31         // and all other packages have height 1 plus the maximum
  32         // height of their imported packages.
  33         Height int
  34
  35         Direct bool // imported directly
  36 }
  37
  38 // NewPkg returns a new Pkg for the given package path and name.
  39 // Unless name is the empty string, if the package exists already,
  40 // the existing package name and the provided name must match.
  41 func NewPkg(path, name string) *Pkg {
  42         if p := pkgMap[path]; p != nil {
  43                 if name != "" && p.Name != name {
  44                         panic(fmt.Sprintf("conflicting package names %s and %s for path %q", p.Name, name, path))
  45                 }
  46                 return p
  47         }
  48
  49         p := new(Pkg)
  50         p.Path = path
  51         p.Name = name
  52         if strings.HasPrefix(path, "go.") {
  53                 // Special compiler-internal packages don't need to be escaped.
  54                 // This particularly helps with the go.shape package.
  55                 p.Prefix = path
  56         } else {
  57                 p.Prefix = objabi.PathToPrefix(path)
  58         }
  59         p.Syms = make(map[string]*Sym)
  60         pkgMap[path] = p
  61
  62         return p
  63 }
  64
  65 // ImportedPkgList returns the list of directly imported packages.
  66 // The list is sorted by package path.
  67 func ImportedPkgList() []*Pkg {
  68         var list []*Pkg
  69         for _, p := range pkgMap {
  70                 if p.Direct {
  71                         list = append(list, p)
  72                 }
  73         }
  74         sort.Sort(byPath(list))
  75         return list
  76 }
  77
  78 type byPath []*Pkg
  79
  80 func (a byPath) Len() int           { return len(a) }
  81 func (a byPath) Less(i, j int) bool { return a[i].Path < a[j].Path }
  82 func (a byPath) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
  83
  84 var nopkg = &Pkg{
  85         Syms: make(map[string]*Sym),
  86 }
  87
  88 func (pkg *Pkg) Lookup(name string) *Sym {
  89         s, _ := pkg.LookupOK(name)
  90         return s
  91 }
  92
  93 // LookupOK looks up name in pkg and reports whether it previously existed.
  94 func (pkg *Pkg) LookupOK(name string) (s *Sym, existed bool) {
  95         // TODO(gri) remove this check in favor of specialized lookup
  96         if pkg == nil {
  97                 pkg = nopkg
  98         }
  99         if s := pkg.Syms[name]; s != nil {
 100                 return s, true
 101         }
 102
 103         s = &Sym{
 104                 Name: name,
 105                 Pkg:  pkg,
 106         }
 107         pkg.Syms[name] = s
 108         return s, false
 109 }
 110
 111 func (pkg *Pkg) LookupBytes(name []byte) *Sym {
 112         // TODO(gri) remove this check in favor of specialized lookup
 113         if pkg == nil {
 114                 pkg = nopkg
 115         }
 116         if s := pkg.Syms[string(name)]; s != nil {
 117                 return s
 118         }
 119         str := InternString(name)
 120         return pkg.Lookup(str)
 121 }
 122
 123 var (
 124         internedStringsmu sync.Mutex // protects internedStrings
 125         internedStrings   = map[string]string{}
 126 )
 127
 128 func InternString(b []byte) string {
 129         internedStringsmu.Lock()
 130         s, ok := internedStrings[string(b)] // string(b) here doesn't allocate
 131         if !ok {
 132                 s = string(b)
 133                 internedStrings[s] = s
 134         }
 135         internedStringsmu.Unlock()
 136         return s
 137 }
 138
 139 // CleanroomDo invokes f in an environment with no preexisting packages.
 140 // For testing of import/export only.
 141 func CleanroomDo(f func()) {
 142         saved := pkgMap
 143         pkgMap = make(map[string]*Pkg)
 144         f()
 145         pkgMap = saved
 146 }