blob: 1ee67c86837edfe0641b69f70bf63c2c1535159a [file] [log] [blame]
Brad Fitzpatrick51947442016-03-01 22:57:46 +00001// Copyright 2013 The Go Authors. All rights reserved.
Russ Cox9ddfb642013-07-16 16:24:09 -04002// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
5// This file defines the IDs for PCDATA and FUNCDATA instructions
Russ Coxfee9e4752014-11-11 17:05:19 -05006// in Go binaries. It is included by assembly sources, so it must
7// be written using #defines.
8//
Xia Binc19f86f2018-07-12 18:34:34 +08009// These must agree with symtab.go and ../cmd/internal/objabi/funcdata.go.
Russ Cox9ddfb642013-07-16 16:24:09 -040010
Russ Cox68c1c6a2014-09-12 07:51:00 -040011#define PCDATA_StackMapIndex 0
David Lazar699175a2017-02-17 12:28:05 -050012#define PCDATA_InlTreeIndex 1
Austin Clements9f95c9d2018-03-27 15:50:45 -040013#define PCDATA_RegMapIndex 2
Russ Cox48769bf2013-07-19 16:04:09 -040014
Matthew Dempsky3d128db2014-08-28 19:08:09 -070015#define FUNCDATA_ArgsPointerMaps 0 /* garbage collector blocks */
16#define FUNCDATA_LocalsPointerMaps 1
David Lazar699175a2017-02-17 12:28:05 -050017#define FUNCDATA_InlTree 2
Austin Clements9f95c9d2018-03-27 15:50:45 -040018#define FUNCDATA_RegPointerMaps 3
Keith Randallcbafcc52018-09-01 20:16:39 -070019#define FUNCDATA_StackObjects 4
Russ Cox9ddfb642013-07-16 16:24:09 -040020
Russ Cox99f7df02014-09-12 00:18:20 -040021// Pseudo-assembly statements.
22
23// GO_ARGS, GO_RESULTS_INITIALIZED, and NO_LOCAL_POINTERS are macros
24// that communicate to the runtime information about the location and liveness
25// of pointers in an assembly function's arguments, results, and stack frame.
26// This communication is only required in assembly functions that make calls
27// to other functions that might be preempted or grow the stack.
28// NOSPLIT functions that make no calls do not need to use these macros.
29
30// GO_ARGS indicates that the Go prototype for this assembly function
31// defines the pointer map for the function's arguments.
32// GO_ARGS should be the first instruction in a function that uses it.
33// It can be omitted if there are no arguments at all.
Russ Cox202bf8d2014-10-28 15:51:06 -040034// GO_ARGS is inserted implicitly by the linker for any function
35// that also has a Go prototype and therefore is usually not necessary
36// to write explicitly.
Russ Cox99f7df02014-09-12 00:18:20 -040037#define GO_ARGS FUNCDATA $FUNCDATA_ArgsPointerMaps, go_args_stackmap(SB)
38
39// GO_RESULTS_INITIALIZED indicates that the assembly function
40// has initialized the stack space for its results and that those results
41// should be considered live for the remainder of the function.
Richard Miller8a2d6e92016-03-14 10:24:19 +000042#define GO_RESULTS_INITIALIZED PCDATA $PCDATA_StackMapIndex, $1
Russ Cox99f7df02014-09-12 00:18:20 -040043
44// NO_LOCAL_POINTERS indicates that the assembly function stores
45// no pointers to heap objects in its local stack variables.
46#define NO_LOCAL_POINTERS FUNCDATA $FUNCDATA_LocalsPointerMaps, runtimeยทno_pointers_stackmap(SB)
47
Keith Randall6fc49c12013-07-19 11:19:18 -070048// ArgsSizeUnknown is set in Func.argsize to mark all functions
49// whose argument size is unknown (C vararg functions, and
50// assembly code without an explicit specification).
51// This value is generated by the compiler, assembler, or linker.
52#define ArgsSizeUnknown 0x80000000