15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* 25c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Copyright (C) 2011 Google Inc. All rights reserved. 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Redistribution and use in source and binary forms, with or without 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * modification, are permitted provided that the following conditions are 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * met: 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions of source code must retain the above copyright 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions in binary form must reproduce the above 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * copyright notice, this list of conditions and the following disclaimer 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * in the documentation and/or other materials provided with the 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * distribution. 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Neither the name of Google Inc. nor the names of its 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * contributors may be used to endorse or promote products derived from 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * this software without specific prior written permission. 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#ifndef ThreadRestrictionVerifier_h 325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define ThreadRestrictionVerifier_h 335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 34591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch#include "wtf/Assertions.h" 35591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch#include "wtf/Threading.h" 36591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch#include "wtf/ThreadingPrimitives.h" 375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#include <dispatch/dispatch.h> 405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#ifndef NDEBUG 435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)namespace WTF { 455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Verifies that a class is used in a way that respects its lack of thread-safety. 475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// The default mode is to verify that the object will only be used on a single thread. The 485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// thread gets captured when setShared(true) is called. 495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// The mode may be changed by calling useMutexMode (or turnOffVerification). 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ThreadRestrictionVerifier { 515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ThreadRestrictionVerifier() 535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) : m_mode(SingleThreadVerificationMode) 545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) , m_shared(false) 555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) , m_owningThread(0) 565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) , m_mutex(0) 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) , m_owningQueue(0) 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ~ThreadRestrictionVerifier() 655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if (m_owningQueue) 675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) dispatch_release(m_owningQueue); 685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void setMutexMode(Mutex& mutex) 725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_mode = MutexVerificationMode; 745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_mutex = &mutex; 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void setDispatchQueueMode(dispatch_queue_t queue) 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_mode = SingleDispatchQueueVerificationMode; 815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_owningQueue = queue; 825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) dispatch_retain(m_owningQueue); 835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void turnOffVerification() 875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_mode = NoVerificationMode; 895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Indicates that the object may (or may not) be owned by more than one place. 925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void setShared(bool shared) 935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 945c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if !ASSERT_DISABLED 955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool previouslyShared = m_shared; 965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_shared = shared; 985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if (!m_shared) 1005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return; 1015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) switch (m_mode) { 1035c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case SingleThreadVerificationMode: 1045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ASSERT(shared != previouslyShared); 1055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Capture the current thread to verify that subsequent ref/deref happen on this thread. 1065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_owningThread = currentThread(); 1075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return; 1085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 1105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case SingleDispatchQueueVerificationMode: 1115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 1125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case MutexVerificationMode: 1135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case NoVerificationMode: 1145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return; 1155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ASSERT_NOT_REACHED(); 1175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Is it OK to use the object at this moment on the current thread? 1205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool isSafeToUse() const 1215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if (!m_shared) 1235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return true; 1245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) switch (m_mode) { 1265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case SingleThreadVerificationMode: 1275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return m_owningThread == currentThread(); 1285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case MutexVerificationMode: 1305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if (!m_mutex->tryLock()) 1315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return true; 1325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_mutex->unlock(); 1335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return false; 1345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 1365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case SingleDispatchQueueVerificationMode: 1375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return m_owningQueue == dispatch_get_current_queue(); 1385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 1395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) case NoVerificationMode: 1415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return true; 1425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ASSERT_NOT_REACHED(); 1445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return true; 1455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)private: 1485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) enum VerificationMode { 1495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) SingleThreadVerificationMode, 1505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) MutexVerificationMode, 1515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) NoVerificationMode, 1525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 1535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) SingleDispatchQueueVerificationMode, 1545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 1555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) }; 1565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) VerificationMode m_mode; 1585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool m_shared; 1595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Used by SingleThreadVerificationMode 1615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ThreadIdentifier m_owningThread; 1625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Used by MutexVerificationMode. 1645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) Mutex* m_mutex; 1655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#if HAVE(DISPATCH_H) 1675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Used by SingleDispatchQueueVerificationMode. 1685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) dispatch_queue_t m_owningQueue; 1695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 1705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 1715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} 1735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 1755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 176