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.CreateExtSym(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         if l.Syms[symIdx] != nil {
  49                 panic(fmt.Sprintf("can't build if sym.Symbol %q already present", l.RawSymName(symIdx)))
  50         }
  51
  52         // Construct updater and return.
  53         sb := &SymbolBuilder{l: l, symIdx: symIdx}
  54         sb.extSymPayload = l.getPayload(symIdx)
  55         return sb
  56 }
  57
  58 // Getters for properties of the symbol we're working on.
  59
  60 func (sb *SymbolBuilder) Sym() Sym               { return sb.symIdx }
  61 func (sb *SymbolBuilder) Name() string           { return sb.name }
  62 func (sb *SymbolBuilder) Version() int           { return sb.ver }
  63 func (sb *SymbolBuilder) Type() sym.SymKind      { return sb.kind }
  64 func (sb *SymbolBuilder) Size() int64            { return sb.size }
  65 func (sb *SymbolBuilder) Data() []byte           { return sb.data }
  66 func (sb *SymbolBuilder) Value() int64           { return sb.l.SymValue(sb.symIdx) }
  67 func (sb *SymbolBuilder) Align() int32           { return sb.l.SymAlign(sb.symIdx) }
  68 func (sb *SymbolBuilder) Localentry() uint8      { return sb.l.SymLocalentry(sb.symIdx) }
  69 func (sb *SymbolBuilder) OnList() bool           { return sb.l.AttrOnList(sb.symIdx) }
  70 func (sb *SymbolBuilder) External() bool         { return sb.l.AttrExternal(sb.symIdx) }
  71 func (sb *SymbolBuilder) Extname() string        { return sb.l.SymExtname(sb.symIdx) }
  72 func (sb *SymbolBuilder) CgoExportDynamic() bool { return sb.l.AttrCgoExportDynamic(sb.symIdx) }
  73 func (sb *SymbolBuilder) Dynimplib() string      { return sb.l.SymDynimplib(sb.symIdx) }
  74 func (sb *SymbolBuilder) Dynimpvers() string     { return sb.l.SymDynimpvers(sb.symIdx) }
  75 func (sb *SymbolBuilder) SubSym() Sym            { return sb.l.SubSym(sb.symIdx) }
  76 func (sb *SymbolBuilder) GoType() Sym            { return sb.l.SymGoType(sb.symIdx) }
  77
  78 // Setters for symbol properties.
  79
  80 func (sb *SymbolBuilder) SetType(kind sym.SymKind)   { sb.kind = kind }
  81 func (sb *SymbolBuilder) SetSize(size int64)         { sb.size = size }
  82 func (sb *SymbolBuilder) SetData(data []byte)        { sb.data = data }
  83 func (sb *SymbolBuilder) SetOnList(v bool)           { sb.l.SetAttrOnList(sb.symIdx, v) }
  84 func (sb *SymbolBuilder) SetExternal(v bool)         { sb.l.SetAttrExternal(sb.symIdx, v) }
  85 func (sb *SymbolBuilder) SetValue(v int64)           { sb.l.SetSymValue(sb.symIdx, v) }
  86 func (sb *SymbolBuilder) SetAlign(align int32)       { sb.l.SetSymAlign(sb.symIdx, align) }
  87 func (sb *SymbolBuilder) SetLocalentry(value uint8)  { sb.l.SetSymLocalentry(sb.symIdx, value) }
  88 func (sb *SymbolBuilder) SetExtname(value string)    { sb.l.SetSymExtname(sb.symIdx, value) }
  89 func (sb *SymbolBuilder) SetDynimplib(value string)  { sb.l.SetSymDynimplib(sb.symIdx, value) }
  90 func (sb *SymbolBuilder) SetDynimpvers(value string) { sb.l.SetSymDynimpvers(sb.symIdx, value) }
  91 func (sb *SymbolBuilder) SetPlt(value int32)         { sb.l.SetPlt(sb.symIdx, value) }
  92 func (sb *SymbolBuilder) SetGot(value int32)         { sb.l.SetGot(sb.symIdx, value) }
  93 func (sb *SymbolBuilder) SetSpecial(value bool)      { sb.l.SetAttrSpecial(sb.symIdx, value) }
  94
  95 func (sb *SymbolBuilder) SetNotInSymbolTable(value bool) {
  96         sb.l.SetAttrNotInSymbolTable(sb.symIdx, value)
  97 }
  98
  99 func (sb *SymbolBuilder) AddBytes(data []byte) {
 100         sb.setReachable()
 101         if sb.kind == 0 {
 102                 sb.kind = sym.SDATA
 103         }
 104         sb.data = append(sb.data, data...)
 105         sb.size = int64(len(sb.data))
 106 }
 107
 108 func (sb *SymbolBuilder) Relocs() []Reloc {
 109         return sb.relocs
 110 }
 111
 112 func (sb *SymbolBuilder) SetRelocs(rslice []Reloc) {
 113         sb.relocs = rslice
 114 }
 115
 116 func (sb *SymbolBuilder) AddReloc(r Reloc) {
 117         sb.relocs = append(sb.relocs, r)
 118 }
 119
 120 func (sb *SymbolBuilder) Reachable() bool {
 121         return sb.l.AttrReachable(sb.symIdx)
 122 }
 123
 124 func (sb *SymbolBuilder) setReachable() {
 125         sb.l.SetAttrReachable(sb.symIdx, true)
 126 }
 127
 128 func (sb *SymbolBuilder) ReadOnly() bool {
 129         return sb.l.AttrReadOnly(sb.symIdx)
 130 }
 131
 132 func (sb *SymbolBuilder) SetReadOnly(v bool) {
 133         sb.l.SetAttrReadOnly(sb.symIdx, v)
 134 }
 135
 136 func (sb *SymbolBuilder) DuplicateOK() bool {
 137         return sb.l.AttrDuplicateOK(sb.symIdx)
 138 }
 139
 140 func (sb *SymbolBuilder) SetDuplicateOK(v bool) {
 141         sb.l.SetAttrDuplicateOK(sb.symIdx, v)
 142 }
 143
 144 func (sb *SymbolBuilder) Outer() Sym {
 145         return sb.l.OuterSym(sb.symIdx)
 146 }
 147
 148 func (sb *SymbolBuilder) Sub() Sym {
 149         return sb.l.SubSym(sb.symIdx)
 150 }
 151
 152 func (sb *SymbolBuilder) SortSub() {
 153         sb.l.SortSub(sb.symIdx)
 154 }
 155
 156 func (sb *SymbolBuilder) PrependSub(sub Sym) {
 157         sb.l.PrependSub(sb.symIdx, sub)
 158 }
 159
 160 func (sb *SymbolBuilder) AddUint8(v uint8) int64 {
 161         off := sb.size
 162         if sb.kind == 0 {
 163                 sb.kind = sym.SDATA
 164         }
 165         sb.setReachable()
 166         sb.size++
 167         sb.data = append(sb.data, v)
 168         return off
 169 }
 170
 171 func (sb *SymbolBuilder) AddUintXX(arch *sys.Arch, v uint64, wid int) int64 {
 172         off := sb.size
 173         sb.setReachable()
 174         sb.setUintXX(arch, off, v, int64(wid))
 175         return off
 176 }
 177
 178 func (sb *SymbolBuilder) setUintXX(arch *sys.Arch, off int64, v uint64, wid int64) int64 {
 179         if sb.kind == 0 {
 180                 sb.kind = sym.SDATA
 181         }
 182         if sb.size < off+wid {
 183                 sb.size = off + wid
 184                 sb.Grow(sb.size)
 185         }
 186
 187         switch wid {
 188         case 1:
 189                 sb.data[off] = uint8(v)
 190         case 2:
 191                 arch.ByteOrder.PutUint16(sb.data[off:], uint16(v))
 192         case 4:
 193                 arch.ByteOrder.PutUint32(sb.data[off:], uint32(v))
 194         case 8:
 195                 arch.ByteOrder.PutUint64(sb.data[off:], v)
 196         }
 197
 198         return off + wid
 199 }
 200
 201 func (sb *SymbolBuilder) AddUint16(arch *sys.Arch, v uint16) int64 {
 202         return sb.AddUintXX(arch, uint64(v), 2)
 203 }
 204
 205 func (sb *SymbolBuilder) AddUint32(arch *sys.Arch, v uint32) int64 {
 206         return sb.AddUintXX(arch, uint64(v), 4)
 207 }
 208
 209 func (sb *SymbolBuilder) AddUint64(arch *sys.Arch, v uint64) int64 {
 210         return sb.AddUintXX(arch, v, 8)
 211 }
 212
 213 func (sb *SymbolBuilder) AddUint(arch *sys.Arch, v uint64) int64 {
 214         return sb.AddUintXX(arch, v, arch.PtrSize)
 215 }
 216
 217 func (sb *SymbolBuilder) SetUint8(arch *sys.Arch, r int64, v uint8) int64 {
 218         sb.setReachable()
 219         return sb.setUintXX(arch, r, uint64(v), 1)
 220 }
 221
 222 func (sb *SymbolBuilder) SetUint16(arch *sys.Arch, r int64, v uint16) int64 {
 223         sb.setReachable()
 224         return sb.setUintXX(arch, r, uint64(v), 2)
 225 }
 226
 227 func (sb *SymbolBuilder) SetUint32(arch *sys.Arch, r int64, v uint32) int64 {
 228         sb.setReachable()
 229         return sb.setUintXX(arch, r, uint64(v), 4)
 230 }
 231
 232 func (sb *SymbolBuilder) SetUint(arch *sys.Arch, r int64, v uint64) int64 {
 233         sb.setReachable()
 234         return sb.setUintXX(arch, r, v, int64(arch.PtrSize))
 235 }
 236
 237 func (sb *SymbolBuilder) Addstring(str string) int64 {
 238         sb.setReachable()
 239         if sb.kind == 0 {
 240                 sb.kind = sym.SNOPTRDATA
 241         }
 242         r := sb.size
 243         if sb.name == ".shstrtab" {
 244                 // FIXME: find a better mechanism for this
 245                 sb.l.elfsetstring(nil, str, int(r))
 246         }
 247         sb.data = append(sb.data, str...)
 248         sb.data = append(sb.data, 0)
 249         sb.size = int64(len(sb.data))
 250         return r
 251 }
 252
 253 func (sb *SymbolBuilder) addRel() *Reloc {
 254         sb.relocs = append(sb.relocs, Reloc{})
 255         return &sb.relocs[len(sb.relocs)-1]
 256 }
 257
 258 func (sb *SymbolBuilder) addAddrPlus(tgt Sym, add int64, typ objabi.RelocType, rsize int) int64 {
 259         if sb.kind == 0 {
 260                 sb.kind = sym.SDATA
 261         }
 262         i := sb.size
 263
 264         sb.size += int64(rsize)
 265         sb.Grow(sb.size)
 266
 267         r := sb.addRel()
 268         r.Sym = tgt
 269         r.Off = int32(i)
 270         r.Size = uint8(rsize)
 271         r.Type = typ
 272         r.Add = add
 273
 274         return i + int64(r.Size)
 275 }
 276
 277 func (sb *SymbolBuilder) AddAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 278         sb.setReachable()
 279         return sb.addAddrPlus(tgt, add, objabi.R_ADDR, arch.PtrSize)
 280 }
 281
 282 func (sb *SymbolBuilder) AddAddrPlus4(arch *sys.Arch, tgt Sym, add int64) int64 {
 283         sb.setReachable()
 284         return sb.addAddrPlus(tgt, add, objabi.R_ADDR, 4)
 285 }
 286
 287 func (sb *SymbolBuilder) AddCURelativeAddrPlus(arch *sys.Arch, tgt Sym, add int64) int64 {
 288         sb.setReachable()
 289         return sb.addAddrPlus(tgt, add, objabi.R_ADDRCUOFF, arch.PtrSize)
 290 }