src/cmd/link/internal/loader/symbolbuilder.go

   1 // Copyright 2019 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 loader
   6
   7 import (
   8         "cmd/internal/goobj2"
   9         "cmd/internal/objabi"
  10         "cmd/internal/sys"
  11         "cmd/link/internal/sym"
  12         "fmt"
  13         "sort"
  14 )
  15
  16 // SymbolBuilder is a helper designed to help with the construction
  17 // of new symbol contents.
  18 type SymbolBuilder struct {
  19         *extSymPayload         // points to payload being updated
  20         symIdx         Sym     // index of symbol being updated/constructed
  21         l              *Loader // loader
  22 }
  23
  24 // MakeSymbolBuilder creates a symbol builder for use in constructing
  25 // an entirely new symbol.
  26 func (l *Loader) MakeSymbolBuilder(name string) *SymbolBuilder {
  27         // for now assume that any new sym is intended to be static
  28         symIdx := l.CreateStaticSym(name)
  29         if l.Syms[symIdx] != nil {
  30                 panic("can't build if sym.Symbol already present")
  31         }
  32         sb := &SymbolBuilder{l: l, symIdx: symIdx}
  33         sb.extSymPayload = l.getPayload(symIdx)
  34         return sb
  35 }
  36
  37 // MakeSymbolUpdater creates a symbol builder helper for an existing
  38 // symbol 'symIdx'. If 'symIdx' is not an external symbol, then create
  39 // a clone of it (copy name, properties, etc) fix things up so that
  40 // the lookup tables and caches point to the new version, not the old
  41 // version.
  42 func (l *Loader) MakeSymbolUpdater(symIdx Sym) *SymbolBuilder {
  43         if symIdx == 0 {
  44                 panic("can't update the null symbol")
  45         }
  46         if !l.IsExternal(symIdx) {
  47                 // Create a clone with the same name/version/kind etc.
  48                 l.cloneToExternal(symIdx)
  49         }
  50         // Now that we're doing phase 2 DWARF generation using the loader
  51         // but before the wavefront has reached dodata(), we can't have this
  52         // assertion here. Commented out for now.
  53         if false {
  54                 if l.Syms[symIdx] != nil {
  55                         panic(fmt.Sprintf("can't build if sym.Symbol %q already present", l.RawSymName(symIdx)))
  56                 }
  57         }
  58
  59         // Construct updater and return.
  60         sb := &SymbolBuilder{l: l, symIdx: symIdx}
  61         sb.extSymPayload = l.getPayload(symIdx)
  62         return sb
  63 }
  64
  65 // CreateSymForUpdate creates a symbol with given name and version,
  66 // returns a CreateSymForUpdate for update. If the symbol already
  67 // exists, it will update in-place.
  68 func (l *Loader) CreateSymForUpdate(name string, version int) *SymbolBuilder {
  69         return l.MakeSymbolUpdater(l.LookupOrCreateSym(name, version))
  70 }
  71
  72 // Getters for properties of the symbol we're working on.
  73
  74 func (sb *SymbolBuilder) Sym() Sym               { return sb.symIdx }
  75 func (sb *SymbolBuilder) Name() string           { return sb.name }
  76 func (sb *SymbolBuilder) Version() int           { return sb.ver }
  77 func (sb *SymbolBuilder) Type() sym.SymKind      { return sb.kind }
  78 func (sb *SymbolBuilder) Size() int64            { return sb.size }
  79 func (sb *SymbolBuilder) Data() []byte           { return sb.data }
  80 func (sb *SymbolBuilder) Value() int64           { return sb.l.SymValue(sb.symIdx) }
  81 func (sb *SymbolBuilder) Align() int32           { return sb.l.SymAlign(sb.symIdx) }
  82 func (sb *SymbolBuilder) Localentry() uint8      { return sb.l.SymLocalentry(sb.symIdx) }
  83 func (sb *SymbolBuilder) OnList() bool           { return sb.l.AttrOnList(sb.symIdx) }
  84 func (sb *SymbolBuilder) External() bool         { return sb.l.AttrExternal(sb.symIdx) }
  85 func (sb *SymbolBuilder) Extname() string        { return sb.l.SymExtname(sb.symIdx) }
  86 func (sb *SymbolBuilder) CgoExportDynamic() bool { return sb.l.AttrCgoExportDynamic(sb.symIdx) }
  87 func (sb *SymbolBuilder) Dynimplib() string      { return sb.l.SymDynimplib(sb.symIdx) }
  88 func (sb *SymbolBuilder) Dynimpvers() string     { return sb.l.SymDynimpvers(sb.symIdx) }
  89 func (sb *SymbolBuilder) SubSym() Sym            { return sb.l.SubSym(sb.symIdx) }
  90 func (sb *SymbolBuilder) GoType() Sym            { return sb.l.SymGoType(sb.symIdx) }
  91 func (sb *SymbolBuilder) VisibilityHidden() bool { return sb.l.AttrVisibilityHidden(sb.symIdx) }
  92 func (sb *SymbolBuilder) Sect() *sym.Section     { return sb.l.SymSect(sb.symIdx) }
  93
  94 // Setters for symbol properties.
  95
  96 func (sb *SymbolBuilder) SetType(kind sym.SymKind)   { sb.kind = kind }
  97 func (sb *SymbolBuilder) SetSize(size int64)         { sb.size = size }
  98 func (sb *SymbolBuilder) SetData(data []byte)        { sb.data = data }
  99 func (sb *SymbolBuilder) SetOnList(v bool)           { sb.l.SetAttrOnList(sb.symIdx, v) }
 100 func (sb *SymbolBuilder) SetExternal(v bool)         { sb.l.SetAttrExternal(sb.symIdx, v) }
 101 func (sb *SymbolBuilder) SetValue(v int64)           { sb.l.SetSymValue(sb.symIdx, v) }
 102 func (sb *SymbolBuilder) SetAlign(align int32)       { sb.l.SetSymAlign(sb.symIdx, align) }
 103 func (sb *SymbolBuilder) SetLocalentry(value uint8)  { sb.l.SetSymLocalentry(sb.symIdx, value) }
 104 func (sb *SymbolBuilder) SetExtname(value string)    { sb.l.SetSymExtname(sb.symIdx, value) }
 105 func (sb *SymbolBuilder) SetDynimplib(value string)  { sb.l.SetSymDynimplib(sb.symIdx, value) }
 106 func (sb *SymbolBuilder) SetDynimpvers(value string) { sb.l.SetSymDynimpvers(sb.symIdx, value) }
 107 func (sb *SymbolBuilder) SetPlt(value int32)         { sb.l.SetPlt(sb.symIdx, value) }
 108 func (sb *SymbolBuilder) SetGot(value int32)         { sb.l.SetGot(sb.symIdx, value) }
 109 func (sb *SymbolBuilder) SetSpecial(value bool)      { sb.l.SetAttrSpecial(sb.symIdx, value) }
 110 func (sb *SymbolBuilder) SetLocal(value bool)        { sb.l.SetAttrLocal(sb.symIdx, value) }
 111 func (sb *SymbolBuilder) SetVisibilityHidden(value bool) {
 112         sb.l.SetAttrVisibilityHidden(sb.symIdx, value)
 113 }
 114 func (sb *SymbolBuilder) SetNotInSymbolTable(value bool) {
 115         sb.l.SetAttrNotInSymbolTable(sb.symIdx, value)
 116 }
 117 func (sb *SymbolBuilder) SetSect(sect *sym.Section) { sb.l.SetSymSect(sb.symIdx, sect) }
 118
 119 func (sb *SymbolBuilder) AddBytes(data []byte) {
 120         sb.setReachable()
 121         if sb.kind == 0 {
 122                 sb.kind = sym.SDATA
 123         }
 124         sb.data = append(sb.data, data...)
 125         sb.size = int64(len(sb.data))
 126 }
 127
 128 func (sb *SymbolBuilder) Relocs() Relocs {
 129         return sb.l.Relocs(sb.symIdx)
 130 }
 131
 132 func (sb *SymbolBuilder) SetRelocs(rslice []Reloc) {
 133         n := len(rslice)
 134         if cap(sb.relocs) < n {
 135                 sb.relocs = make([]goobj2.Reloc, n)
 136                 sb.reltypes = make([]objabi.RelocType, n)
 137         } else {
 138                 sb.relocs = sb.relocs[:n]
 139                 sb.reltypes = sb.reltypes[:n]
 140         }
 141         for i := range rslice {
 142                 sb.SetReloc(i, rslice[i])
 143         }
 144 }
 145
 146 // Add n relocations, return a handle to the relocations.
 147 func (sb *SymbolBuilder) AddRelocs(n int) Relocs {
 148         sb.relocs = append(sb.relocs, make([]goobj2.Reloc, n)...)
 149         sb.reltypes = append(sb.reltypes, make([]objabi.RelocType, n)...)
 150         return sb.l.Relocs(sb.symIdx)
 151 }
 152
 153 // Add a relocation with given type, return its handle and index
 154 // (to set other fields).
 155 func (sb *SymbolBuilder) AddRel(typ objabi.RelocType) (Reloc2, int) {
 156         j := len(sb.relocs)
 157         sb.relocs = append(sb.relocs, goobj2.Reloc{})
 158         sb.reltypes = append(sb.reltypes, typ)
 159         relocs := sb.Relocs()
 160         return relocs.At2(j), j
 161 }
 162
 163 // Sort relocations by offset.
 164 func (sb *SymbolBuilder) SortRelocs() {
 165         sort.Sort((*relocsByOff)(sb.extSymPayload))
 166 }
 167
 168 // Implement sort.Interface
 169 type relocsByOff extSymPayload
 170
 171 func (p *relocsByOff) Len() int           { return len(p.relocs) }
 172 func (p *relocsByOff) Less(i, j int) bool { return p.relocs[i].Off() < p.relocs[j].Off() }
 173 func (p *relocsByOff) Swap(i, j int) {
 174         p.relocs[i], p.relocs[j] = p.relocs[j], p.relocs[i]
 175         p.reltypes[i], p.reltypes[j] = p.reltypes[j], p.reltypes[i]
 176 }
 177
 178 // AddReloc appends the specified reloc to the symbols list of
 179 // relocations. Return value is the index of the newly created
 180 // reloc.
 181 func (sb *SymbolBuilder) AddReloc(r Reloc) uint32 {
 182         // Populate a goobj2.Reloc from external reloc record.
 183         rval := uint32(len(sb.relocs))
 184         var b goobj2.Reloc
 185         b.Set(r.Off, r.Size, 0, r.Add, goobj2.SymRef{PkgIdx: 0, SymIdx: uint32(r.Sym)})
 186         sb.relocs = append(sb.relocs, b)
 187         sb.reltypes = append(sb.reltypes, r.Type)
 188         return rval
 189 }
 190
 191 // Update the j-th relocation in place.
 192 func (sb *SymbolBuilder) SetReloc(j int, r Reloc) {
 193         // Populate a goobj2.Reloc from external reloc record.
 194         sb.relocs[j].Set(r.Off, r.Size, 0, r.Add, goobj2.SymRef{PkgIdx: 0, SymIdx: uint32(r.Sym)})
 195         sb.reltypes[j] = r.Type
 196 }
 197
 198 func (sb *SymbolBuilder) Reachable() bool {
 199         return sb.l.AttrReachable(sb.symIdx)
 200 }
 201
 202 func (sb *SymbolBuilder) SetReachable(v bool) {
 203         sb.l.SetAttrReachable(sb.symIdx, v)
 204 }
 205
 206 func (sb *SymbolBuilder) setReachable() {
 207         sb.SetReachable(true)
 208 }
 209
 210 func (sb *SymbolBuilder) ReadOnly() bool {
 211         return sb.l.AttrReadOnly(sb.symIdx)
 212 }
 213
 214 func (sb *SymbolBuilder) SetReadOnly(v bool) {
 215         sb.l.SetAttrReadOnly(sb.symIdx, v)
 216 }
 217
 218 func (sb *SymbolBuilder) DuplicateOK() bool {
 219         return sb.l.AttrDuplicateOK(sb.symIdx)
 220 }
 221
 222 func (sb *SymbolBuilder) SetDuplicateOK(v bool) {
 223         sb.l.SetAttrDuplicateOK(sb.symIdx, v)
 224 }
 225
 226 func (sb *SymbolBuilder) Outer() Sym {
 227         return sb.l.OuterSym(sb.symIdx)
 228 }
 229
 230 func (sb *SymbolBuilder) Sub() Sym {
 231         return sb.l.SubSym(sb.symIdx)
 232 }
 233
 234 func (sb *SymbolBuilder) SortSub() {
 235         sb.l.SortSub(sb.symIdx)
 236 }
 237
 238 func (sb *SymbolBuilder) PrependSub(sub Sym) {
 239         sb.l.PrependSub(sb.symIdx, sub)
 240 }
 241
 242 func (sb *SymbolBuilder) AddUint8(v uint8) int64 {
 243         off := sb.size
 244         if sb.kind == 0 {
 245                 sb.kind = sym.SDATA
 246         }
 247         sb.setReachable()
 248         sb.size++
 249         sb.data = append(sb.data, v)
 250         return off
 251 }
 252
 253 func (sb *SymbolBuilder) AddUintXX(arch *sys.Arch, v uint64, wid int) int64 {
 254         off := sb.size
 255         sb.setReachable()
 256         sb.setUintXX(arch, off, v, int64(wid))
 257         return off
 258 }
 259
 260 func (sb *SymbolBuilder) setUintXX(arch *sys.Arch, off int64, v uint64, wid int64) int64 {
 261         if sb.kind == 0 {
 262                 sb.kind = sym.SDATA
 263         }
 264         if sb.size < off+wid {
 265                 sb.size = off + wid
 266                 sb.Grow(sb.size)
 267         }
 268
 269         switch wid {
 270         case 1:
 271                 sb.data[off] = uint8(v)
 272         case 2:
 273                 arch.ByteOrder.PutUint16(sb.data[off:], uint16(v))
 274         case 4:
 275                 arch.ByteOrder.PutUint32(sb.data[off:], uint32(v))
 276         case 8:
 277                 arch.ByteOrder.PutUint64(sb.data[off:], v)
 278         }
 279
 280         return off + wid
 281 }
 282
 283 func (sb *SymbolBuilder) AddUint16(arch *sys.Arch, v uint16) int64 {
 284         return sb.AddUintXX(arch, uint64(v), 2)
 285 }
 286
 287 func (sb *SymbolBuilder) AddUint32(arch *sys.Arch, v uint32) int64 {
 288         return sb.AddUintXX(arch, uint64(v), 4)
 289 }
 290
 291 func (sb *SymbolBuilder) AddUint64(arch *sys.Arch, v uint64) int64 {
 292         return sb.AddUintXX(arch, v, 8)
 293 }
 294
 295 func (sb *SymbolBuilder) AddUint(arch *sys.Arch, v uint64) int64 {
 296         return sb.AddUintXX(arch, v, arch.PtrSize)
 297 }
 298
 299 func (sb *SymbolBuilder) SetUint8(arch *sys.Arch, r int64, v uint8) int64 {
 300         sb.setReachable()
 301         return sb.setUintXX(arch, r, uint64(v), 1)
 302 }
 303
 304 func (sb *SymbolBuilder) SetUint16(arch *sys.Arch, r int64, v uint16) int64 {
 305         sb.setReachable()
 306         return sb.setUintXX(arch, r, uint64(v), 2)
 307 }
 308
 309 func (sb *SymbolBuilder) SetUint32(arch *sys.Arch, r int64, v uint32) int64 {
 310         sb.setReachable()
 311         return sb.setUintXX(arch, r, uint64(v), 4)
 312 }
 313
 314 func (sb *SymbolBuilder) SetUint(arch *sys.Arch, r int64, v uint64) int64 {
 315         sb.setReachable()
 316         return sb.setUintXX(arch, r, v, int64(arch.PtrSize))
 317 }
 318
 319 func (sb *SymbolBuilder) SetAddrPlus(arch *sys.Arch, off int64, tgt Sym, add int64) int64 {
 320         if sb.Type() == 0 {
 321                 sb.SetType(sym.SDATA)
 322         }
 323         sb.setReachable()
 324         if off+int64(arch.PtrSize) > sb.size {
 325                 sb.size = off + int64(arch.PtrSize)
 326                 sb.Grow(sb.size)
 327         }
 328         var r Reloc
 329         r.Sym = tgt
 330         r.Off = int32(off)
 331         r.Size = uint8(arch.PtrSize)
 332         r.Type = objabi.R_ADDR
 333         r.Add = add
 334         sb.AddReloc(r)
 335         return off + int64(r.Size)
 336 }
 337
 338 func (sb *SymbolBuilder) SetAddr(arch *sys.Arch, off int64, tgt Sym) int64 {
 339         return sb.SetAddrPlus(arch, off, tgt, 0)
 340 }
 341
 342 func (sb *SymbolBuilder) Addstring(str string) int64 {
 343         sb.setReachable()
 344         if sb.kind == 0 {
 345                 sb.kind = sym.SNOPTRDATA
 346         }
 347         r := sb.size
 348         if sb.name == ".shstrtab" {
 349                 // FIXME: find a better mechanism for this
 350                 sb.l.elfsetstring(nil, str, int(r))
 351         }
 352         sb.data = append(sb.data, str...)
 353         sb.data = append(sb.data, 0)
 354         sb.size = int64(len(sb.data))
 355         return r
 356 }
 357
 358 func (sb *SymbolBuilder) addSymRef(tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 359         if sb.kind == 0 {
 360                 sb.kind = sym.SDATA
 361         }
 362         i := sb.size
 363
 364         sb.size += int64(rsize)
 365         sb.Grow(sb.size)
 366
 367         var r Reloc
 368         r.Sym = tgt
 369         r.Off = int32(i)
 370         r.Size = uint8(rsize)
 371         r.Type = typ
 372         r.Add = add
 373         sb.AddReloc(r)
 374
 375         return i + int64(r.Size)
 376 }
 377
 378 // Add a symbol reference (relocation) with given type, addend, and size
 379 // (the most generic form).
 380 func (sb *SymbolBuilder) AddSymRef(arch *sys.Arch, tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 381         sb.setReachable()
 382         return sb.addSymRef(tgt, add, typ, rsize)
 383 }
 384
 385 func (sb *SymbolBuilder) AddAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 386         sb.setReachable()
 387         return sb.addSymRef(tgt, add, objabi.R_ADDR, arch.PtrSize)
 388 }
 389
 390 func (sb *SymbolBuilder) AddAddrPlus4(arch *sys.Arch, tgt Sym, add int64) int64 {
 391         sb.setReachable()
 392         return sb.addSymRef(tgt, add, objabi.R_ADDR, 4)
 393 }
 394
 395 func (sb *SymbolBuilder) AddAddr(arch *sys.Arch, tgt Sym) int64 {
 396         return sb.AddAddrPlus(arch, tgt, 0)
 397 }
 398
 399 func (sb *SymbolBuilder) AddPCRelPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 400         sb.setReachable()
 401         return sb.addSymRef(tgt, add, objabi.R_PCREL, 4)
 402 }
 403
 404 func (sb *SymbolBuilder) AddCURelativeAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 405         sb.setReachable()
 406         return sb.addSymRef(tgt, add, objabi.R_ADDRCUOFF, arch.PtrSize)
 407 }
 408
 409 func (sb *SymbolBuilder) AddSize(arch *sys.Arch, tgt Sym) int64 {
 410         sb.setReachable()
 411         return sb.addSymRef(tgt, 0, objabi.R_SIZE, arch.PtrSize)
 412 }
 413
 414 // GenAddAddrPlusFunc returns a function to be called when capturing
 415 // a function symbol's address. In later stages of the link (when
 416 // address assignment is done) when doing internal linking and
 417 // targeting an executable, we can just emit the address of a function
 418 // directly instead of generating a relocation. Clients can call
 419 // this function (setting 'internalExec' based on build mode and target)
 420 // and then invoke the returned function in roughly the same way that
 421 // loader.*SymbolBuilder.AddAddrPlus would be used.
 422 func GenAddAddrPlusFunc(internalExec bool) func(s *SymbolBuilder, arch *sys.Arch, tgt Sym, add int64) int64 {
 423         if internalExec {
 424                 return func(s *SymbolBuilder, arch *sys.Arch, tgt Sym, add int64) int64 {
 425                         if v := s.l.SymValue(tgt); v != 0 {
 426                                 return s.AddUint(arch, uint64(v+add))
 427                         }
 428                         return s.AddAddrPlus(arch, tgt, add)
 429                 }
 430         } else {
 431                 return (*SymbolBuilder).AddAddrPlus
 432         }
 433 }