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