gcc/go/gofrontend/runtime.def

   1 // runtime.def -- runtime functions called by generated code.  -*- C++ -*-
   2
   3 // Copyright 2011 The Go Authors. All rights reserved.
   4 // Use of this source code is governed by a BSD-style
   5 // license that can be found in the LICENSE file.
   6
   7 // Definitions for the Go runtime functions.
   8
   9 // Parameter type helper macros.
  10 #define ABFT6(T1, T2, T3, T4, T5, T6) \
  11   { RFT_ ## T1, RFT_ ## T2, RFT_ ## T3, RFT_ ## T4, RFT_ ## T5, RFT_ ## T6 }
  12 #define P0()                    ABFT6(VOID, VOID, VOID, VOID, VOID, VOID)
  13 #define P1(T)                   ABFT6(T, VOID, VOID, VOID, VOID, VOID)
  14 #define P2(T1, T2)              ABFT6(T1, T2, VOID, VOID, VOID, VOID)
  15 #define P3(T1, T2, T3)          ABFT6(T1, T2, T3, VOID, VOID, VOID)
  16 #define P4(T1, T2, T3, T4)      ABFT6(T1, T2, T3, T4, VOID, VOID)
  17 #define P5(T1, T2, T3, T4, T5)  ABFT6(T1, T2, T3, T4, T5, VOID)
  18 #define P6(T1,T2,T3,T4,T5,T6)   ABFT6(T1, T2, T3, T4, T5, T6)
  19
  20 // Result type helper macros.
  21 #define ABFT2(T1, T2) { RFT_ ## T1, RFT_ ## T2 }
  22 #define R0()                    ABFT2(VOID, VOID)
  23 #define R1(T)                   ABFT2(T, VOID)
  24 #define R2(T1, T2)              ABFT2(T1, T2)
  25
  26 // Define all the Go runtime functions.  The first parameter is the
  27 // enum code used to refer to the function.  The second parameter is
  28 // the name.  The third is the parameter types and the fourth is the
  29 // result types.
  30
  31 // The standard C memcmp function, used for struct comparisons.
  32 DEF_GO_RUNTIME(MEMCMP, "__go_memcmp", P3(POINTER, POINTER, UINTPTR), R1(INT))
  33
  34 // Range over a string, returning the next index.
  35 DEF_GO_RUNTIME(STRINGITER, "runtime.stringiter", P2(STRING, INT), R1(INT))
  36
  37 // Range over a string, returning the next index and character.
  38 DEF_GO_RUNTIME(STRINGITER2, "runtime.stringiter2", P2(STRING, INT),
  39                R2(INT, RUNE))
  40
  41 // Concatenate strings.
  42 DEF_GO_RUNTIME(CONCATSTRINGS, "runtime.concatstrings", P2(POINTER, SLICE),
  43                R1(STRING))
  44 DEF_GO_RUNTIME(CONCATSTRING2, "runtime.concatstring2",
  45                P2(POINTER, ARRAY2STRING), R1(STRING))
  46 DEF_GO_RUNTIME(CONCATSTRING3, "runtime.concatstring3",
  47                P2(POINTER, ARRAY3STRING), R1(STRING))
  48 DEF_GO_RUNTIME(CONCATSTRING4, "runtime.concatstring4",
  49                P2(POINTER, ARRAY4STRING), R1(STRING))
  50 DEF_GO_RUNTIME(CONCATSTRING5, "runtime.concatstring5",
  51                P2(POINTER, ARRAY5STRING), R1(STRING))
  52
  53 // Compare two strings for equality.
  54 DEF_GO_RUNTIME(EQSTRING, "runtime.eqstring", P2(STRING, STRING), R1(BOOL))
  55
  56 // Compare two strings.
  57 DEF_GO_RUNTIME(CMPSTRING, "runtime.cmpstring", P2(STRING, STRING), R1(INT))
  58
  59 // Take a slice of a string.
  60 DEF_GO_RUNTIME(STRING_SLICE, "__go_string_slice", P3(STRING, INT, INT),
  61                R1(STRING))
  62
  63 // Convert an integer to a string.
  64 DEF_GO_RUNTIME(INTSTRING, "runtime.intstring", P2(POINTER, INT64), R1(STRING))
  65
  66 // Convert a []byte to a string.
  67 DEF_GO_RUNTIME(SLICEBYTETOSTRING, "runtime.slicebytetostring",
  68                P2(POINTER, SLICE), R1(STRING))
  69
  70 // Convert a []rune to a string.
  71 DEF_GO_RUNTIME(SLICERUNETOSTRING, "runtime.slicerunetostring",
  72                P2(POINTER, SLICE), R1(STRING))
  73
  74 // Convert a string to a []byte.
  75 DEF_GO_RUNTIME(STRINGTOSLICEBYTE, "runtime.stringtoslicebyte",
  76                P2(POINTER, STRING), R1(SLICE))
  77
  78 // Convert a string to a []rune.
  79 DEF_GO_RUNTIME(STRINGTOSLICERUNE, "runtime.stringtoslicerune",
  80                P2(POINTER, STRING), R1(SLICE))
  81
  82
  83 // Complex division.
  84 DEF_GO_RUNTIME(COMPLEX64_DIV, "__go_complex64_div",
  85                P2(COMPLEX64, COMPLEX64), R1(COMPLEX64))
  86 DEF_GO_RUNTIME(COMPLEX128_DIV, "__go_complex128_div",
  87                P2(COMPLEX128, COMPLEX128), R1(COMPLEX128))
  88
  89 // Make a slice.
  90 DEF_GO_RUNTIME(MAKESLICE, "runtime.makeslice", P3(TYPE, INT64, INT64),
  91                R1(SLICE))
  92
  93
  94 // Make a map.
  95 DEF_GO_RUNTIME(MAKEMAP, "runtime.makemap", P4(TYPE, INT64, POINTER, POINTER),
  96                R1(MAP))
  97
  98 // Build a map from a composite literal.
  99 DEF_GO_RUNTIME(CONSTRUCT_MAP, "__go_construct_map",
 100                P5(POINTER, UINTPTR, UINTPTR, UINTPTR, POINTER),
 101                R1(MAP))
 102
 103 // Look up a key in a map.
 104 DEF_GO_RUNTIME(MAPACCESS1, "runtime.mapaccess1", P3(TYPE, MAP, POINTER),
 105                R1(POINTER))
 106
 107 // Look up a key in a map when the value is large.
 108 DEF_GO_RUNTIME(MAPACCESS1_FAT, "runtime.mapaccess1_fat",
 109                P4(TYPE, MAP, POINTER, POINTER), R1(POINTER))
 110
 111 // Look up a key in a map returning the value and whether it is
 112 // present.
 113 DEF_GO_RUNTIME(MAPACCESS2, "runtime.mapaccess2", P3(TYPE, MAP, POINTER),
 114                R2(POINTER, BOOL))
 115
 116 // Look up a key in a map, returning the value and whether it is
 117 // present, when the value is large.
 118 DEF_GO_RUNTIME(MAPACCESS2_FAT, "runtime.mapaccess2_fat",
 119                P4(TYPE, MAP, POINTER, POINTER), R2(POINTER, BOOL))
 120
 121 // Assignment to a key in a map.
 122 DEF_GO_RUNTIME(MAPASSIGN, "runtime.mapassign1",
 123                P4(TYPE, MAP, POINTER, POINTER), R0())
 124
 125 // Delete a key from a map.
 126 DEF_GO_RUNTIME(MAPDELETE, "runtime.mapdelete", P3(TYPE, MAP, POINTER), R0())
 127
 128 // Begin a range over a map.
 129 DEF_GO_RUNTIME(MAPITERINIT, "runtime.mapiterinit", P3(TYPE, MAP, POINTER),
 130                R0())
 131
 132 // Range over a map, moving to the next map entry.
 133 DEF_GO_RUNTIME(MAPITERNEXT, "runtime.mapiternext", P1(POINTER), R0())
 134
 135
 136 // Make a channel.
 137 DEF_GO_RUNTIME(MAKECHAN, "runtime.makechan", P2(TYPE, INT64), R1(CHAN))
 138
 139 // Send a value on a channel.
 140 DEF_GO_RUNTIME(CHANSEND, "runtime.chansend1", P3(TYPE, CHAN, POINTER), R0())
 141
 142 // Receive a value from a channel.
 143 DEF_GO_RUNTIME(CHANRECV1, "runtime.chanrecv1", P3(TYPE, CHAN, POINTER), R0())
 144
 145 // Receive a value from a channel returning whether it is closed.
 146 DEF_GO_RUNTIME(CHANRECV2, "runtime.chanrecv2", P3(TYPE, CHAN, POINTER),
 147                R1(BOOL))
 148
 149
 150 // Start building a select statement.
 151 DEF_GO_RUNTIME(NEWSELECT, "runtime.newselect", P3(POINTER, INT64, INT32), R0())
 152
 153 // Add a default clause to a select statement.
 154 DEF_GO_RUNTIME(SELECTDEFAULT, "runtime.selectdefault",
 155                P2(POINTER, INT32), R0())
 156
 157 // Add a send clause to a select statement.
 158 DEF_GO_RUNTIME(SELECTSEND, "runtime.selectsend",
 159                P4(POINTER, CHAN, POINTER, INT32), R0())
 160
 161 // Add a receive clause to a select statement, for a clause which does
 162 // not check whether the channel is closed.
 163 DEF_GO_RUNTIME(SELECTRECV, "runtime.selectrecv",
 164                P4(POINTER, CHAN, POINTER, INT32), R0())
 165
 166 // Add a receive clause to a select statement, for a clause which does
 167 // check whether the channel is closed.
 168 DEF_GO_RUNTIME(SELECTRECV2, "runtime.selectrecv2",
 169                P5(POINTER, CHAN, POINTER, BOOLPTR, INT32), R0())
 170
 171 // Run a select, returning the index of the selected clause.
 172 DEF_GO_RUNTIME(SELECTGO, "runtime.selectgo", P1(POINTER), R1(INT32))
 173
 174
 175 // Panic.
 176 DEF_GO_RUNTIME(GOPANIC, "runtime.gopanic", P1(EFACE), R0())
 177
 178 // Recover.
 179 DEF_GO_RUNTIME(GORECOVER, "runtime.gorecover", P0(), R1(EFACE))
 180
 181 // Recover when called directly from defer.
 182 DEF_GO_RUNTIME(DEFERREDRECOVER, "runtime.deferredrecover", P0(), R1(EFACE))
 183
 184 // Decide whether this function can call recover.
 185 DEF_GO_RUNTIME(CANRECOVER, "runtime.canrecover", P1(POINTER), R1(BOOL))
 186
 187 // Set the return address for defer in a defer thunk.
 188 DEF_GO_RUNTIME(SETDEFERRETADDR, "runtime.setdeferretaddr", P1(POINTER),
 189                R1(BOOL))
 190
 191 // Check for a deferred function in an exception handler.
 192 DEF_GO_RUNTIME(CHECKDEFER, "runtime.checkdefer", P1(BOOLPTR), R0())
 193
 194 // Run deferred functions.
 195 DEF_GO_RUNTIME(DEFERRETURN, "runtime.deferreturn", P1(BOOLPTR), R0())
 196
 197 // Panic with a runtime error.
 198 DEF_GO_RUNTIME(RUNTIME_ERROR, "__go_runtime_error", P1(INT32), R0())
 199
 200
 201 // Close.
 202 DEF_GO_RUNTIME(CLOSE, "runtime.closechan", P1(CHAN), R0())
 203
 204
 205 // Copy.
 206 DEF_GO_RUNTIME(SLICECOPY, "runtime.slicecopy", P3(SLICE, SLICE, UINTPTR),
 207                R1(INT))
 208
 209 // Copy from string.
 210 DEF_GO_RUNTIME(SLICESTRINGCOPY, "runtime.slicestringcopy", P2(SLICE, STRING),
 211                R1(INT))
 212
 213 // Copy of value containing pointers.
 214 DEF_GO_RUNTIME(TYPEDSLICECOPY, "runtime.typedslicecopy",
 215                P3(TYPE, SLICE, SLICE), R1(INT))
 216
 217
 218 // Grow a slice for append.
 219 DEF_GO_RUNTIME(GROWSLICE, "runtime.growslice", P3(TYPE, SLICE, INT), R1(SLICE))
 220
 221
 222 // Register roots (global variables) for the garbage collector.
 223 DEF_GO_RUNTIME(REGISTER_GC_ROOTS, "__go_register_gc_roots", P1(POINTER), R0())
 224
 225
 226 // Allocate memory.
 227 DEF_GO_RUNTIME(NEW, "__go_new", P2(TYPE, UINTPTR), R1(POINTER))
 228
 229 // Start a new goroutine.
 230 DEF_GO_RUNTIME(GO, "__go_go", P2(FUNC_PTR, POINTER), R0())
 231
 232 // Defer a function.
 233 DEF_GO_RUNTIME(DEFERPROC, "runtime.deferproc", P3(BOOLPTR, FUNC_PTR, POINTER),
 234                R0())
 235
 236
 237 // Convert an empty interface to an empty interface, returning ok.
 238 DEF_GO_RUNTIME(IFACEE2E2, "runtime.ifaceE2E2", P1(EFACE), R2(EFACE, BOOL))
 239
 240 // Convert a non-empty interface to an empty interface, returning ok.
 241 DEF_GO_RUNTIME(IFACEI2E2, "runtime.ifaceI2E2", P1(IFACE), R2(EFACE, BOOL))
 242
 243 // Convert an empty interface to a non-empty interface, returning ok.
 244 DEF_GO_RUNTIME(IFACEE2I2, "runtime.ifaceE2I2", P2(TYPE, EFACE),
 245                R2(IFACE, BOOL))
 246
 247 // Convert a non-empty interface to a non-empty interface, returning ok.
 248 DEF_GO_RUNTIME(IFACEI2I2, "runtime.ifaceI2I2", P2(TYPE, IFACE),
 249                R2(IFACE, BOOL))
 250
 251 // Convert an empty interface to a pointer type, returning ok.
 252 DEF_GO_RUNTIME(IFACEE2T2P, "runtime.ifaceE2T2P", P2(TYPE, EFACE),
 253                R2(POINTER, BOOL))
 254
 255 // Convert a non-empty interface to a pointer type, return ok.
 256 DEF_GO_RUNTIME(IFACEI2T2P, "runtime.ifaceI2T2P", P2(TYPE, IFACE),
 257                R2(POINTER, BOOL))
 258
 259 // Convert an empty interface to a non-pointer type, returning ok.
 260 DEF_GO_RUNTIME(IFACEE2T2, "runtime.ifaceE2T2", P3(TYPE, EFACE, POINTER),
 261                R1(BOOL))
 262
 263 // Convert a non-empty interface to a non-pointer type, returning ok.
 264 DEF_GO_RUNTIME(IFACEI2T2, "runtime.ifaceI2T2", P3(TYPE, IFACE, POINTER),
 265                R1(BOOL))
 266
 267 // Return the interface method table for the second type converted to
 268 // the first type which is a (possibly empty) interface type.  Panics
 269 // if the second type is nil (indicating a nil interface value) or if
 270 // the conversion is not possible.  Used for type assertions.  This is
 271 // like REQUIREITAB, but for type assertions.
 272 DEF_GO_RUNTIME(ASSERTITAB, "runtime.assertitab", P2(TYPE, TYPE), R1(POINTER))
 273
 274 // Return the interface method table for the second type converted to
 275 // the first type, which is a non-empty interface type.  Return nil if
 276 // the second type is nil, indicating a nil interface value.  Panics
 277 // if the conversion is not possible.  Used for assignments.  This is
 278 // like ASSERTITAB, but for assignments.
 279 DEF_GO_RUNTIME(REQUIREITAB, "runtime.requireitab", P2(TYPE, TYPE),
 280                R1(POINTER))
 281
 282 // Check whether an interface type may be converted to a
 283 // non-interface type.
 284 DEF_GO_RUNTIME(ASSERTI2T, "runtime.assertI2T", P3(TYPE, TYPE, TYPE), R0())
 285
 286 // Return whether we can convert a type to an interface type.
 287 DEF_GO_RUNTIME(IFACET2IP, "runtime.ifaceT2Ip", P2(TYPE, TYPE), R1(BOOL))
 288
 289 // Get the type descriptor of an empty interface.
 290 DEF_GO_RUNTIME(EFACETYPE, "runtime.efacetype", P1(EFACE), R1(TYPE))
 291
 292 // Get the type descriptor of a non-empty interface.
 293 DEF_GO_RUNTIME(IFACETYPE, "runtime.ifacetype", P1(IFACE), R1(TYPE))
 294
 295
 296 // Compare two type descriptors for equality.
 297 DEF_GO_RUNTIME(IFACETYPEEQ, "runtime.ifacetypeeq", P2(TYPE, TYPE), R1(BOOL))
 298
 299 // Compare two empty interface values.
 300 DEF_GO_RUNTIME(EFACEEQ, "runtime.efaceeq", P2(EFACE, EFACE), R1(BOOL))
 301
 302 // Compare an empty interface value to a non-interface value.
 303 DEF_GO_RUNTIME(EFACEVALEQ, "runtime.efacevaleq", P3(EFACE, TYPE, POINTER),
 304                R1(BOOL))
 305
 306 // Compare two non-empty interface values.
 307 DEF_GO_RUNTIME(IFACEEQ, "runtime.ifaceeq", P2(IFACE, IFACE), R1(BOOL))
 308
 309 // Compare a non-empty interface value to a non-interface value.
 310 DEF_GO_RUNTIME(IFACEVALEQ, "runtime.ifacevaleq", P3(IFACE, TYPE, POINTER),
 311                R1(BOOL))
 312
 313 // Compare a non-empty interface value to an interface value.
 314 DEF_GO_RUNTIME(IFACEEFACEEQ, "runtime.ifaceefaceeq", P2(IFACE, EFACE),
 315                R1(BOOL))
 316
 317
 318 // Lock the printer (for print/println).
 319 DEF_GO_RUNTIME(PRINTLOCK, "runtime.printlock", P0(), R0())
 320
 321 // Unlock the printer (for print/println).
 322 DEF_GO_RUNTIME(PRINTUNLOCK, "runtime.printunlock", P0(), R0())
 323
 324 // Print a string (for print/println).
 325 DEF_GO_RUNTIME(PRINTSTRING, "runtime.printstring", P1(STRING), R0())
 326
 327 // Print a uint64 (for print/println).
 328 DEF_GO_RUNTIME(PRINTUINT, "runtime.printuint", P1(UINT64), R0())
 329
 330 // Print a int64 (for print/println).
 331 DEF_GO_RUNTIME(PRINTINT, "runtime.printint", P1(INT64), R0())
 332
 333 // Print a float64 (for print/println).
 334 DEF_GO_RUNTIME(PRINTFLOAT, "runtime.printfloat", P1(FLOAT64), R0())
 335
 336 // Print a complex128 (for print/println).
 337 DEF_GO_RUNTIME(PRINTCOMPLEX, "runtime.printcomplex", P1(COMPLEX128), R0())
 338
 339 // Print a bool (for print/println).
 340 DEF_GO_RUNTIME(PRINTBOOL, "runtime.printbool", P1(BOOL), R0())
 341
 342 // Print a pointer/map/channel/function (for print/println).
 343 DEF_GO_RUNTIME(PRINTPOINTER, "runtime.printpointer", P1(POINTER), R0())
 344
 345 // Print an empty interface (for print/println).
 346 DEF_GO_RUNTIME(PRINTEFACE, "runtime.printeface", P1(EFACE), R0())
 347
 348 // Print a non-empty interface (for print/println).
 349 DEF_GO_RUNTIME(PRINTIFACE, "runtime.printiface", P1(IFACE), R0())
 350
 351 // Print a slice (for print/println).
 352 DEF_GO_RUNTIME(PRINTSLICE, "runtime.printslice", P1(SLICE), R0())
 353
 354 // Print a space (for println).
 355 DEF_GO_RUNTIME(PRINTSP, "runtime.printsp", P0(), R0())
 356
 357 // Print a newline (for println).
 358 DEF_GO_RUNTIME(PRINTNL, "runtime.printnl", P0(), R0())
 359
 360
 361 // Used for field tracking for data analysis.
 362 DEF_GO_RUNTIME(FIELDTRACK, "__go_fieldtrack", P1(POINTER), R0())
 363
 364
 365 // Remove helper macros.
 366 #undef ABFT6
 367 #undef ABFT2
 368 #undef P0
 369 #undef P1
 370 #undef P2
 371 #undef P3
 372 #undef P4
 373 #undef P5
 374 #undef P6
 375 #undef R0
 376 #undef R1
 377 #undef R2