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