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) SetVisibilityHidden(value bool) {
 111         sb.l.SetAttrVisibilityHidden(sb.symIdx, value)
 112 }
 113 func (sb *SymbolBuilder) SetNotInSymbolTable(value bool) {
 114         sb.l.SetAttrNotInSymbolTable(sb.symIdx, value)
 115 }
 116 func (sb *SymbolBuilder) SetSect(sect *sym.Section) { sb.l.SetSymSect(sb.symIdx, sect) }
 117
 118 func (sb *SymbolBuilder) AddBytes(data []byte) {
 119         sb.setReachable()
 120         if sb.kind == 0 {
 121                 sb.kind = sym.SDATA
 122         }
 123         sb.data = append(sb.data, data...)
 124         sb.size = int64(len(sb.data))
 125 }
 126
 127 func (sb *SymbolBuilder) Relocs() Relocs {
 128         return sb.l.Relocs(sb.symIdx)
 129 }
 130
 131 func (sb *SymbolBuilder) SetRelocs(rslice []Reloc) {
 132         n := len(rslice)
 133         if cap(sb.relocs) < n {
 134                 sb.relocs = make([]goobj2.Reloc2, n)
 135                 sb.reltypes = make([]objabi.RelocType, n)
 136         } else {
 137                 sb.relocs = sb.relocs[:n]
 138                 sb.reltypes = sb.reltypes[:n]
 139         }
 140         for i := range rslice {
 141                 sb.SetReloc(i, rslice[i])
 142         }
 143 }
 144
 145 // Add n relocations, return a handle to the relocations.
 146 func (sb *SymbolBuilder) AddRelocs(n int) Relocs {
 147         sb.relocs = append(sb.relocs, make([]goobj2.Reloc2, n)...)
 148         sb.reltypes = append(sb.reltypes, make([]objabi.RelocType, n)...)
 149         return sb.l.Relocs(sb.symIdx)
 150 }
 151
 152 // Add a relocation with given type, return its handle and index
 153 // (to set other fields).
 154 func (sb *SymbolBuilder) AddRel(typ objabi.RelocType) (Reloc2, int) {
 155         j := len(sb.relocs)
 156         sb.relocs = append(sb.relocs, goobj2.Reloc2{})
 157         sb.reltypes = append(sb.reltypes, typ)
 158         relocs := sb.Relocs()
 159         return relocs.At2(j), j
 160 }
 161
 162 // Sort relocations by offset.
 163 func (sb *SymbolBuilder) SortRelocs() {
 164         sort.Sort((*relocsByOff)(sb.extSymPayload))
 165 }
 166
 167 // Implement sort.Interface
 168 type relocsByOff extSymPayload
 169
 170 func (p *relocsByOff) Len() int           { return len(p.relocs) }
 171 func (p *relocsByOff) Less(i, j int) bool { return p.relocs[i].Off() < p.relocs[j].Off() }
 172 func (p *relocsByOff) Swap(i, j int) {
 173         p.relocs[i], p.relocs[j] = p.relocs[j], p.relocs[i]
 174         p.reltypes[i], p.reltypes[j] = p.reltypes[j], p.reltypes[i]
 175 }
 176
 177 // AddReloc appends the specified reloc to the symbols list of
 178 // relocations. Return value is the index of the newly created
 179 // reloc.
 180 func (sb *SymbolBuilder) AddReloc(r Reloc) uint32 {
 181         // Populate a goobj2.Reloc from external reloc record.
 182         rval := uint32(len(sb.relocs))
 183         var b goobj2.Reloc2
 184         b.Set(r.Off, r.Size, 0, r.Add, goobj2.SymRef{PkgIdx: 0, SymIdx: uint32(r.Sym)})
 185         sb.relocs = append(sb.relocs, b)
 186         sb.reltypes = append(sb.reltypes, r.Type)
 187         return rval
 188 }
 189
 190 // Update the j-th relocation in place.
 191 func (sb *SymbolBuilder) SetReloc(j int, r Reloc) {
 192         // Populate a goobj2.Reloc from external reloc record.
 193         sb.relocs[j].Set(r.Off, r.Size, 0, r.Add, goobj2.SymRef{PkgIdx: 0, SymIdx: uint32(r.Sym)})
 194         sb.reltypes[j] = r.Type
 195 }
 196
 197 func (sb *SymbolBuilder) Reachable() bool {
 198         return sb.l.AttrReachable(sb.symIdx)
 199 }
 200
 201 func (sb *SymbolBuilder) SetReachable(v bool) {
 202         sb.l.SetAttrReachable(sb.symIdx, v)
 203 }
 204
 205 func (sb *SymbolBuilder) setReachable() {
 206         sb.SetReachable(true)
 207 }
 208
 209 func (sb *SymbolBuilder) ReadOnly() bool {
 210         return sb.l.AttrReadOnly(sb.symIdx)
 211 }
 212
 213 func (sb *SymbolBuilder) SetReadOnly(v bool) {
 214         sb.l.SetAttrReadOnly(sb.symIdx, v)
 215 }
 216
 217 func (sb *SymbolBuilder) DuplicateOK() bool {
 218         return sb.l.AttrDuplicateOK(sb.symIdx)
 219 }
 220
 221 func (sb *SymbolBuilder) SetDuplicateOK(v bool) {
 222         sb.l.SetAttrDuplicateOK(sb.symIdx, v)
 223 }
 224
 225 func (sb *SymbolBuilder) Outer() Sym {
 226         return sb.l.OuterSym(sb.symIdx)
 227 }
 228
 229 func (sb *SymbolBuilder) Sub() Sym {
 230         return sb.l.SubSym(sb.symIdx)
 231 }
 232
 233 func (sb *SymbolBuilder) SortSub() {
 234         sb.l.SortSub(sb.symIdx)
 235 }
 236
 237 func (sb *SymbolBuilder) PrependSub(sub Sym) {
 238         sb.l.PrependSub(sb.symIdx, sub)
 239 }
 240
 241 func (sb *SymbolBuilder) AddUint8(v uint8) int64 {
 242         off := sb.size
 243         if sb.kind == 0 {
 244                 sb.kind = sym.SDATA
 245         }
 246         sb.setReachable()
 247         sb.size++
 248         sb.data = append(sb.data, v)
 249         return off
 250 }
 251
 252 func (sb *SymbolBuilder) AddUintXX(arch *sys.Arch, v uint64, wid int) int64 {
 253         off := sb.size
 254         sb.setReachable()
 255         sb.setUintXX(arch, off, v, int64(wid))
 256         return off
 257 }
 258
 259 func (sb *SymbolBuilder) setUintXX(arch *sys.Arch, off int64, v uint64, wid int64) int64 {
 260         if sb.kind == 0 {
 261                 sb.kind = sym.SDATA
 262         }
 263         if sb.size < off+wid {
 264                 sb.size = off + wid
 265                 sb.Grow(sb.size)
 266         }
 267
 268         switch wid {
 269         case 1:
 270                 sb.data[off] = uint8(v)
 271         case 2:
 272                 arch.ByteOrder.PutUint16(sb.data[off:], uint16(v))
 273         case 4:
 274                 arch.ByteOrder.PutUint32(sb.data[off:], uint32(v))
 275         case 8:
 276                 arch.ByteOrder.PutUint64(sb.data[off:], v)
 277         }
 278
 279         return off + wid
 280 }
 281
 282 func (sb *SymbolBuilder) AddUint16(arch *sys.Arch, v uint16) int64 {
 283         return sb.AddUintXX(arch, uint64(v), 2)
 284 }
 285
 286 func (sb *SymbolBuilder) AddUint32(arch *sys.Arch, v uint32) int64 {
 287         return sb.AddUintXX(arch, uint64(v), 4)
 288 }
 289
 290 func (sb *SymbolBuilder) AddUint64(arch *sys.Arch, v uint64) int64 {
 291         return sb.AddUintXX(arch, v, 8)
 292 }
 293
 294 func (sb *SymbolBuilder) AddUint(arch *sys.Arch, v uint64) int64 {
 295         return sb.AddUintXX(arch, v, arch.PtrSize)
 296 }
 297
 298 func (sb *SymbolBuilder) SetUint8(arch *sys.Arch, r int64, v uint8) int64 {
 299         sb.setReachable()
 300         return sb.setUintXX(arch, r, uint64(v), 1)
 301 }
 302
 303 func (sb *SymbolBuilder) SetUint16(arch *sys.Arch, r int64, v uint16) int64 {
 304         sb.setReachable()
 305         return sb.setUintXX(arch, r, uint64(v), 2)
 306 }
 307
 308 func (sb *SymbolBuilder) SetUint32(arch *sys.Arch, r int64, v uint32) int64 {
 309         sb.setReachable()
 310         return sb.setUintXX(arch, r, uint64(v), 4)
 311 }
 312
 313 func (sb *SymbolBuilder) SetUint(arch *sys.Arch, r int64, v uint64) int64 {
 314         sb.setReachable()
 315         return sb.setUintXX(arch, r, v, int64(arch.PtrSize))
 316 }
 317
 318 func (sb *SymbolBuilder) Addstring(str string) int64 {
 319         sb.setReachable()
 320         if sb.kind == 0 {
 321                 sb.kind = sym.SNOPTRDATA
 322         }
 323         r := sb.size
 324         if sb.name == ".shstrtab" {
 325                 // FIXME: find a better mechanism for this
 326                 sb.l.elfsetstring(nil, str, int(r))
 327         }
 328         sb.data = append(sb.data, str...)
 329         sb.data = append(sb.data, 0)
 330         sb.size = int64(len(sb.data))
 331         return r
 332 }
 333
 334 func (sb *SymbolBuilder) addSymRef(tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 335         if sb.kind == 0 {
 336                 sb.kind = sym.SDATA
 337         }
 338         i := sb.size
 339
 340         sb.size += int64(rsize)
 341         sb.Grow(sb.size)
 342
 343         var r Reloc
 344         r.Sym = tgt
 345         r.Off = int32(i)
 346         r.Size = uint8(rsize)
 347         r.Type = typ
 348         r.Add = add
 349         sb.AddReloc(r)
 350
 351         return i + int64(r.Size)
 352 }
 353
 354 // Add a symbol reference (relocation) with given type, addend, and size
 355 // (the most generic form).
 356 func (sb *SymbolBuilder) AddSymRef(arch *sys.Arch, tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 357         sb.setReachable()
 358         return sb.addSymRef(tgt, add, typ, rsize)
 359 }
 360
 361 func (sb *SymbolBuilder) AddAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 362         sb.setReachable()
 363         return sb.addSymRef(tgt, add, objabi.R_ADDR, arch.PtrSize)
 364 }
 365
 366 func (sb *SymbolBuilder) AddAddrPlus4(arch *sys.Arch, tgt Sym, add int64) int64 {
 367         sb.setReachable()
 368         return sb.addSymRef(tgt, add, objabi.R_ADDR, 4)
 369 }
 370
 371 func (sb *SymbolBuilder) AddAddr(arch *sys.Arch, tgt Sym) int64 {
 372         return sb.AddAddrPlus(arch, tgt, 0)
 373 }
 374
 375 func (sb *SymbolBuilder) AddPCRelPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 376         sb.setReachable()
 377         return sb.addSymRef(tgt, add, objabi.R_PCREL, 4)
 378 }
 379
 380 func (sb *SymbolBuilder) AddCURelativeAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 381         sb.setReachable()
 382         return sb.addSymRef(tgt, add, objabi.R_ADDRCUOFF, arch.PtrSize)
 383 }
 384
 385 func (sb *SymbolBuilder) AddSize(arch *sys.Arch, tgt Sym) int64 {
 386         sb.setReachable()
 387         return sb.addSymRef(tgt, 0, objabi.R_SIZE, arch.PtrSize)
 388 }