Home | History | Annotate | Download | only in coregrind
      1 
      2 /*--------------------------------------------------------------------*/
      3 /*--- The thread state.                            m_threadstate.c ---*/
      4 /*--------------------------------------------------------------------*/
      5 
      6 /*
      7    This file is part of Valgrind, a dynamic binary instrumentation
      8    framework.
      9 
     10    Copyright (C) 2000-2013 Julian Seward
     11       jseward (at) acm.org
     12 
     13    This program is free software; you can redistribute it and/or
     14    modify it under the terms of the GNU General Public License as
     15    published by the Free Software Foundation; either version 2 of the
     16    License, or (at your option) any later version.
     17 
     18    This program is distributed in the hope that it will be useful, but
     19    WITHOUT ANY WARRANTY; without even the implied warranty of
     20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     21    General Public License for more details.
     22 
     23    You should have received a copy of the GNU General Public License
     24    along with this program; if not, write to the Free Software
     25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
     26    02111-1307, USA.
     27 
     28    The GNU General Public License is contained in the file COPYING.
     29 */
     30 
     31 #include "pub_core_basics.h"
     32 #include "pub_core_vki.h"
     33 #include "pub_core_libcsetjmp.h"    // to keep _threadstate.h happy
     34 #include "pub_core_threadstate.h"
     35 #include "pub_core_libcassert.h"
     36 #include "pub_core_inner.h"
     37 #if defined(ENABLE_INNER_CLIENT_REQUEST)
     38 #include "helgrind/helgrind.h"
     39 #endif
     40 
     41 /*------------------------------------------------------------*/
     42 /*--- Data structures.                                     ---*/
     43 /*------------------------------------------------------------*/
     44 
     45 ThreadId VG_(running_tid) = VG_INVALID_THREADID;
     46 
     47 ThreadState VG_(threads)[VG_N_THREADS] __attribute__((aligned(16)));
     48 
     49 /*------------------------------------------------------------*/
     50 /*--- Operations.                                          ---*/
     51 /*------------------------------------------------------------*/
     52 
     53 void VG_(init_Threads)(void)
     54 {
     55    ThreadId tid;
     56 
     57    for (tid = 1; tid < VG_N_THREADS; tid++) {
     58       INNER_REQUEST(
     59          ANNOTATE_BENIGN_RACE_SIZED(&VG_(threads)[tid].status,
     60                                     sizeof(VG_(threads)[tid].status), ""));
     61       INNER_REQUEST(
     62          ANNOTATE_BENIGN_RACE_SIZED(&VG_(threads)[tid].os_state.exitcode,
     63                                     sizeof(VG_(threads)[tid].os_state.exitcode),
     64                                     ""));
     65    }
     66 }
     67 
     68 const HChar* VG_(name_of_ThreadStatus) ( ThreadStatus status )
     69 {
     70    switch (status) {
     71    case VgTs_Empty:     return "VgTs_Empty";
     72    case VgTs_Init:      return "VgTs_Init";
     73    case VgTs_Runnable:  return "VgTs_Runnable";
     74    case VgTs_WaitSys:   return "VgTs_WaitSys";
     75    case VgTs_Yielding:  return "VgTs_Yielding";
     76    case VgTs_Zombie:    return "VgTs_Zombie";
     77    default:             return "VgTs_???";
     78   }
     79 }
     80 
     81 const HChar* VG_(name_of_VgSchedReturnCode) ( VgSchedReturnCode retcode )
     82 {
     83    switch (retcode) {
     84    case VgSrc_None:        return "VgSrc_None";
     85    case VgSrc_ExitThread:  return "VgSrc_ExitThread";
     86    case VgSrc_ExitProcess: return "VgSrc_ExitProcess";
     87    case VgSrc_FatalSig:    return "VgSrc_FatalSig";
     88    default:                return "VgSrc_???";
     89   }
     90 }
     91 
     92 ThreadState *VG_(get_ThreadState)(ThreadId tid)
     93 {
     94    vg_assert(tid >= 0 && tid < VG_N_THREADS);
     95    vg_assert(VG_(threads)[tid].tid == tid);
     96    return &VG_(threads)[tid];
     97 }
     98 
     99 Bool VG_(is_valid_tid) ( ThreadId tid )
    100 {
    101    /* tid is unsigned, hence no < 0 test. */
    102    if (tid == 0) return False;
    103    if (tid >= VG_N_THREADS) return False;
    104    if (VG_(threads)[tid].status == VgTs_Empty) return False;
    105    return True;
    106 }
    107 
    108 // This function is for tools to call.
    109 ThreadId VG_(get_running_tid)(void)
    110 {
    111    return VG_(running_tid);
    112 }
    113 
    114 Bool VG_(is_running_thread)(ThreadId tid)
    115 {
    116    ThreadState *tst = VG_(get_ThreadState)(tid);
    117 
    118    return
    119 //      tst->os_state.lwpid == VG_(gettid)() &&	// check we're this tid
    120       VG_(running_tid) == tid	           &&	// and that we've got the lock
    121       tst->status == VgTs_Runnable;		// and we're runnable
    122 }
    123 
    124 /* Return true if the thread is still alive but in the process of exiting. */
    125 inline Bool VG_(is_exiting)(ThreadId tid)
    126 {
    127    vg_assert(VG_(is_valid_tid)(tid));
    128    return VG_(threads)[tid].exitreason != VgSrc_None;
    129 }
    130 
    131 /* Return the number of non-dead Threads */
    132 Int VG_(count_living_threads)(void)
    133 {
    134    Int count = 0;
    135    ThreadId tid;
    136 
    137    for(tid = 1; tid < VG_N_THREADS; tid++)
    138       if (VG_(threads)[tid].status != VgTs_Empty &&
    139 	  VG_(threads)[tid].status != VgTs_Zombie)
    140 	 count++;
    141 
    142    return count;
    143 }
    144 
    145 /* Return the number of threads in VgTs_Runnable state */
    146 Int VG_(count_runnable_threads)(void)
    147 {
    148    Int count = 0;
    149    ThreadId tid;
    150 
    151    for(tid = 1; tid < VG_N_THREADS; tid++)
    152       if (VG_(threads)[tid].status == VgTs_Runnable)
    153 	 count++;
    154 
    155    return count;
    156 }
    157 
    158 /* Given an LWP id (ie, real kernel thread id), find the corresponding
    159    ThreadId */
    160 ThreadId VG_(lwpid_to_vgtid)(Int lwp)
    161 {
    162    ThreadId tid;
    163 
    164    for(tid = 1; tid < VG_N_THREADS; tid++)
    165       if (VG_(threads)[tid].status != VgTs_Empty
    166           && VG_(threads)[tid].os_state.lwpid == lwp)
    167 	 return tid;
    168 
    169    return VG_INVALID_THREADID;
    170 }
    171 
    172 /*--------------------------------------------------------------------*/
    173 /*--- end                                                          ---*/
    174 /*--------------------------------------------------------------------*/
    175