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/goobj"
   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 // ResetRelocs removes all relocations on this symbol.
 122 func (sb *SymbolBuilder) ResetRelocs() {
 123         sb.relocs = sb.relocs[:0]
 124         sb.reltypes = sb.reltypes[:0]
 125 }
 126
 127 // SetRelocType sets the type of the 'i'-th relocation on this sym to 't'
 128 func (sb *SymbolBuilder) SetRelocType(i int, t objabi.RelocType) {
 129         sb.relocs[i].SetType(0)
 130         sb.reltypes[i] = t
 131 }
 132
 133 // SetRelocSym sets the target sym of the 'i'-th relocation on this sym to 's'
 134 func (sb *SymbolBuilder) SetRelocSym(i int, tgt Sym) {
 135         sb.relocs[i].SetSym(goobj.SymRef{PkgIdx: 0, SymIdx: uint32(tgt)})
 136 }
 137
 138 // SetRelocAdd sets the addend of the 'i'-th relocation on this sym to 'a'
 139 func (sb *SymbolBuilder) SetRelocAdd(i int, a int64) {
 140         sb.relocs[i].SetAdd(a)
 141 }
 142
 143 // Add n relocations, return a handle to the relocations.
 144 func (sb *SymbolBuilder) AddRelocs(n int) Relocs {
 145         sb.relocs = append(sb.relocs, make([]goobj.Reloc, n)...)
 146         sb.reltypes = append(sb.reltypes, make([]objabi.RelocType, n)...)
 147         return sb.l.Relocs(sb.symIdx)
 148 }
 149
 150 // Add a relocation with given type, return its handle and index
 151 // (to set other fields).
 152 func (sb *SymbolBuilder) AddRel(typ objabi.RelocType) (Reloc, int) {
 153         j := len(sb.relocs)
 154         sb.relocs = append(sb.relocs, goobj.Reloc{})
 155         sb.reltypes = append(sb.reltypes, typ)
 156         relocs := sb.Relocs()
 157         return relocs.At(j), j
 158 }
 159
 160 // Sort relocations by offset.
 161 func (sb *SymbolBuilder) SortRelocs() {
 162         sort.Sort((*relocsByOff)(sb.extSymPayload))
 163 }
 164
 165 // Implement sort.Interface
 166 type relocsByOff extSymPayload
 167
 168 func (p *relocsByOff) Len() int           { return len(p.relocs) }
 169 func (p *relocsByOff) Less(i, j int) bool { return p.relocs[i].Off() < p.relocs[j].Off() }
 170 func (p *relocsByOff) Swap(i, j int) {
 171         p.relocs[i], p.relocs[j] = p.relocs[j], p.relocs[i]
 172         p.reltypes[i], p.reltypes[j] = p.reltypes[j], p.reltypes[i]
 173 }
 174
 175 func (sb *SymbolBuilder) Reachable() bool {
 176         return sb.l.AttrReachable(sb.symIdx)
 177 }
 178
 179 func (sb *SymbolBuilder) SetReachable(v bool) {
 180         sb.l.SetAttrReachable(sb.symIdx, v)
 181 }
 182
 183 func (sb *SymbolBuilder) setReachable() {
 184         sb.SetReachable(true)
 185 }
 186
 187 func (sb *SymbolBuilder) ReadOnly() bool {
 188         return sb.l.AttrReadOnly(sb.symIdx)
 189 }
 190
 191 func (sb *SymbolBuilder) SetReadOnly(v bool) {
 192         sb.l.SetAttrReadOnly(sb.symIdx, v)
 193 }
 194
 195 func (sb *SymbolBuilder) DuplicateOK() bool {
 196         return sb.l.AttrDuplicateOK(sb.symIdx)
 197 }
 198
 199 func (sb *SymbolBuilder) SetDuplicateOK(v bool) {
 200         sb.l.SetAttrDuplicateOK(sb.symIdx, v)
 201 }
 202
 203 func (sb *SymbolBuilder) Outer() Sym {
 204         return sb.l.OuterSym(sb.symIdx)
 205 }
 206
 207 func (sb *SymbolBuilder) Sub() Sym {
 208         return sb.l.SubSym(sb.symIdx)
 209 }
 210
 211 func (sb *SymbolBuilder) SortSub() {
 212         sb.l.SortSub(sb.symIdx)
 213 }
 214
 215 func (sb *SymbolBuilder) AddInteriorSym(sub Sym) {
 216         sb.l.AddInteriorSym(sb.symIdx, sub)
 217 }
 218
 219 func (sb *SymbolBuilder) AddUint8(v uint8) int64 {
 220         off := sb.size
 221         if sb.kind == 0 {
 222                 sb.kind = sym.SDATA
 223         }
 224         sb.size++
 225         sb.data = append(sb.data, v)
 226         return off
 227 }
 228
 229 func (sb *SymbolBuilder) AddUintXX(arch *sys.Arch, v uint64, wid int) int64 {
 230         off := sb.size
 231         sb.setUintXX(arch, off, v, int64(wid))
 232         return off
 233 }
 234
 235 func (sb *SymbolBuilder) setUintXX(arch *sys.Arch, off int64, v uint64, wid int64) int64 {
 236         if sb.kind == 0 {
 237                 sb.kind = sym.SDATA
 238         }
 239         if sb.size < off+wid {
 240                 sb.size = off + wid
 241                 sb.Grow(sb.size)
 242         }
 243
 244         switch wid {
 245         case 1:
 246                 sb.data[off] = uint8(v)
 247         case 2:
 248                 arch.ByteOrder.PutUint16(sb.data[off:], uint16(v))
 249         case 4:
 250                 arch.ByteOrder.PutUint32(sb.data[off:], uint32(v))
 251         case 8:
 252                 arch.ByteOrder.PutUint64(sb.data[off:], v)
 253         }
 254
 255         return off + wid
 256 }
 257
 258 func (sb *SymbolBuilder) AddUint16(arch *sys.Arch, v uint16) int64 {
 259         return sb.AddUintXX(arch, uint64(v), 2)
 260 }
 261
 262 func (sb *SymbolBuilder) AddUint32(arch *sys.Arch, v uint32) int64 {
 263         return sb.AddUintXX(arch, uint64(v), 4)
 264 }
 265
 266 func (sb *SymbolBuilder) AddUint64(arch *sys.Arch, v uint64) int64 {
 267         return sb.AddUintXX(arch, v, 8)
 268 }
 269
 270 func (sb *SymbolBuilder) AddUint(arch *sys.Arch, v uint64) int64 {
 271         return sb.AddUintXX(arch, v, arch.PtrSize)
 272 }
 273
 274 func (sb *SymbolBuilder) SetUint8(arch *sys.Arch, r int64, v uint8) int64 {
 275         return sb.setUintXX(arch, r, uint64(v), 1)
 276 }
 277
 278 func (sb *SymbolBuilder) SetUint16(arch *sys.Arch, r int64, v uint16) int64 {
 279         return sb.setUintXX(arch, r, uint64(v), 2)
 280 }
 281
 282 func (sb *SymbolBuilder) SetUint32(arch *sys.Arch, r int64, v uint32) int64 {
 283         return sb.setUintXX(arch, r, uint64(v), 4)
 284 }
 285
 286 func (sb *SymbolBuilder) SetUint(arch *sys.Arch, r int64, v uint64) int64 {
 287         return sb.setUintXX(arch, r, v, int64(arch.PtrSize))
 288 }
 289
 290 func (sb *SymbolBuilder) SetUintptr(arch *sys.Arch, r int64, v uintptr) int64 {
 291         return sb.setUintXX(arch, r, uint64(v), int64(arch.PtrSize))
 292 }
 293
 294 func (sb *SymbolBuilder) SetAddrPlus(arch *sys.Arch, off int64, tgt Sym, add int64) int64 {
 295         if sb.Type() == 0 {
 296                 sb.SetType(sym.SDATA)
 297         }
 298         if off+int64(arch.PtrSize) > sb.size {
 299                 sb.size = off + int64(arch.PtrSize)
 300                 sb.Grow(sb.size)
 301         }
 302         r, _ := sb.AddRel(objabi.R_ADDR)
 303         r.SetSym(tgt)
 304         r.SetOff(int32(off))
 305         r.SetSiz(uint8(arch.PtrSize))
 306         r.SetAdd(add)
 307         return off + int64(r.Siz())
 308 }
 309
 310 func (sb *SymbolBuilder) SetAddr(arch *sys.Arch, off int64, tgt Sym) int64 {
 311         return sb.SetAddrPlus(arch, off, tgt, 0)
 312 }
 313
 314 func (sb *SymbolBuilder) AddStringAt(off int64, str string) int64 {
 315         strLen := int64(len(str))
 316         if off+strLen+1 > int64(len(sb.data)) {
 317                 panic("attempt to write past end of buffer")
 318         }
 319         copy(sb.data[off:off+strLen], str)
 320         sb.data[off+strLen] = 0
 321         return off + strLen + 1
 322 }
 323
 324 func (sb *SymbolBuilder) Addstring(str string) int64 {
 325         if sb.kind == 0 {
 326                 sb.kind = sym.SNOPTRDATA
 327         }
 328         r := sb.size
 329         if sb.name == ".shstrtab" {
 330                 // FIXME: find a better mechanism for this
 331                 sb.l.elfsetstring(str, int(r))
 332         }
 333         sb.data = append(sb.data, str...)
 334         sb.data = append(sb.data, 0)
 335         sb.size = int64(len(sb.data))
 336         return r
 337 }
 338
 339 func (sb *SymbolBuilder) SetBytesAt(off int64, b []byte) int64 {
 340         datLen := int64(len(b))
 341         if off+datLen > int64(len(sb.data)) {
 342                 panic("attempt to write past end of buffer")
 343         }
 344         copy(sb.data[off:off+datLen], b)
 345         return off + datLen
 346 }
 347
 348 func (sb *SymbolBuilder) addSymRef(tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 349         if sb.kind == 0 {
 350                 sb.kind = sym.SDATA
 351         }
 352         i := sb.size
 353
 354         sb.size += int64(rsize)
 355         sb.Grow(sb.size)
 356
 357         r, _ := sb.AddRel(typ)
 358         r.SetSym(tgt)
 359         r.SetOff(int32(i))
 360         r.SetSiz(uint8(rsize))
 361         r.SetAdd(add)
 362
 363         return i + int64(rsize)
 364 }
 365
 366 // Add a symbol reference (relocation) with given type, addend, and size
 367 // (the most generic form).
 368 func (sb *SymbolBuilder) AddSymRef(arch *sys.Arch, tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 369         return sb.addSymRef(tgt, add, typ, rsize)
 370 }
 371
 372 func (sb *SymbolBuilder) AddAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 373         return sb.addSymRef(tgt, add, objabi.R_ADDR, arch.PtrSize)
 374 }
 375
 376 func (sb *SymbolBuilder) AddAddrPlus4(arch *sys.Arch, tgt Sym, add int64) int64 {
 377         return sb.addSymRef(tgt, add, objabi.R_ADDR, 4)
 378 }
 379
 380 func (sb *SymbolBuilder) AddAddr(arch *sys.Arch, tgt Sym) int64 {
 381         return sb.AddAddrPlus(arch, tgt, 0)
 382 }
 383
 384 func (sb *SymbolBuilder) AddPCRelPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 385         return sb.addSymRef(tgt, add, objabi.R_PCREL, 4)
 386 }
 387
 388 func (sb *SymbolBuilder) AddCURelativeAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 389         return sb.addSymRef(tgt, add, objabi.R_ADDRCUOFF, arch.PtrSize)
 390 }
 391
 392 func (sb *SymbolBuilder) AddSize(arch *sys.Arch, tgt Sym) int64 {
 393         return sb.addSymRef(tgt, 0, objabi.R_SIZE, arch.PtrSize)
 394 }
 395
 396 // GenAddAddrPlusFunc returns a function to be called when capturing
 397 // a function symbol's address. In later stages of the link (when
 398 // address assignment is done) when doing internal linking and
 399 // targeting an executable, we can just emit the address of a function
 400 // directly instead of generating a relocation. Clients can call
 401 // this function (setting 'internalExec' based on build mode and target)
 402 // and then invoke the returned function in roughly the same way that
 403 // loader.*SymbolBuilder.AddAddrPlus would be used.
 404 func GenAddAddrPlusFunc(internalExec bool) func(s *SymbolBuilder, arch *sys.Arch, tgt Sym, add int64) int64 {
 405         if internalExec {
 406                 return func(s *SymbolBuilder, arch *sys.Arch, tgt Sym, add int64) int64 {
 407                         if v := s.l.SymValue(tgt); v != 0 {
 408                                 return s.AddUint(arch, uint64(v+add))
 409                         }
 410                         return s.AddAddrPlus(arch, tgt, add)
 411                 }
 412         } else {
 413                 return (*SymbolBuilder).AddAddrPlus
 414         }
 415 }
 416
 417 func (sb *SymbolBuilder) MakeWritable() {
 418         if sb.ReadOnly() {
 419                 sb.data = append([]byte(nil), sb.data...)
 420                 sb.l.SetAttrReadOnly(sb.symIdx, false)
 421         }
 422 }