symkind.go

     1  // Derived from Inferno utils/6l/l.h and related files.
     2  // https://bitbucket.org/inferno-os/inferno-os/src/master/utils/6l/l.h
     3  //
     4  //	Copyright © 1994-1999 Lucent Technologies Inc.  All rights reserved.
     5  //	Portions Copyright © 1995-1997 C H Forsyth (forsyth@terzarima.net)
     6  //	Portions Copyright © 1997-1999 Vita Nuova Limited
     7  //	Portions Copyright © 2000-2007 Vita Nuova Holdings Limited (www.vitanuova.com)
     8  //	Portions Copyright © 2004,2006 Bruce Ellis
     9  //	Portions Copyright © 2005-2007 C H Forsyth (forsyth@terzarima.net)
    10  //	Revisions Copyright © 2000-2007 Lucent Technologies Inc. and others
    11  //	Portions Copyright © 2009 The Go Authors. All rights reserved.
    12  //
    13  // Permission is hereby granted, free of charge, to any person obtaining a copy
    14  // of this software and associated documentation files (the "Software"), to deal
    15  // in the Software without restriction, including without limitation the rights
    16  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    17  // copies of the Software, and to permit persons to whom the Software is
    18  // furnished to do so, subject to the following conditions:
    19  //
    20  // The above copyright notice and this permission notice shall be included in
    21  // all copies or substantial portions of the Software.
    22  //
    23  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    24  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    25  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
    26  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    27  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    28  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    29  // THE SOFTWARE.
    30  
    31  package objabi
    32  
    33  // A SymKind describes the kind of memory represented by a symbol.
    34  type SymKind uint8
    35  
    36  // Defined SymKind values.
    37  // These are used to index into cmd/link/internal/sym/AbiSymKindToSymKind
    38  //
    39  // TODO(rsc): Give idiomatic Go names.
    40  //
    41  //go:generate stringer -type=SymKind
    42  const (
    43  	// An otherwise invalid zero value for the type
    44  	Sxxx SymKind = iota
    45  	// Executable instructions
    46  	STEXT
    47  	STEXTFIPS
    48  	// Read only static data
    49  	SRODATA
    50  	SRODATAFIPS
    51  	// Static data that does not contain any pointers
    52  	SNOPTRDATA
    53  	SNOPTRDATAFIPS
    54  	// Static data
    55  	SDATA
    56  	SDATAFIPS
    57  	// Statically data that is initially all 0s
    58  	SBSS
    59  	// Statically data that is initially all 0s and does not contain pointers
    60  	SNOPTRBSS
    61  	// Thread-local data that is initially all 0s
    62  	STLSBSS
    63  	// Debugging data
    64  	SDWARFCUINFO
    65  	SDWARFCONST
    66  	SDWARFFCN
    67  	SDWARFABSFCN
    68  	SDWARFTYPE
    69  	SDWARFVAR
    70  	SDWARFRANGE
    71  	SDWARFLOC
    72  	SDWARFLINES
    73  	// Coverage instrumentation counter for libfuzzer.
    74  	SLIBFUZZER_8BIT_COUNTER
    75  	// Coverage instrumentation counter, aux variable for cmd/cover
    76  	SCOVERAGE_COUNTER
    77  	SCOVERAGE_AUXVAR
    78  
    79  	SSEHUNWINDINFO
    80  	// Update cmd/link/internal/sym/AbiSymKindToSymKind for new SymKind values.
    81  )
    82  
    83  // IsText reports whether t is one of the text kinds.
    84  func (t SymKind) IsText() bool {
    85  	return t == STEXT || t == STEXTFIPS
    86  }
    87  
    88  // IsDATA reports whether t is one of the DATA kinds (SDATA or SDATAFIPS,
    89  // excluding NOPTRDATA, RODATA, BSS, and so on).
    90  func (t SymKind) IsDATA() bool {
    91  	return t == SDATA || t == SDATAFIPS
    92  }
    93  
    94  // IsFIPS reports whether t is one fo the FIPS kinds.
    95  func (t SymKind) IsFIPS() bool {
    96  	return t == STEXTFIPS || t == SRODATAFIPS || t == SNOPTRDATAFIPS || t == SDATAFIPS
    97  }
    98
View as plain text