pub_core_threadstate.h revision 663860b1408516d02ebfcb3a9999a134e6cfb223
1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- The thread state. pub_core_threadstate.h ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 10663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng Copyright (C) 2000-2012 Julian Seward 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown jseward@acm.org 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_CORE_THREADSTATE_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_CORE_THREADSTATE_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: This module defines the ThreadState type and the 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// VG_(threads)[] data structure which holds all the important thread 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// state. It also defines some simple operations on the data structure 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// that don't require any external help. (m_scheduler does the complex 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// stuff). 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_threadstate.h" 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/ 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Types ---*/ 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/ 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Thread state machine: 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Empty -> Init -> Runnable <=> WaitSys/Yielding 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ^ | 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown \---- Zombie -----/ 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown */ 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown enum ThreadStatus { 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgTs_Empty, /* this slot is not in use */ 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgTs_Init, /* just allocated */ 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgTs_Runnable, /* ready to run */ 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgTs_WaitSys, /* waiting for a syscall to complete */ 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgTs_Yielding, /* temporarily yielding the CPU */ 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgTs_Zombie, /* transient state just before exiting */ 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadStatus; 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Return codes from the scheduler. */ 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown enum { 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgSrc_None, /* not exiting yet */ 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgSrc_ExitThread, /* just this thread is exiting */ 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgSrc_ExitProcess, /* entire process is exiting */ 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgSrc_FatalSig /* Killed by the default action of a fatal 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown signal */ 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgSchedReturnCode; 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(VGA_x86) 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown typedef VexGuestX86State VexGuestArchState; 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGA_amd64) 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown typedef VexGuestAMD64State VexGuestArchState; 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGA_ppc32) 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown typedef VexGuestPPC32State VexGuestArchState; 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGA_ppc64) 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown typedef VexGuestPPC64State VexGuestArchState; 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGA_arm) 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown typedef VexGuestARMState VexGuestArchState; 88b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov#elif defined(VGA_s390x) 89b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov typedef VexGuestS390XState VexGuestArchState; 90663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng#elif defined(VGA_mips32) 91663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng typedef VexGuestMIPS32State VexGuestArchState; 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error Unknown architecture 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Forward declarations */ 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct SyscallStatus; 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct SyscallArgs; 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Architecture-specific thread state */ 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* --- BEGIN vex-mandated guest state --- */ 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Note that for code generation reasons, we require that the 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown guest state area, its two shadows, and the spill area, are 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 16-aligned and have 16-aligned sizes, and there are no holes 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown in between. This is checked by do_pre_run_checks() in 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown scheduler.c. */ 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Saved machine context. */ 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VexGuestArchState vex __attribute__((aligned(16))); 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Saved shadow context (2 copies). */ 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VexGuestArchState vex_shadow1 __attribute__((aligned(16))); 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VexGuestArchState vex_shadow2 __attribute__((aligned(16))); 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Spill area. */ 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UChar vex_spill[LibVEX_N_SPILL_BYTES] __attribute__((aligned(16))); 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* --- END vex-mandated guest state --- */ 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadArchState; 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* OS-specific thread state. IMPORTANT: if you add fields to this, 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown you _must_ add code to os_state_clear() to initialise those 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown fields. */ 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* who we are */ 132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int lwpid; // PID of kernel task (Darwin: Mach thread) 133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int threadgroup; // thread group id 134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadId parent; // parent tid (if any) 136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* runtime details */ 138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr valgrind_stack_base; // Valgrind's stack (VgStack*) 139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr valgrind_stack_init_SP; // starting value for SP 140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* exit details */ 142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Word exitcode; // in the case of exitgroup, set by someone else 143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int fatalsig; // fatal signal 144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# if defined(VGO_darwin) 146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // Mach trap POST handler as chosen by PRE 147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown void (*post_mach_trap_fn)(ThreadId tid, 148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct SyscallArgs *, struct SyscallStatus *); 149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // This thread's pthread 151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr pthread; 152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // Argument passed when thread started 154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr func_arg; 155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // Synchronization between child thread and parent thread's POST wrapper 157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown semaphore_t child_go; 158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown semaphore_t child_done; 159ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 160ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // Workqueue re-entry 161ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // (setjmp in PRE(workq_ops), longjmp in wqthread_hijack) 162ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // DDD: JRS fixme: this comment is no longer correct; wq_jmpbuf is 163ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // never used, and there is no such setjmp or longjmp pair. 164ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // I guess we could leave wq_jmpbuf_valid in place though, since 165ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // it does allow for an assertion in ML_(wqthread_continue_NORETURN). 166ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool wq_jmpbuf_valid; 167ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown //jmp_buf wq_jmpbuf; 168ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 169ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown // Values saved from transient Mach RPC messages 170ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr remote_port; // destination for original message 171ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int msgh_id; // outgoing message id 172ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown union { 173ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 174ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr port; 175ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_port; 176ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 177ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int right; 178ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_port_allocate; 179ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 180ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr port; 181ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int right; 182ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int delta; 183ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_port_mod_refs; 184ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 185ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr task; 186ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr name; 187ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int disposition; 188ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_port_insert_right; 189ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 190ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr size; 191ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown int flags; 192ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_allocate; 193ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 194ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr address; 195ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr size; 196ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_deallocate; 197ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 198ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr src; 199ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr dst; 200ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr size; 201ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_copy; 202ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 203ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr address; 204ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr size; 205ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown int set_maximum; 206ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord new_protection; 207ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_protect; 208ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 209ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr addr; 210ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT size; 211ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_read; 212ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 213ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong addr; 214ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong size; 215ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_vm_read; 216ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 217ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr addr; 218ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT size; 219ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr data; 220ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_read_overwrite; 221ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 222ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr size; 223ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown int copy; 224ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord protection; 225ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_map; 226ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 227ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr size; 228ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } vm_remap; 229ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 230ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong size; 231ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown int flags; 232ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_vm_allocate; 233ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 234ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong address; 235ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong size; 236ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_vm_deallocate; 237ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 238ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong address; 239ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong size; 240ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown int set_maximum; 241ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown unsigned int new_protection; 242ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_vm_protect; 243ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 244ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong size; 245ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown int copy; 246ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord protection; 247ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_vm_map; 248ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 249ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr thread; 250ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UWord flavor; 251ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } thread_get_state; 252ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 253ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr address; 254ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } io_connect_unmap_memory; 255ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 256ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown int which_port; 257ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } task_get_special_port; 258ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 259ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown char *service_name; 260ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } bootstrap_look_up; 261ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 262ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown vki_size_t size; 263ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } WindowServer_29828; 264ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 265ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Int access_rights; 266ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } WindowServer_29831; 267ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 268ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown char *path; 269ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } io_registry_entry_from_path; 270ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } mach_args; 271ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# endif 272ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 273ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 274ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadOSstate; 275ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 276ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 277ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Overall thread state */ 278ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef struct { 279ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ThreadId == 0 (and hence vg_threads[0]) is NEVER USED. 280ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The thread identity is simply the index in vg_threads[]. 281ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadId == 1 is the root thread and has the special property 282ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown that we don't try and allocate or deallocate its stack. For 283ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown convenience of generating error message, we also put the 284ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadId in this tid field, but be aware that it should 285ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ALWAYS == the index in vg_threads[]. */ 286ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadId tid; 287ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 288ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Current scheduling status. */ 289ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadStatus status; 290ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 291ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* This is set if the thread is in the process of exiting for any 292ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown reason. The precise details of the exit are in the OS-specific 293ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown state. */ 294ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VgSchedReturnCode exitreason; 295ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 296ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Architecture-specific thread state. */ 297ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadArchState arch; 298ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 299ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* This thread's blocked-signals mask. Semantics is that for a 300ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown signal to be delivered to this thread, the signal must not be 301ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown blocked by this signal mask. If more than one thread accepts a 302ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown signal, then it will be delivered to one at random. If all 303ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown threads block the signal, it will remain pending until either a 304ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown thread unblocks it or someone uses sigwaitsig/sigtimedwait. */ 305ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown vki_sigset_t sig_mask; 306ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 307ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* tmp_sig_mask is usually the same as sig_mask, and is kept in 308ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown sync whenever sig_mask is changed. The only time they have 309ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown different values is during the execution of a sigsuspend, where 310ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown tmp_sig_mask is the temporary mask which sigsuspend installs. 311ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown It is only consulted to compute the signal mask applied to a 312ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown signal handler. */ 313ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown vki_sigset_t tmp_sig_mask; 314ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 315ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* A little signal queue for signals we can't get the kernel to 316ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown queue for us. This is only allocated as needed, since it should 317ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown be rare. */ 318ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct SigQueue *sig_queue; 319ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 320ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Client stacks. When a thread slot is freed, we don't deallocate its 321ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown stack; we just leave it lying around for the next use of the 322ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown slot. If the next use of the slot requires a larger stack, 323ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown only then is the old one deallocated and a new one 324ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown allocated. 325ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 326ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown For the main thread (threadid == 1), this mechanism doesn't 327ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown apply. We don't know the size of the stack since we didn't 328ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown allocate it, and furthermore we never reallocate it. */ 329ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 330ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* The allocated size of this thread's stack */ 331ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT client_stack_szB; 332ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 333ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Address of the highest legitimate word in this stack. This is 334ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown used for error messages only -- not critical for execution 335ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown correctness. Is is set for all stacks, specifically including 336ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadId == 1 (the main thread). */ 337ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr client_stack_highest_word; 338ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 339ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Alternate signal stack */ 340ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown vki_stack_t altstack; 341ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 342ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* OS-specific thread state */ 343ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadOSstate os_state; 344ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 345b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov /* Error disablement level. A counter which allows selectively 346b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov disabling error reporting in threads. When zero, reporting is 347b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov enabled. When nonzero, it is disabled. This is controlled by 348b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov the client request 'VG_USERREQ__CHANGE_ERR_DISABLEMENT'. New 349b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov threads are always created with this as zero (errors 350b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov enabled). */ 351b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov UInt err_disablement_level; 352b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov 353ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Per-thread jmp_buf to resume scheduler after a signal */ 354b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov Bool sched_jmpbuf_valid; 355b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov VG_MINIMAL_JMP_BUF(sched_jmpbuf); 356ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 357ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownThreadState; 358ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 359ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 360ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/ 361ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- The thread table. ---*/ 362ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/ 363ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 364ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* A statically allocated array of threads. NOTE: [0] is 365ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown never used, to simplify the simulation of initialisers for 366ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown LinuxThreads. */ 367ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ThreadState VG_(threads)[VG_N_THREADS]; 368ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 369ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// The running thread. m_scheduler should be the only other module 370ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// to write to this. 371ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ThreadId VG_(running_tid); 372ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 373ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 374ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/ 375ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Basic operations on the thread table. ---*/ 376ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/ 377ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 378663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng/* Initialize the m_threadstate module. */ 379663860b1408516d02ebfcb3a9999a134e6cfb223Ben Chengvoid VG_(init_Threads)(void); 380663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng 381ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Convert a ThreadStatus to a string. 382ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownconst HChar* VG_(name_of_ThreadStatus) ( ThreadStatus status ); 383ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 384ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Get the ThreadState for a particular thread */ 385ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ThreadState *VG_(get_ThreadState) ( ThreadId tid ); 386ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 387ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Check that tid is in range and denotes a non-Empty thread. */ 388ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(is_valid_tid) ( ThreadId tid ); 389ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 390ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Returns true if a thread is currently running (ie, has the CPU lock) */ 391ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(is_running_thread)(ThreadId tid); 392ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 393ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Returns true if the thread is in the process of exiting */ 394ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(is_exiting)(ThreadId tid); 395ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 396ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Return the number of non-dead Threads */ 397ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(count_living_threads)(void); 398ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 399ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Return the number of threads in VgTs_Runnable state */ 400ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(count_runnable_threads)(void); 401ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 402ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Given an LWP id (ie, real kernel thread id), find the corresponding 403ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ThreadId */ 404ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern ThreadId VG_(lwpid_to_vgtid)(Int lwpid); 405ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 406ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_CORE_THREADSTATE_H 407ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 408ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 409ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 410ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 411