1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Definitions for Locks and Threads. ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- hg_lock_n_thread.c ---*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Helgrind, a Valgrind tool for detecting errors 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown in threaded programs. 10ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 11436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov Copyright (C) 2007-2013 OpenWorks Ltd 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown info@open-works.co.uk 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_basics.h" 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_libcbase.h" 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_libcassert.h" 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_execontext.h" 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_threadstate.h" 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_wordfm.h" 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "hg_basics.h" 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "hg_wordset.h" 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "hg_lock_n_thread.h" /* self */ 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*----------------------------------------------------------------*/ 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Sanity checking ---*/ 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*----------------------------------------------------------------*/ 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browninline Bool HG_(is_sane_Thread) ( Thread* thr ) { 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return thr != NULL && thr->magic == Thread_MAGIC; 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic Bool is_sane_Bag_of_Threads ( WordBag* bag ) 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown{ 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Thread* thr; 55436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov UWord count; 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_(initIterBag)( bag ); 57436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov while (VG_(nextIterBag)( bag, (UWord*)&thr, &count )) { 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (count < 1) return False; 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (!HG_(is_sane_Thread)(thr)) return False; 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_(doneIterBag)( bag ); 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return True; 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstatic Bool is_sane_Lock_BASE ( Lock* lock ) 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown{ 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (lock == NULL 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown || (lock->magic != LockN_MAGIC && lock->magic != LockP_MAGIC)) 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return False; 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown switch (lock->kind) { 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown case LK_mbRec: case LK_nonRec: case LK_rdwr: break; 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown default: return False; 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (lock->heldBy == NULL) { 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (lock->acquired_at != NULL) return False; 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Unheld. We arbitrarily require heldW to be False. */ 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return !lock->heldW; 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } else { 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (lock->acquired_at == NULL) return False; 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* If heldBy is non-NULL, we require it to contain at least one 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown thread. */ 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (VG_(isEmptyBag)(lock->heldBy)) 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return False; 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Lock is either r- or w-held. */ 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (!is_sane_Bag_of_Threads(lock->heldBy)) 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return False; 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (lock->heldW) { 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Held in write-mode */ 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if ((lock->kind == LK_nonRec || lock->kind == LK_rdwr) 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && !VG_(isSingletonTotalBag)(lock->heldBy)) 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return False; 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } else { 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Held in read-mode */ 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown if (lock->kind != LK_rdwr) return False; 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return True; 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(is_sane_LockP) ( Lock* lock ) { 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return lock != NULL 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && lock->magic == LockP_MAGIC 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && lock->hbso == NULL 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && is_sane_Lock_BASE(lock); 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(is_sane_LockN) ( Lock* lock ) { 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return lock != NULL 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && lock->magic == LockN_MAGIC 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && lock->hbso != NULL 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown && is_sane_Lock_BASE(lock); 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool HG_(is_sane_LockNorP) ( Lock* lock ) { 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown return is_sane_Lock_BASE(lock); 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown} 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end hg_lock_n_thread.c ---*/ 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 124