/usr/include/x86_64-linux-gnu/qcc/LockOrderChecker.h is in liballjoyn-common-dev-1604 16.04a-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | /**
* @file
*
* Class implementing sanity checks for Mutex objects.
*/
/******************************************************************************
* Copyright AllSeen Alliance. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
******************************************************************************/
#ifndef NDEBUG
#ifndef _QCC_LOCKORDERCHECKER_H
#define _QCC_LOCKORDERCHECKER_H
#include <qcc/platform.h>
#include <qcc/Mutex.h>
#include "LockLevel.h"
namespace qcc {
/**
* Class implementing lock order verification for Mutex objects. Each Thread object
* has an associated LockOrderChecker object on Debug builds.
*/
class LockOrderChecker {
public:
/* Default constructor */
LockOrderChecker();
/* Destructor */
~LockOrderChecker();
/**
* Called when a thread is about to acquire a lock.
*
* @param lock Lock being acquired by current thread.
* @param file Source code file name where the lock is being acquired.
* @param line Source code line number where the lock is being acquired.
*/
void AcquiringLock(const Mutex* lock, const char* file = s_unknownFile, uint32_t line = s_unknownLineNumber);
/**
* Called when a thread has just acquired a lock.
*
* @param lock Lock that has just been acquired by current thread.
*/
void LockAcquired(const Mutex* lock);
/**
* Called when a thread is about to release a lock.
*
* @param lock Lock being released by current thread.
*/
void ReleasingLock(const Mutex* lock);
/**
* Lock/Unlock file name is unknown on Release builds, and on Debug builds
* if the caller didn't specify the MUTEX_CONTEXT parameter.
*/
static const char* s_unknownFile;
/**
* Lock/Unlock line number is unknown on Release builds, and on Debug builds
* if the caller didn't specify the MUTEX_CONTEXT parameter.
*/
static const uint32_t s_unknownLineNumber;
private:
/**
* @internal
* Keep track of the locks acquired by current thread using a stack of LockTrace objects.
* The goal is to always have this stack ordered by the lock level values - i.e. to acquire
* locks in a well-defined order. This stack is implemented using a simple array instead of
* a STL collection to make parsing the stack in a debugger easier.
*/
uint32_t m_currentDepth;
uint32_t m_maximumDepth;
class LockTrace;
LockTrace* m_lockStack;
/**
* @internal
* Bit masks of lock verification options.
*/
typedef enum {
/* Trigger an assertion failed when locks are being used out of order */
LOCKORDERCHECKER_OPTION_LOCK_ORDERING_ASSERT = 0x1,
/*
* Trigger an assertion failed when a lock that IS NOT being verified
* is acquired after a lock that IS being verified. The fix for this
* kind of problem is to specify an apppropriate lock level value,
* instead of the default value LOCK_LEVEL_NOT_SPECIFIED, as parameter
* to the constructor of the lock that is not being verified yet.
*/
LOCKORDERCHECKER_OPTION_MISSING_LEVEL_ASSERT = 0x2,
} LockOrderCheckerOptionBits;
/**
* @internal
* Combination of LockOrderCheckerOptionBits, corresponding to LockOrderChecker features that are
* currently enabled.
*/
static int enabledOptions;
/**
* @internal
* Initial lock stack maximum depth. The lock stack grows automatically if the
* number of locks owned by a thread at a given time is larger than this default
* maximum depth.
*/
static const uint32_t defaultMaximumStackDepth;
/* Copy constructor is private */
LockOrderChecker(const LockOrderChecker& other);
/* Assignment operator is private */
LockOrderChecker& operator=(const LockOrderChecker& other);
};
} /* namespace */
#endif /* _QCC_LOCKORDERCHECKER_H */
#endif /* NDEBUG */
|