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/objabi"
   9         "cmd/internal/sys"
  10         "cmd/link/internal/sym"
  11         "fmt"
  12 )
  13
  14 // SymbolBuilder is a helper designed to help with the construction
  15 // of new symbol contents.
  16 type SymbolBuilder struct {
  17         *extSymPayload         // points to payload being updated
  18         symIdx         Sym     // index of symbol being updated/constructed
  19         l              *Loader // loader
  20 }
  21
  22 // MakeSymbolBuilder creates a symbol builder for use in constructing
  23 // an entirely new symbol.
  24 func (l *Loader) MakeSymbolBuilder(name string) *SymbolBuilder {
  25         // for now assume that any new sym is intended to be static
  26         symIdx := l.CreateStaticSym(name)
  27         if l.Syms[symIdx] != nil {
  28                 panic("can't build if sym.Symbol already present")
  29         }
  30         sb := &SymbolBuilder{l: l, symIdx: symIdx}
  31         sb.extSymPayload = l.getPayload(symIdx)
  32         return sb
  33 }
  34
  35 // MakeSymbolUpdater creates a symbol builder helper for an existing
  36 // symbol 'symIdx'. If 'symIdx' is not an external symbol, then create
  37 // a clone of it (copy name, properties, etc) fix things up so that
  38 // the lookup tables and caches point to the new version, not the old
  39 // version.
  40 func (l *Loader) MakeSymbolUpdater(symIdx Sym) *SymbolBuilder {
  41         if symIdx == 0 {
  42                 panic("can't update the null symbol")
  43         }
  44         if !l.IsExternal(symIdx) {
  45                 // Create a clone with the same name/version/kind etc.
  46                 l.cloneToExternal(symIdx)
  47         }
  48         // Now that we're doing phase 2 DWARF generation using the loader
  49         // but before the wavefront has reached dodata(), we can't have this
  50         // assertion here. Commented out for now.
  51         if false {
  52                 if l.Syms[symIdx] != nil {
  53                         panic(fmt.Sprintf("can't build if sym.Symbol %q already present", l.RawSymName(symIdx)))
  54                 }
  55         }
  56
  57         // Construct updater and return.
  58         sb := &SymbolBuilder{l: l, symIdx: symIdx}
  59         sb.extSymPayload = l.getPayload(symIdx)
  60         return sb
  61 }
  62
  63 // CreateSymForUpdate creates a symbol with given name and version,
  64 // returns a CreateSymForUpdate for update. If the symbol already
  65 // exists, it will update in-place.
  66 func (l *Loader) CreateSymForUpdate(name string, version int) *SymbolBuilder {
  67         return l.MakeSymbolUpdater(l.LookupOrCreateSym(name, version))
  68 }
  69
  70 // Getters for properties of the symbol we're working on.
  71
  72 func (sb *SymbolBuilder) Sym() Sym               { return sb.symIdx }
  73 func (sb *SymbolBuilder) Name() string           { return sb.name }
  74 func (sb *SymbolBuilder) Version() int           { return sb.ver }
  75 func (sb *SymbolBuilder) Type() sym.SymKind      { return sb.kind }
  76 func (sb *SymbolBuilder) Size() int64            { return sb.size }
  77 func (sb *SymbolBuilder) Data() []byte           { return sb.data }
  78 func (sb *SymbolBuilder) Value() int64           { return sb.l.SymValue(sb.symIdx) }
  79 func (sb *SymbolBuilder) Align() int32           { return sb.l.SymAlign(sb.symIdx) }
  80 func (sb *SymbolBuilder) Localentry() uint8      { return sb.l.SymLocalentry(sb.symIdx) }
  81 func (sb *SymbolBuilder) OnList() bool           { return sb.l.AttrOnList(sb.symIdx) }
  82 func (sb *SymbolBuilder) External() bool         { return sb.l.AttrExternal(sb.symIdx) }
  83 func (sb *SymbolBuilder) Extname() string        { return sb.l.SymExtname(sb.symIdx) }
  84 func (sb *SymbolBuilder) CgoExportDynamic() bool { return sb.l.AttrCgoExportDynamic(sb.symIdx) }
  85 func (sb *SymbolBuilder) Dynimplib() string      { return sb.l.SymDynimplib(sb.symIdx) }
  86 func (sb *SymbolBuilder) Dynimpvers() string     { return sb.l.SymDynimpvers(sb.symIdx) }
  87 func (sb *SymbolBuilder) SubSym() Sym            { return sb.l.SubSym(sb.symIdx) }
  88 func (sb *SymbolBuilder) GoType() Sym            { return sb.l.SymGoType(sb.symIdx) }
  89 func (sb *SymbolBuilder) VisibilityHidden() bool { return sb.l.AttrVisibilityHidden(sb.symIdx) }
  90
  91 // Setters for symbol properties.
  92
  93 func (sb *SymbolBuilder) SetType(kind sym.SymKind)   { sb.kind = kind }
  94 func (sb *SymbolBuilder) SetSize(size int64)         { sb.size = size }
  95 func (sb *SymbolBuilder) SetData(data []byte)        { sb.data = data }
  96 func (sb *SymbolBuilder) SetOnList(v bool)           { sb.l.SetAttrOnList(sb.symIdx, v) }
  97 func (sb *SymbolBuilder) SetExternal(v bool)         { sb.l.SetAttrExternal(sb.symIdx, v) }
  98 func (sb *SymbolBuilder) SetValue(v int64)           { sb.l.SetSymValue(sb.symIdx, v) }
  99 func (sb *SymbolBuilder) SetAlign(align int32)       { sb.l.SetSymAlign(sb.symIdx, align) }
 100 func (sb *SymbolBuilder) SetLocalentry(value uint8)  { sb.l.SetSymLocalentry(sb.symIdx, value) }
 101 func (sb *SymbolBuilder) SetExtname(value string)    { sb.l.SetSymExtname(sb.symIdx, value) }
 102 func (sb *SymbolBuilder) SetDynimplib(value string)  { sb.l.SetSymDynimplib(sb.symIdx, value) }
 103 func (sb *SymbolBuilder) SetDynimpvers(value string) { sb.l.SetSymDynimpvers(sb.symIdx, value) }
 104 func (sb *SymbolBuilder) SetPlt(value int32)         { sb.l.SetPlt(sb.symIdx, value) }
 105 func (sb *SymbolBuilder) SetGot(value int32)         { sb.l.SetGot(sb.symIdx, value) }
 106 func (sb *SymbolBuilder) SetSpecial(value bool)      { sb.l.SetAttrSpecial(sb.symIdx, value) }
 107 func (sb *SymbolBuilder) SetVisibilityHidden(value bool) {
 108         sb.l.SetAttrVisibilityHidden(sb.symIdx, value)
 109 }
 110
 111 func (sb *SymbolBuilder) SetNotInSymbolTable(value bool) {
 112         sb.l.SetAttrNotInSymbolTable(sb.symIdx, value)
 113 }
 114
 115 func (sb *SymbolBuilder) AddBytes(data []byte) {
 116         sb.setReachable()
 117         if sb.kind == 0 {
 118                 sb.kind = sym.SDATA
 119         }
 120         sb.data = append(sb.data, data...)
 121         sb.size = int64(len(sb.data))
 122 }
 123
 124 func (sb *SymbolBuilder) Relocs() []Reloc {
 125         return sb.relocs
 126 }
 127
 128 func (sb *SymbolBuilder) SetRelocs(rslice []Reloc) {
 129         sb.relocs = rslice
 130 }
 131
 132 func (sb *SymbolBuilder) WriteRelocs(rslice []Reloc) {
 133         if len(sb.relocs) != len(rslice) {
 134                 panic("src/dest length mismatch")
 135         }
 136         copy(sb.relocs, rslice)
 137 }
 138
 139 func (sb *SymbolBuilder) AddReloc(r Reloc) {
 140         sb.relocs = append(sb.relocs, r)
 141 }
 142
 143 func (sb *SymbolBuilder) Reachable() bool {
 144         return sb.l.AttrReachable(sb.symIdx)
 145 }
 146
 147 func (sb *SymbolBuilder) SetReachable(v bool) {
 148         sb.l.SetAttrReachable(sb.symIdx, v)
 149 }
 150
 151 func (sb *SymbolBuilder) setReachable() {
 152         sb.SetReachable(true)
 153 }
 154
 155 func (sb *SymbolBuilder) ReadOnly() bool {
 156         return sb.l.AttrReadOnly(sb.symIdx)
 157 }
 158
 159 func (sb *SymbolBuilder) SetReadOnly(v bool) {
 160         sb.l.SetAttrReadOnly(sb.symIdx, v)
 161 }
 162
 163 func (sb *SymbolBuilder) DuplicateOK() bool {
 164         return sb.l.AttrDuplicateOK(sb.symIdx)
 165 }
 166
 167 func (sb *SymbolBuilder) SetDuplicateOK(v bool) {
 168         sb.l.SetAttrDuplicateOK(sb.symIdx, v)
 169 }
 170
 171 func (sb *SymbolBuilder) Outer() Sym {
 172         return sb.l.OuterSym(sb.symIdx)
 173 }
 174
 175 func (sb *SymbolBuilder) Sub() Sym {
 176         return sb.l.SubSym(sb.symIdx)
 177 }
 178
 179 func (sb *SymbolBuilder) SortSub() {
 180         sb.l.SortSub(sb.symIdx)
 181 }
 182
 183 func (sb *SymbolBuilder) PrependSub(sub Sym) {
 184         sb.l.PrependSub(sb.symIdx, sub)
 185 }
 186
 187 func (sb *SymbolBuilder) AddUint8(v uint8) int64 {
 188         off := sb.size
 189         if sb.kind == 0 {
 190                 sb.kind = sym.SDATA
 191         }
 192         sb.setReachable()
 193         sb.size++
 194         sb.data = append(sb.data, v)
 195         return off
 196 }
 197
 198 func (sb *SymbolBuilder) AddUintXX(arch *sys.Arch, v uint64, wid int) int64 {
 199         off := sb.size
 200         sb.setReachable()
 201         sb.setUintXX(arch, off, v, int64(wid))
 202         return off
 203 }
 204
 205 func (sb *SymbolBuilder) setUintXX(arch *sys.Arch, off int64, v uint64, wid int64) int64 {
 206         if sb.kind == 0 {
 207                 sb.kind = sym.SDATA
 208         }
 209         if sb.size < off+wid {
 210                 sb.size = off + wid
 211                 sb.Grow(sb.size)
 212         }
 213
 214         switch wid {
 215         case 1:
 216                 sb.data[off] = uint8(v)
 217         case 2:
 218                 arch.ByteOrder.PutUint16(sb.data[off:], uint16(v))
 219         case 4:
 220                 arch.ByteOrder.PutUint32(sb.data[off:], uint32(v))
 221         case 8:
 222                 arch.ByteOrder.PutUint64(sb.data[off:], v)
 223         }
 224
 225         return off + wid
 226 }
 227
 228 func (sb *SymbolBuilder) AddUint16(arch *sys.Arch, v uint16) int64 {
 229         return sb.AddUintXX(arch, uint64(v), 2)
 230 }
 231
 232 func (sb *SymbolBuilder) AddUint32(arch *sys.Arch, v uint32) int64 {
 233         return sb.AddUintXX(arch, uint64(v), 4)
 234 }
 235
 236 func (sb *SymbolBuilder) AddUint64(arch *sys.Arch, v uint64) int64 {
 237         return sb.AddUintXX(arch, v, 8)
 238 }
 239
 240 func (sb *SymbolBuilder) AddUint(arch *sys.Arch, v uint64) int64 {
 241         return sb.AddUintXX(arch, v, arch.PtrSize)
 242 }
 243
 244 func (sb *SymbolBuilder) SetUint8(arch *sys.Arch, r int64, v uint8) int64 {
 245         sb.setReachable()
 246         return sb.setUintXX(arch, r, uint64(v), 1)
 247 }
 248
 249 func (sb *SymbolBuilder) SetUint16(arch *sys.Arch, r int64, v uint16) int64 {
 250         sb.setReachable()
 251         return sb.setUintXX(arch, r, uint64(v), 2)
 252 }
 253
 254 func (sb *SymbolBuilder) SetUint32(arch *sys.Arch, r int64, v uint32) int64 {
 255         sb.setReachable()
 256         return sb.setUintXX(arch, r, uint64(v), 4)
 257 }
 258
 259 func (sb *SymbolBuilder) SetUint(arch *sys.Arch, r int64, v uint64) int64 {
 260         sb.setReachable()
 261         return sb.setUintXX(arch, r, v, int64(arch.PtrSize))
 262 }
 263
 264 func (sb *SymbolBuilder) Addstring(str string) int64 {
 265         sb.setReachable()
 266         if sb.kind == 0 {
 267                 sb.kind = sym.SNOPTRDATA
 268         }
 269         r := sb.size
 270         if sb.name == ".shstrtab" {
 271                 // FIXME: find a better mechanism for this
 272                 sb.l.elfsetstring(nil, str, int(r))
 273         }
 274         sb.data = append(sb.data, str...)
 275         sb.data = append(sb.data, 0)
 276         sb.size = int64(len(sb.data))
 277         return r
 278 }
 279
 280 func (sb *SymbolBuilder) addRel() *Reloc {
 281         sb.relocs = append(sb.relocs, Reloc{})
 282         return &sb.relocs[len(sb.relocs)-1]
 283 }
 284
 285 func (sb *SymbolBuilder) addSymRef(tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 286         if sb.kind == 0 {
 287                 sb.kind = sym.SDATA
 288         }
 289         i := sb.size
 290
 291         sb.size += int64(rsize)
 292         sb.Grow(sb.size)
 293
 294         r := sb.addRel()
 295         r.Sym = tgt
 296         r.Off = int32(i)
 297         r.Size = uint8(rsize)
 298         r.Type = typ
 299         r.Add = add
 300
 301         return i + int64(r.Size)
 302 }
 303
 304 // Add a symbol reference (relocation) with given type, addend, and size
 305 // (the most generic form).
 306 func (sb *SymbolBuilder) AddSymRef(arch *sys.Arch, tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 307         sb.setReachable()
 308         return sb.addSymRef(tgt, add, typ, rsize)
 309 }
 310
 311 func (sb *SymbolBuilder) AddAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 312         sb.setReachable()
 313         return sb.addSymRef(tgt, add, objabi.R_ADDR, arch.PtrSize)
 314 }
 315
 316 func (sb *SymbolBuilder) AddAddrPlus4(arch *sys.Arch, tgt Sym, add int64) int64 {
 317         sb.setReachable()
 318         return sb.addSymRef(tgt, add, objabi.R_ADDR, 4)
 319 }
 320
 321 func (sb *SymbolBuilder) AddAddr(arch *sys.Arch, tgt Sym) int64 {
 322         return sb.AddAddrPlus(arch, tgt, 0)
 323 }
 324
 325 func (sb *SymbolBuilder) AddPCRelPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 326         sb.setReachable()
 327         return sb.addSymRef(tgt, add, objabi.R_PCREL, 4)
 328 }
 329
 330 func (sb *SymbolBuilder) AddCURelativeAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 331         sb.setReachable()
 332         return sb.addSymRef(tgt, add, objabi.R_ADDRCUOFF, arch.PtrSize)
 333 }
 334
 335 func (sb *SymbolBuilder) AddSize(arch *sys.Arch, tgt Sym) int64 {
 336         sb.setReachable()
 337         return sb.addSymRef(tgt, 0, objabi.R_SIZE, arch.PtrSize)
 338 }