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" 35197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch 36197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#if ENABLE(ASSERT) 37197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch 38591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch#include "wtf/Threading.h" 395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)namespace WTF { 415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Verifies that a class is used in a way that respects its lack of thread-safety. 435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// The default mode is to verify that the object will only be used on a single thread. The 445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// thread gets captured when setShared(true) is called. 455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// The mode may be changed by calling useMutexMode (or turnOffVerification). 465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class ThreadRestrictionVerifier { 475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ThreadRestrictionVerifier() 49c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) : m_shared(false) 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) , m_owningThread(0) 515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Indicates that the object may (or may not) be owned by more than one place. 555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void setShared(bool shared) 565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool previouslyShared = m_shared; 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_shared = shared; 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if (!m_shared) 615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return; 625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 63c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) ASSERT(shared != previouslyShared); 64c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) // Capture the current thread to verify that subsequent ref/deref happen on this thread. 65c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) m_owningThread = currentThread(); 665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Is it OK to use the object at this moment on the current thread? 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool isSafeToUse() const 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) if (!m_shared) 725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return true; 735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 74c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) return m_owningThread == currentThread(); 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)private: 785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool m_shared; 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // Used by SingleThreadVerificationMode 815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ThreadIdentifier m_owningThread; 825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 86197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#endif // ENABLE(ASSERT) 87c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles)#endif // ThreadRestrictionVerifier_h 88