drd_thread.h revision bf80e12418014298bef23cddea3249dee74e5b96
1af44c8236f7a73e71b16b707bba56f33af4d01cesewardj/* 2af44c8236f7a73e71b16b707bba56f33af4d01cesewardj This file is part of drd, a data race detector. 3af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 48564292ac4b9adf51c45517cca2878732feb5bb4sewardj Copyright (C) 2006-2008 Bart Van Assche 5af44c8236f7a73e71b16b707bba56f33af4d01cesewardj bart.vanassche@gmail.com 6af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 7af44c8236f7a73e71b16b707bba56f33af4d01cesewardj This program is free software; you can redistribute it and/or 8af44c8236f7a73e71b16b707bba56f33af4d01cesewardj modify it under the terms of the GNU General Public License as 9af44c8236f7a73e71b16b707bba56f33af4d01cesewardj published by the Free Software Foundation; either version 2 of the 10af44c8236f7a73e71b16b707bba56f33af4d01cesewardj License, or (at your option) any later version. 11af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 12af44c8236f7a73e71b16b707bba56f33af4d01cesewardj This program is distributed in the hope that it will be useful, but 13af44c8236f7a73e71b16b707bba56f33af4d01cesewardj WITHOUT ANY WARRANTY; without even the implied warranty of 14af44c8236f7a73e71b16b707bba56f33af4d01cesewardj MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15af44c8236f7a73e71b16b707bba56f33af4d01cesewardj General Public License for more details. 16af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 17af44c8236f7a73e71b16b707bba56f33af4d01cesewardj You should have received a copy of the GNU General Public License 18af44c8236f7a73e71b16b707bba56f33af4d01cesewardj along with this program; if not, write to the Free Software 19af44c8236f7a73e71b16b707bba56f33af4d01cesewardj Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 20af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 02111-1307, USA. 21af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 22af44c8236f7a73e71b16b707bba56f33af4d01cesewardj The GNU General Public License is contained in the file COPYING. 23af44c8236f7a73e71b16b707bba56f33af4d01cesewardj*/ 24af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 25af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 26af44c8236f7a73e71b16b707bba56f33af4d01cesewardj#ifndef __THREAD_H 27af44c8236f7a73e71b16b707bba56f33af4d01cesewardj#define __THREAD_H 28af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 29af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 30f00a85bc55a2790c31670dd21e449a335c739068bart// Includes. 31f00a85bc55a2790c31670dd21e449a335c739068bart 32af44c8236f7a73e71b16b707bba56f33af4d01cesewardj#include "drd_segment.h" 33f00a85bc55a2790c31670dd21e449a335c739068bart#include "pub_tool_libcassert.h" // tl_assert() 34f00a85bc55a2790c31670dd21e449a335c739068bart#include "pub_tool_stacktrace.h" // StackTrace 35f00a85bc55a2790c31670dd21e449a335c739068bart#include "pub_tool_threadstate.h" // VG_N_THREADS 36f00a85bc55a2790c31670dd21e449a335c739068bart 37f00a85bc55a2790c31670dd21e449a335c739068bart 38f00a85bc55a2790c31670dd21e449a335c739068bart// Defines. 39af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 40f00a85bc55a2790c31670dd21e449a335c739068bart#define DRD_N_THREADS VG_N_THREADS 41af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 42af44c8236f7a73e71b16b707bba56f33af4d01cesewardj#define DRD_INVALID_THREADID 0 43af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 44af44c8236f7a73e71b16b707bba56f33af4d01cesewardj/* Note: the PThreadId typedef and the INVALID_POSIX_THREADID depend on the */ 45af44c8236f7a73e71b16b707bba56f33af4d01cesewardj/* operating system and threading library in use. PThreadId must contain at */ 46af44c8236f7a73e71b16b707bba56f33af4d01cesewardj/* least the same number of bits as pthread_t, and INVALID_POSIX_THREADID */ 47af44c8236f7a73e71b16b707bba56f33af4d01cesewardj/* must be a value that will never be returned by pthread_self(). */ 48af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 49af44c8236f7a73e71b16b707bba56f33af4d01cesewardj#define INVALID_POSIX_THREADID ((PThreadId)0) 50af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 51af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 52f00a85bc55a2790c31670dd21e449a335c739068bart// Type definitions. 53f00a85bc55a2790c31670dd21e449a335c739068bart 54af44c8236f7a73e71b16b707bba56f33af4d01cesewardjtypedef UInt DrdThreadId; 55af44c8236f7a73e71b16b707bba56f33af4d01cesewardjtypedef UWord PThreadId; 56af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 57f00a85bc55a2790c31670dd21e449a335c739068barttypedef struct 58f00a85bc55a2790c31670dd21e449a335c739068bart{ 591a473c757cae99f11477440d5473be6e5c95e0cebart Segment* first; 601a473c757cae99f11477440d5473be6e5c95e0cebart Segment* last; 611a473c757cae99f11477440d5473be6e5c95e0cebart ThreadId vg_threadid; 621a473c757cae99f11477440d5473be6e5c95e0cebart PThreadId pt_threadid; 63cac5346ef470359941b12d879608e5f3386b44febart Addr stack_min_min; /** Lowest value stack pointer ever had. */ 64cac5346ef470359941b12d879608e5f3386b44febart Addr stack_min; /** Current stack pointer. */ 65cac5346ef470359941b12d879608e5f3386b44febart Addr stack_startup; /** Stack pointer after pthread_create() finished.*/ 66cac5346ef470359941b12d879608e5f3386b44febart Addr stack_max; /** Top of stack. */ 67cac5346ef470359941b12d879608e5f3386b44febart SizeT stack_size; /** Maximum size of stack. */ 681a473c757cae99f11477440d5473be6e5c95e0cebart /// Indicates whether the Valgrind core knows about this thread. 691a473c757cae99f11477440d5473be6e5c95e0cebart Bool vg_thread_exists; 701a473c757cae99f11477440d5473be6e5c95e0cebart /// Indicates whether there is an associated POSIX thread ID. 711a473c757cae99f11477440d5473be6e5c95e0cebart Bool posix_thread_exists; 721a473c757cae99f11477440d5473be6e5c95e0cebart /// If true, indicates that there is a corresponding POSIX thread ID and 731a473c757cae99f11477440d5473be6e5c95e0cebart /// a corresponding OS thread that is detached. 741a473c757cae99f11477440d5473be6e5c95e0cebart Bool detached_posix_thread; 751a473c757cae99f11477440d5473be6e5c95e0cebart /// Wether recording of memory accesses is active. 761a473c757cae99f11477440d5473be6e5c95e0cebart Bool is_recording; 771a473c757cae99f11477440d5473be6e5c95e0cebart /// Nesting level of synchronization functions called by the client. 781a473c757cae99f11477440d5473be6e5c95e0cebart Int synchr_nesting; 79f00a85bc55a2790c31670dd21e449a335c739068bart} ThreadInfo; 80f00a85bc55a2790c31670dd21e449a335c739068bart 81f00a85bc55a2790c31670dd21e449a335c739068bart 82f00a85bc55a2790c31670dd21e449a335c739068bart// Local variables of drd_thread.c that are declared here such that these 83f00a85bc55a2790c31670dd21e449a335c739068bart// can be accessed by inline functions. 84f00a85bc55a2790c31670dd21e449a335c739068bart 85f00a85bc55a2790c31670dd21e449a335c739068bartextern DrdThreadId s_drd_running_tid; 86f00a85bc55a2790c31670dd21e449a335c739068bartextern ThreadInfo s_threadinfo[DRD_N_THREADS]; 871a473c757cae99f11477440d5473be6e5c95e0cebartextern struct bitmap* s_danger_set; 88f00a85bc55a2790c31670dd21e449a335c739068bart 89f00a85bc55a2790c31670dd21e449a335c739068bart 90f00a85bc55a2790c31670dd21e449a335c739068bart// Function declarations. 91af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 9226f73e12ef03bb04ebee5cccd8da08cddb426341bartvoid thread_trace_context_switches(const Bool t); 9326f73e12ef03bb04ebee5cccd8da08cddb426341bartvoid thread_trace_danger_set(const Bool t); 94a9c37398e4565280266ce663a6c38c3518af2812bartvoid thread_set_segment_merging(const Bool m); 95af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 96af44c8236f7a73e71b16b707bba56f33af4d01cesewardjDrdThreadId VgThreadIdToDrdThreadId(const ThreadId tid); 97af44c8236f7a73e71b16b707bba56f33af4d01cesewardjDrdThreadId NewVgThreadIdToDrdThreadId(const ThreadId tid); 98af44c8236f7a73e71b16b707bba56f33af4d01cesewardjDrdThreadId PtThreadIdToDrdThreadId(const PThreadId tid); 99af44c8236f7a73e71b16b707bba56f33af4d01cesewardjThreadId DrdThreadIdToVgThreadId(const DrdThreadId tid); 100af44c8236f7a73e71b16b707bba56f33af4d01cesewardjDrdThreadId thread_pre_create(const DrdThreadId creator, 101af44c8236f7a73e71b16b707bba56f33af4d01cesewardj const ThreadId vg_created); 102af44c8236f7a73e71b16b707bba56f33af4d01cesewardjDrdThreadId thread_post_create(const ThreadId vg_created); 103af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_delete(const DrdThreadId tid); 104af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_finished(const DrdThreadId tid); 105af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_set_stack_startup(const DrdThreadId tid, const Addr stack_startup); 106af44c8236f7a73e71b16b707bba56f33af4d01cesewardjAddr thread_get_stack_min(const DrdThreadId tid); 107cac5346ef470359941b12d879608e5f3386b44febartAddr thread_get_stack_min_min(const DrdThreadId tid); 108d43f8d3d9f5b2b2096c19d732d98c4382c53da4bbartAddr thread_get_stack_max(const DrdThreadId tid); 109cac5346ef470359941b12d879608e5f3386b44febartSizeT thread_get_stack_size(const DrdThreadId tid); 110af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_set_pthreadid(const DrdThreadId tid, const PThreadId ptid); 111af44c8236f7a73e71b16b707bba56f33af4d01cesewardjBool thread_get_joinable(const DrdThreadId tid); 112af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_set_joinable(const DrdThreadId tid, const Bool joinable); 1138b09d4f037c6399658b610228c7bbc0c6133d9dasewardjvoid thread_set_vg_running_tid(const ThreadId vg_tid); 1148b09d4f037c6399658b610228c7bbc0c6133d9dasewardjvoid thread_set_running_tid(const ThreadId vg_tid, 1158b09d4f037c6399658b610228c7bbc0c6133d9dasewardj const DrdThreadId drd_tid); 1160268dfacec38138a01a58d05a038826e26b6c436bartint thread_enter_synchr(const DrdThreadId tid); 1170268dfacec38138a01a58d05a038826e26b6c436bartint thread_leave_synchr(const DrdThreadId tid); 1180268dfacec38138a01a58d05a038826e26b6c436bartint thread_get_synchr_nesting_count(const DrdThreadId tid); 119af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_new_segment(const DrdThreadId tid); 120af44c8236f7a73e71b16b707bba56f33af4d01cesewardjVectorClock* thread_get_vc(const DrdThreadId tid); 121a2b6e1bbcc45fcb42ac0441a2e5b4d40c3671ec6bartvoid thread_get_latest_segment(Segment** sg, const DrdThreadId tid); 122af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_combine_vc(const DrdThreadId joiner, const DrdThreadId joinee); 123af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_combine_vc2(const DrdThreadId tid, const VectorClock* const vc); 124dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bart 125dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_load_1_triggers_conflict(const Addr a1); 126dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_load_2_triggers_conflict(const Addr a1); 127dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_load_4_triggers_conflict(const Addr a1); 128dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_load_8_triggers_conflict(const Addr a1); 129dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_load_triggers_conflict(const Addr a1, const Addr a2); 130dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_store_1_triggers_conflict(const Addr a1); 131dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_store_2_triggers_conflict(const Addr a1); 132dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_store_4_triggers_conflict(const Addr a1); 133dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_store_8_triggers_conflict(const Addr a1); 134dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bartBool bm_access_store_triggers_conflict(const Addr a1, const Addr a2); 135dfbae6e4dd55ec44ade79a92fe70317b8dbefd88bart 136af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_stop_using_mem(const Addr a1, const Addr a2); 1370268dfacec38138a01a58d05a038826e26b6c436bartvoid thread_start_recording(const DrdThreadId tid); 1380268dfacec38138a01a58d05a038826e26b6c436bartvoid thread_stop_recording(const DrdThreadId tid); 139af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_print_all(void); 140af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_report_races(const DrdThreadId tid); 141af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_report_races_segment(const DrdThreadId tid, 142af44c8236f7a73e71b16b707bba56f33af4d01cesewardj const Segment* const p); 143af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_report_all_races(void); 144af44c8236f7a73e71b16b707bba56f33af4d01cesewardjvoid thread_report_conflicting_segments(const DrdThreadId tid, 145af44c8236f7a73e71b16b707bba56f33af4d01cesewardj const Addr addr, 146af44c8236f7a73e71b16b707bba56f33af4d01cesewardj const SizeT size, 147af44c8236f7a73e71b16b707bba56f33af4d01cesewardj const BmAccessTypeT access_type); 148af44c8236f7a73e71b16b707bba56f33af4d01cesewardjULong thread_get_context_switch_count(void); 149af44c8236f7a73e71b16b707bba56f33af4d01cesewardjULong thread_get_report_races_count(void); 150af44c8236f7a73e71b16b707bba56f33af4d01cesewardjULong thread_get_discard_ordered_segments_count(void); 151d66e3a8e8c42b7c933c5e6ea0d9a9b4c8ac4cf49bartULong thread_get_update_danger_set_count(ULong* dsnsc, ULong* dscvc); 152af44c8236f7a73e71b16b707bba56f33af4d01cesewardjULong thread_get_danger_set_bitmap_creation_count(void); 153af44c8236f7a73e71b16b707bba56f33af4d01cesewardjULong thread_get_danger_set_bitmap2_creation_count(void); 154af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 155af44c8236f7a73e71b16b707bba56f33af4d01cesewardj 156bf80e12418014298bef23cddea3249dee74e5b96bartstatic __inline__ 157bf80e12418014298bef23cddea3249dee74e5b96bartBool IsValidDrdThreadId(const DrdThreadId tid) 158bf80e12418014298bef23cddea3249dee74e5b96bart{ 159bf80e12418014298bef23cddea3249dee74e5b96bart return (0 <= (int)tid && tid < DRD_N_THREADS && tid != DRD_INVALID_THREADID 160bf80e12418014298bef23cddea3249dee74e5b96bart && ! (s_threadinfo[tid].vg_thread_exists == False 161bf80e12418014298bef23cddea3249dee74e5b96bart && s_threadinfo[tid].posix_thread_exists == False 162bf80e12418014298bef23cddea3249dee74e5b96bart && s_threadinfo[tid].detached_posix_thread == False)); 163bf80e12418014298bef23cddea3249dee74e5b96bart} 164bf80e12418014298bef23cddea3249dee74e5b96bart 1651ea5fff9a68ea6d56cb946eb709838bd40562a79bartstatic inline 1661ea5fff9a68ea6d56cb946eb709838bd40562a79bartDrdThreadId thread_get_running_tid(void) 1671ea5fff9a68ea6d56cb946eb709838bd40562a79bart{ 1681ea5fff9a68ea6d56cb946eb709838bd40562a79bart tl_assert(s_drd_running_tid != DRD_INVALID_THREADID); 1691ea5fff9a68ea6d56cb946eb709838bd40562a79bart return s_drd_running_tid; 1701ea5fff9a68ea6d56cb946eb709838bd40562a79bart} 1711ea5fff9a68ea6d56cb946eb709838bd40562a79bart 1721ea5fff9a68ea6d56cb946eb709838bd40562a79bartstatic inline 1731ea5fff9a68ea6d56cb946eb709838bd40562a79bartstruct bitmap* thread_get_danger_set(void) 1741a473c757cae99f11477440d5473be6e5c95e0cebart{ 1751a473c757cae99f11477440d5473be6e5c95e0cebart return s_danger_set; 1761a473c757cae99f11477440d5473be6e5c95e0cebart} 1771a473c757cae99f11477440d5473be6e5c95e0cebart 178f00a85bc55a2790c31670dd21e449a335c739068bartstatic inline 179f00a85bc55a2790c31670dd21e449a335c739068bartBool running_thread_is_recording(void) 180f00a85bc55a2790c31670dd21e449a335c739068bart{ 18174a5f21b1495a9e28c648b179b821ffb23484244bart tl_assert(0 <= (int)s_drd_running_tid && s_drd_running_tid < DRD_N_THREADS 1821a473c757cae99f11477440d5473be6e5c95e0cebart && s_drd_running_tid != DRD_INVALID_THREADID); 1831a473c757cae99f11477440d5473be6e5c95e0cebart return (s_threadinfo[s_drd_running_tid].synchr_nesting == 0 1841a473c757cae99f11477440d5473be6e5c95e0cebart && s_threadinfo[s_drd_running_tid].is_recording); 1851a473c757cae99f11477440d5473be6e5c95e0cebart} 1861a473c757cae99f11477440d5473be6e5c95e0cebart 1871ea5fff9a68ea6d56cb946eb709838bd40562a79bartstatic inline 1881ea5fff9a68ea6d56cb946eb709838bd40562a79bartvoid thread_set_stack_min(const DrdThreadId tid, const Addr stack_min) 1891ea5fff9a68ea6d56cb946eb709838bd40562a79bart{ 1901ea5fff9a68ea6d56cb946eb709838bd40562a79bart#if 0 1911ea5fff9a68ea6d56cb946eb709838bd40562a79bart tl_assert(0 <= tid && tid < DRD_N_THREADS && tid != DRD_INVALID_THREADID); 1921ea5fff9a68ea6d56cb946eb709838bd40562a79bart#endif 193e773de4785187ef787703968b13cdf76b4721cb7bart s_threadinfo[tid].stack_min = stack_min; 1941ea5fff9a68ea6d56cb946eb709838bd40562a79bart#if 0 195fda6492f6b5c2c91fd7b46e94bb696adca553c81bart /* This function can be called after the thread has been created but */ 196fda6492f6b5c2c91fd7b46e94bb696adca553c81bart /* before drd_post_thread_create() has filled in stack_max. */ 197fda6492f6b5c2c91fd7b46e94bb696adca553c81bart tl_assert(s_threadinfo[tid].stack_min < s_threadinfo[tid].stack_max 198fda6492f6b5c2c91fd7b46e94bb696adca553c81bart || s_threadinfo[tid].stack_max == 0); 1991ea5fff9a68ea6d56cb946eb709838bd40562a79bart#endif 200e773de4785187ef787703968b13cdf76b4721cb7bart if (UNLIKELY(stack_min < s_threadinfo[tid].stack_min_min)) 201e773de4785187ef787703968b13cdf76b4721cb7bart { 202e773de4785187ef787703968b13cdf76b4721cb7bart s_threadinfo[tid].stack_min_min = stack_min; 2031ea5fff9a68ea6d56cb946eb709838bd40562a79bart } 2041ea5fff9a68ea6d56cb946eb709838bd40562a79bart} 2051ea5fff9a68ea6d56cb946eb709838bd40562a79bart 2061a473c757cae99f11477440d5473be6e5c95e0cebart/** Return a pointer to the latest segment for the specified thread. */ 2071a473c757cae99f11477440d5473be6e5c95e0cebartstatic inline 2081a473c757cae99f11477440d5473be6e5c95e0cebartSegment* thread_get_segment(const DrdThreadId tid) 2091a473c757cae99f11477440d5473be6e5c95e0cebart{ 21074a5f21b1495a9e28c648b179b821ffb23484244bart tl_assert(0 <= (int)tid && tid < DRD_N_THREADS 2111a473c757cae99f11477440d5473be6e5c95e0cebart && tid != DRD_INVALID_THREADID); 2121a473c757cae99f11477440d5473be6e5c95e0cebart tl_assert(s_threadinfo[tid].last); 2131a473c757cae99f11477440d5473be6e5c95e0cebart return s_threadinfo[tid].last; 214f00a85bc55a2790c31670dd21e449a335c739068bart} 215f00a85bc55a2790c31670dd21e449a335c739068bart 216a79df6ed701ed416ba6241e5b0dd95fae8fa35f9bart/** Return a pointer to the latest segment for the running thread. */ 217a79df6ed701ed416ba6241e5b0dd95fae8fa35f9bartstatic inline 218a79df6ed701ed416ba6241e5b0dd95fae8fa35f9bartSegment* running_thread_get_segment(void) 219a79df6ed701ed416ba6241e5b0dd95fae8fa35f9bart{ 220a79df6ed701ed416ba6241e5b0dd95fae8fa35f9bart return thread_get_segment(s_drd_running_tid); 221a79df6ed701ed416ba6241e5b0dd95fae8fa35f9bart} 222f00a85bc55a2790c31670dd21e449a335c739068bart 223af44c8236f7a73e71b16b707bba56f33af4d01cesewardj#endif // __THREAD_H 224