libgo/runtime/runtime.h

   1 // Copyright 2009 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 #include "config.h"
   6
   7 #include "go-assert.h"
   8 #include <complex.h>
   9 #include <signal.h>
  10 #include <stdint.h>
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <sys/types.h>
  15 #include <sys/stat.h>
  16 #include <fcntl.h>
  17 #include <unistd.h>
  18 #include <pthread.h>
  19 #include <semaphore.h>
  20 #include <ucontext.h>
  21
  22 #ifdef HAVE_SYS_MMAN_H
  23 #include <sys/mman.h>
  24 #endif
  25
  26 #define _STRINGIFY2_(x) #x
  27 #define _STRINGIFY_(x) _STRINGIFY2_(x)
  28 #define GOSYM_PREFIX _STRINGIFY_(__USER_LABEL_PREFIX__)
  29
  30 /* This file supports C files copied from the 6g runtime library.
  31    This is a version of the 6g runtime.h rewritten for gccgo's version
  32    of the code.  */
  33
  34 typedef signed int   int8    __attribute__ ((mode (QI)));
  35 typedef unsigned int uint8   __attribute__ ((mode (QI)));
  36 typedef signed int   int16   __attribute__ ((mode (HI)));
  37 typedef unsigned int uint16  __attribute__ ((mode (HI)));
  38 typedef signed int   int32   __attribute__ ((mode (SI)));
  39 typedef unsigned int uint32  __attribute__ ((mode (SI)));
  40 typedef signed int   int64   __attribute__ ((mode (DI)));
  41 typedef unsigned int uint64  __attribute__ ((mode (DI)));
  42 typedef float        float32 __attribute__ ((mode (SF)));
  43 typedef double       float64 __attribute__ ((mode (DF)));
  44 typedef signed int   intptr __attribute__ ((mode (pointer)));
  45 typedef unsigned int uintptr __attribute__ ((mode (pointer)));
  46
  47 typedef intptr          intgo; // Go's int
  48 typedef uintptr         uintgo; // Go's uint
  49
  50 typedef uintptr         uintreg;
  51
  52 /* Defined types.  */
  53
  54 typedef _Bool                   bool;
  55 typedef uint8                   byte;
  56 typedef struct  g               G;
  57 typedef struct  mutex           Lock;
  58 typedef struct  m               M;
  59 typedef struct  p               P;
  60 typedef struct  note            Note;
  61 typedef struct  String          String;
  62 typedef struct  FuncVal         FuncVal;
  63 typedef struct  SigTab          SigTab;
  64 typedef struct  hchan           Hchan;
  65 typedef struct  timer           Timer;
  66 typedef struct  lfnode          LFNode;
  67 typedef struct  cgoMal          CgoMal;
  68 typedef struct  PollDesc        PollDesc;
  69 typedef struct  sudog           SudoG;
  70 typedef struct  schedt          Sched;
  71
  72 typedef struct  __go_open_array         Slice;
  73 typedef struct  iface                   Iface;
  74 typedef struct  eface                   Eface;
  75 typedef struct  __go_type_descriptor    Type;
  76 typedef struct  _defer                  Defer;
  77 typedef struct  _panic                  Panic;
  78
  79 typedef struct  __go_ptr_type           PtrType;
  80 typedef struct  __go_func_type          FuncType;
  81 typedef struct  __go_interface_type     InterfaceType;
  82 typedef struct  __go_map_type           MapType;
  83 typedef struct  __go_channel_type       ChanType;
  84
  85 typedef struct  tracebackg      Traceback;
  86
  87 typedef struct  location        Location;
  88
  89 struct String
  90 {
  91         const byte*     str;
  92         intgo           len;
  93 };
  94
  95 struct FuncVal
  96 {
  97         void    (*fn)(void);
  98         // variable-size, fn-specific data here
  99 };
 100
 101 #include "array.h"
 102
 103 // Rename Go types generated by mkrsysinfo.sh from C types, to avoid
 104 // the name conflict.
 105 #define timeval go_timeval
 106 #define timespec go_timespec
 107
 108 #include "runtime.inc"
 109
 110 #undef timeval
 111 #undef timespec
 112
 113 /*
 114  * Per-CPU declaration.
 115  */
 116 extern M*       runtime_m(void);
 117 extern G*       runtime_g(void)
 118   __asm__(GOSYM_PREFIX "runtime.getg");
 119
 120 extern M*       runtime_m0(void)
 121   __asm__(GOSYM_PREFIX "runtime.runtime_m0");
 122 extern G*       runtime_g0(void)
 123   __asm__(GOSYM_PREFIX "runtime.runtime_g0");
 124
 125 enum
 126 {
 127         true    = 1,
 128         false   = 0,
 129 };
 130 enum
 131 {
 132         PtrSize = sizeof(void*),
 133 };
 134 enum
 135 {
 136         // Per-M stack segment cache size.
 137         StackCacheSize = 32,
 138         // Global <-> per-M stack segment cache transfer batch size.
 139         StackCacheBatch = 16,
 140 };
 141
 142 struct  SigTab
 143 {
 144         int32   sig;
 145         int32   flags;
 146         void*   fwdsig;
 147 };
 148
 149 #ifdef GOOS_nacl
 150 enum {
 151    NaCl = 1,
 152 };
 153 #else
 154 enum {
 155    NaCl = 0,
 156 };
 157 #endif
 158
 159 #ifdef GOOS_windows
 160 enum {
 161    Windows = 1
 162 };
 163 #else
 164 enum {
 165    Windows = 0
 166 };
 167 #endif
 168 #ifdef GOOS_solaris
 169 enum {
 170    Solaris = 1
 171 };
 172 #else
 173 enum {
 174    Solaris = 0
 175 };
 176 #endif
 177
 178 extern bool runtime_copystack;
 179
 180 /*
 181  * defined macros
 182  *    you need super-gopher-guru privilege
 183  *    to add this list.
 184  */
 185 #define nelem(x)        (sizeof(x)/sizeof((x)[0]))
 186 #define nil             ((void*)0)
 187 #define USED(v)         ((void) v)
 188 #define ROUND(x, n)     (((x)+(n)-1)&~(uintptr)((n)-1)) /* all-caps to mark as macro: it evaluates n twice */
 189
 190 enum {
 191         // hashinit wants this many random bytes
 192         HashRandomBytes = 32
 193 };
 194 void    runtime_hashinit(void);
 195
 196 void    runtime_traceback(int32)
 197   __asm__ (GOSYM_PREFIX "runtime.traceback");
 198 void    runtime_tracebackothers(G*)
 199   __asm__ (GOSYM_PREFIX "runtime.tracebackothers");
 200 enum
 201 {
 202         // The maximum number of frames we print for a traceback
 203         TracebackMaxFrames = 100,
 204 };
 205
 206 /*
 207  * external data
 208  */
 209 extern  uintptr* runtime_getZerobase(void)
 210   __asm__(GOSYM_PREFIX "runtime.getZerobase");
 211 extern G* runtime_getallg(intgo)
 212   __asm__(GOSYM_PREFIX "runtime.getallg");
 213 extern uintptr runtime_getallglen(void)
 214   __asm__(GOSYM_PREFIX "runtime.getallglen");
 215 extern  M*      runtime_getallm(void)
 216   __asm__(GOSYM_PREFIX "runtime.getallm");
 217 extern  Sched*  runtime_sched;
 218 extern  uint32  runtime_panicking(void)
 219   __asm__ (GOSYM_PREFIX "runtime.getPanicking");
 220 extern  struct debugVars runtime_debug;
 221
 222 extern  bool    runtime_isstarted;
 223 extern  bool    runtime_isarchive;
 224
 225 /*
 226  * common functions and data
 227  */
 228 #define runtime_strcmp(s1, s2) __builtin_strcmp((s1), (s2))
 229 #define runtime_strncmp(s1, s2, n) __builtin_strncmp((s1), (s2), (n))
 230 #define runtime_strstr(s1, s2) __builtin_strstr((s1), (s2))
 231 intgo   runtime_findnull(const byte*)
 232   __asm__ (GOSYM_PREFIX "runtime.findnull");
 233
 234 void    runtime_gogo(G*)
 235   __asm__ (GOSYM_PREFIX "runtime.gogo");
 236 struct __go_func_type;
 237 void    runtime_args(int32, byte**)
 238   __asm__ (GOSYM_PREFIX "runtime.args");
 239 void    runtime_alginit(void)
 240   __asm__ (GOSYM_PREFIX "runtime.alginit");
 241 void    runtime_goargs(void)
 242   __asm__ (GOSYM_PREFIX "runtime.goargs");
 243 void    runtime_throw(const char*) __attribute__ ((noreturn));
 244 void    runtime_panicstring(const char*) __attribute__ ((noreturn));
 245 bool    runtime_canpanic(G*);
 246 void    runtime_printf(const char*, ...);
 247 int32   runtime_snprintf(byte*, int32, const char*, ...);
 248 #define runtime_mcmp(a, b, s) __builtin_memcmp((a), (b), (s))
 249 #define runtime_memmove(a, b, s) __builtin_memmove((a), (b), (s))
 250 String  runtime_gostringnocopy(const byte*)
 251   __asm__ (GOSYM_PREFIX "runtime.gostringnocopy");
 252 void    runtime_schedinit(void)
 253   __asm__ (GOSYM_PREFIX "runtime.schedinit");
 254 void    runtime_initsig(bool)
 255   __asm__ (GOSYM_PREFIX "runtime.initsig");
 256 void    runtime_goroutineheader(G*)
 257   __asm__ (GOSYM_PREFIX "runtime.goroutineheader");
 258 void    runtime_printtrace(Slice, G*)
 259   __asm__ (GOSYM_PREFIX "runtime.printtrace");
 260 #define runtime_open(p, f, m) open((p), (f), (m))
 261 #define runtime_read(d, v, n) read((d), (v), (n))
 262 #define runtime_write(d, v, n) write((d), (v), (n))
 263 #define runtime_close(d) close(d)
 264 void    runtime_ready(G*, intgo, bool)
 265   __asm__ (GOSYM_PREFIX "runtime.ready");
 266 String  runtime_getenv(const char*);
 267 int32   runtime_atoi(const byte*, intgo);
 268 void*   runtime_mstart(void*);
 269 G*      runtime_malg(bool, bool, byte**, uintptr*)
 270         __asm__(GOSYM_PREFIX "runtime.malg");
 271 void    runtime_minit(void)
 272   __asm__ (GOSYM_PREFIX "runtime.minit");
 273 void    runtime_signalstack(byte*, uintptr)
 274   __asm__ (GOSYM_PREFIX "runtime.signalstack");
 275 void    runtime_mallocinit(void)
 276   __asm__ (GOSYM_PREFIX "runtime.mallocinit");
 277 void*   runtime_mallocgc(uintptr, const Type*, bool)
 278   __asm__ (GOSYM_PREFIX "runtime.mallocgc");
 279 void*   runtime_sysAlloc(uintptr, uint64*)
 280   __asm__ (GOSYM_PREFIX "runtime.sysAlloc");
 281 void    runtime_mprofinit(void);
 282 #define runtime_getcallersp(p) __builtin_frame_address(0)
 283 void    runtime_mcall(FuncVal*)
 284   __asm__ (GOSYM_PREFIX "runtime.mcall");
 285 uint32  runtime_fastrand(void) __asm__ (GOSYM_PREFIX "runtime.fastrand");
 286 int32   runtime_timediv(int64, int32, int32*)
 287   __asm__ (GOSYM_PREFIX "runtime.timediv");
 288 int32   runtime_round2(int32 x); // round x up to a power of 2.
 289
 290 // atomic operations
 291 #define runtime_cas(pval, old, new) __sync_bool_compare_and_swap (pval, old, new)
 292 #define runtime_cas64(pval, old, new) __sync_bool_compare_and_swap (pval, old, new)
 293 #define runtime_casp(pval, old, new) __sync_bool_compare_and_swap (pval, old, new)
 294 // Don't confuse with XADD x86 instruction,
 295 // this one is actually 'addx', that is, add-and-fetch.
 296 #define runtime_xadd(p, v) __sync_add_and_fetch (p, v)
 297 #define runtime_xadd64(p, v) __sync_add_and_fetch (p, v)
 298 #define runtime_xchg(p, v) __atomic_exchange_n (p, v, __ATOMIC_SEQ_CST)
 299 #define runtime_xchg64(p, v) __atomic_exchange_n (p, v, __ATOMIC_SEQ_CST)
 300 #define runtime_xchgp(p, v) __atomic_exchange_n (p, v, __ATOMIC_SEQ_CST)
 301 #define runtime_atomicload(p) __atomic_load_n (p, __ATOMIC_SEQ_CST)
 302 #define runtime_atomicstore(p, v) __atomic_store_n (p, v, __ATOMIC_SEQ_CST)
 303 #define runtime_atomicstore64(p, v) __atomic_store_n (p, v, __ATOMIC_SEQ_CST)
 304 #define runtime_atomicload64(p) __atomic_load_n (p, __ATOMIC_SEQ_CST)
 305 #define runtime_atomicloadp(p) __atomic_load_n (p, __ATOMIC_SEQ_CST)
 306 #define runtime_atomicstorep(p, v) __atomic_store_n (p, v, __ATOMIC_SEQ_CST)
 307
 308 void runtime_setg(G*)
 309   __asm__ (GOSYM_PREFIX "runtime.setg");
 310 void runtime_newextram(void)
 311   __asm__ (GOSYM_PREFIX "runtime.newextram");
 312 #define runtime_exit(s) exit(s)
 313 void    runtime_gosched(void)
 314   __asm__ (GOSYM_PREFIX "runtime.Gosched");
 315 void    runtime_schedtrace(bool)
 316   __asm__ (GOSYM_PREFIX "runtime.schedtrace");
 317 void    runtime_goparkunlock(Lock*, String, byte, intgo)
 318   __asm__ (GOSYM_PREFIX "runtime.goparkunlock");
 319 void    runtime_tsleep(int64, const char*);
 320 void    runtime_entersyscall(int32)
 321   __asm__ (GOSYM_PREFIX "runtime.entersyscall");
 322 void    runtime_entersyscallblock(int32)
 323   __asm__ (GOSYM_PREFIX "runtime.entersyscallblock");
 324 void    runtime_exitsyscall(int32)
 325   __asm__ (GOSYM_PREFIX "runtime.exitsyscall");
 326 G*      __go_go(void (*pfn)(void*), void*);
 327 int32   runtime_callers(int32, Location*, int32, bool keep_callers);
 328 int64   runtime_nanotime(void)  // monotonic time
 329   __asm__(GOSYM_PREFIX "runtime.nanotime");
 330 int64   runtime_unixnanotime(void) // real time, can skip
 331   __asm__ (GOSYM_PREFIX "runtime.unixnanotime");
 332 void    runtime_dopanic(int32) __attribute__ ((noreturn));
 333 void    runtime_startpanic(void)
 334   __asm__ (GOSYM_PREFIX "runtime.startpanic");
 335 void    runtime_unwindstack(G*, byte*);
 336 void    runtime_usleep(uint32)
 337      __asm__ (GOSYM_PREFIX "runtime.usleep");
 338 int64   runtime_cputicks(void)
 339      __asm__ (GOSYM_PREFIX "runtime.cputicks");
 340 int64   runtime_tickspersecond(void)
 341      __asm__ (GOSYM_PREFIX "runtime.tickspersecond");
 342 void    runtime_blockevent(int64, int32);
 343 extern int64 runtime_blockprofilerate;
 344 G*      runtime_netpoll(bool)
 345   __asm__ (GOSYM_PREFIX "runtime.netpoll");
 346 void    runtime_crash(void)
 347   __asm__ (GOSYM_PREFIX "runtime.crash");
 348 void    runtime_parsedebugvars(void)
 349   __asm__(GOSYM_PREFIX "runtime.parsedebugvars");
 350 void    _rt0_go(void);
 351 G*      runtime_timejump(void);
 352
 353 void    runtime_callStopTheWorldWithSema(void)
 354   __asm__(GOSYM_PREFIX "runtime.callStopTheWorldWithSema");
 355 void    runtime_callStartTheWorldWithSema(void)
 356   __asm__(GOSYM_PREFIX "runtime.callStartTheWorldWithSema");
 357 void    runtime_acquireWorldsema(void)
 358   __asm__(GOSYM_PREFIX "runtime.acquireWorldsema");
 359 void    runtime_releaseWorldsema(void)
 360   __asm__(GOSYM_PREFIX "runtime.releaseWorldsema");
 361
 362 /*
 363  * mutual exclusion locks.  in the uncontended case,
 364  * as fast as spin locks (just a few user-level instructions),
 365  * but on the contention path they sleep in the kernel.
 366  * a zeroed Lock is unlocked (no need to initialize each lock).
 367  */
 368 void    runtime_lock(Lock*)
 369   __asm__(GOSYM_PREFIX "runtime.lock");
 370 void    runtime_unlock(Lock*)
 371   __asm__(GOSYM_PREFIX "runtime.unlock");
 372
 373 /*
 374  * sleep and wakeup on one-time events.
 375  * before any calls to notesleep or notewakeup,
 376  * must call noteclear to initialize the Note.
 377  * then, exactly one thread can call notesleep
 378  * and exactly one thread can call notewakeup (once).
 379  * once notewakeup has been called, the notesleep
 380  * will return.  future notesleep will return immediately.
 381  * subsequent noteclear must be called only after
 382  * previous notesleep has returned, e.g. it's disallowed
 383  * to call noteclear straight after notewakeup.
 384  *
 385  * notetsleep is like notesleep but wakes up after
 386  * a given number of nanoseconds even if the event
 387  * has not yet happened.  if a goroutine uses notetsleep to
 388  * wake up early, it must wait to call noteclear until it
 389  * can be sure that no other goroutine is calling
 390  * notewakeup.
 391  *
 392  * notesleep/notetsleep are generally called on g0,
 393  * notetsleepg is similar to notetsleep but is called on user g.
 394  */
 395 void    runtime_noteclear(Note*)
 396   __asm__ (GOSYM_PREFIX "runtime.noteclear");
 397 void    runtime_notesleep(Note*)
 398   __asm__ (GOSYM_PREFIX "runtime.notesleep");
 399 void    runtime_notewakeup(Note*)
 400   __asm__ (GOSYM_PREFIX "runtime.notewakeup");
 401 bool    runtime_notetsleep(Note*, int64)  // false - timeout
 402   __asm__ (GOSYM_PREFIX "runtime.notetsleep");
 403 bool    runtime_notetsleepg(Note*, int64)  // false - timeout
 404   __asm__ (GOSYM_PREFIX "runtime.notetsleepg");
 405
 406 /*
 407  * Lock-free stack.
 408  * Initialize uint64 head to 0, compare with 0 to test for emptiness.
 409  * The stack does not keep pointers to nodes,
 410  * so they can be garbage collected if there are no other pointers to nodes.
 411  */
 412 void    runtime_lfstackpush(uint64 *head, LFNode *node)
 413   __asm__ (GOSYM_PREFIX "runtime.lfstackpush");
 414 void*   runtime_lfstackpop(uint64 *head)
 415   __asm__ (GOSYM_PREFIX "runtime.lfstackpop");
 416
 417 /*
 418  * low level C-called
 419  */
 420 #define runtime_mmap mmap
 421 #define runtime_munmap munmap
 422 #define runtime_madvise madvise
 423 #define runtime_memclr(buf, size) __builtin_memset((buf), 0, (size))
 424 #define runtime_getcallerpc(p) __builtin_return_address(0)
 425
 426 #ifdef __rtems__
 427 void __wrap_rtems_task_variable_add(void **);
 428 #endif
 429
 430 /*
 431  * runtime go-called
 432  */
 433 void reflect_call(const struct __go_func_type *, FuncVal *, _Bool, _Bool,
 434                   void **, void **)
 435   __asm__ (GOSYM_PREFIX "reflect.call");
 436 void runtime_panic(Eface)
 437   __asm__ (GOSYM_PREFIX "runtime.gopanic");
 438 void runtime_panic(Eface)
 439   __attribute__ ((noreturn));
 440
 441 /*
 442  * runtime c-called (but written in Go)
 443  */
 444 void    runtime_newTypeAssertionError(const String*, const String*, const String*, const String*, Eface*)
 445      __asm__ (GOSYM_PREFIX "runtime.NewTypeAssertionError");
 446 void    runtime_newErrorCString(const char*, Eface*)
 447      __asm__ (GOSYM_PREFIX "runtime.NewErrorCString");
 448
 449 /*
 450  * wrapped for go users
 451  */
 452 void    runtime_procyield(uint32)
 453   __asm__(GOSYM_PREFIX "runtime.procyield");
 454 void    runtime_osyield(void)
 455   __asm__(GOSYM_PREFIX "runtime.osyield");
 456
 457 void    runtime_printcreatedby(G*)
 458   __asm__(GOSYM_PREFIX "runtime.printcreatedby");
 459
 460 uintptr runtime_memlimit(void);
 461
 462 #define ISNAN(f) __builtin_isnan(f)
 463
 464 enum
 465 {
 466         UseSpanType = 1,
 467 };
 468
 469 #define runtime_setitimer setitimer
 470
 471 void    runtime_check(void)
 472   __asm__ (GOSYM_PREFIX "runtime.check");
 473
 474 // Size of stack space allocated using Go's allocator.
 475 // This will be 0 when using split stacks, as in that case
 476 // the stacks are allocated by the splitstack library.
 477 extern uintptr runtime_stacks_sys;
 478
 479 struct backtrace_state;
 480 extern struct backtrace_state *__go_get_backtrace_state(void);
 481 extern _Bool __go_file_line(uintptr, int, String*, String*, intgo *);
 482 extern void runtime_main(void*)
 483   __asm__(GOSYM_PREFIX "runtime.main");
 484
 485 int32 getproccount(void);
 486
 487 #define PREFETCH(p) __builtin_prefetch(p)
 488
 489 bool    runtime_gcwaiting(void);
 490 void    runtime_badsignal(int);
 491 Defer*  runtime_newdefer(void);
 492 void    runtime_freedefer(Defer*);
 493
 494 struct time_now_ret
 495 {
 496   int64_t sec;
 497   int32_t nsec;
 498 };
 499
 500 struct time_now_ret now() __asm__ (GOSYM_PREFIX "time.now")
 501   __attribute__ ((no_split_stack));
 502
 503 extern void _cgo_wait_runtime_init_done (void);
 504 extern void _cgo_notify_runtime_init_done (void)
 505   __asm__ (GOSYM_PREFIX "runtime._cgo_notify_runtime_init_done");
 506 extern _Bool runtime_iscgo;
 507 extern uintptr __go_end __attribute__ ((weak));
 508 extern void *getitab(const struct __go_type_descriptor *,
 509                      const struct __go_type_descriptor *,
 510                      _Bool)
 511   __asm__ (GOSYM_PREFIX "runtime.getitab");
 512
 513 extern void runtime_cpuinit(void);
 514 extern void setIsCgo(void)
 515   __asm__ (GOSYM_PREFIX "runtime.setIsCgo");
 516 extern void setCpuidECX(uint32)
 517   __asm__ (GOSYM_PREFIX "runtime.setCpuidECX");
 518 extern void setSupportAES(bool)
 519   __asm__ (GOSYM_PREFIX "runtime.setSupportAES");
 520 extern void typedmemmove(const Type *, void *, const void *)
 521   __asm__ (GOSYM_PREFIX "runtime.typedmemmove");
 522 extern void setncpu(int32)
 523   __asm__(GOSYM_PREFIX "runtime.setncpu");
 524 extern P** runtime_getAllP()
 525   __asm__ (GOSYM_PREFIX "runtime.getAllP");
 526 extern Sched* runtime_getsched()
 527   __asm__ (GOSYM_PREFIX "runtime.getsched");
 528 extern void setpagesize(uintptr_t)
 529   __asm__(GOSYM_PREFIX "runtime.setpagesize");