summaryrefslogtreecommitdiff
path: root/src/mongo/util/concurrency/race.h
blob: 2e372d2b85455e6b4cd71a48824f05f3fd679ff7 (plain)
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
/**
*    Copyright (C) 2012 10gen Inc.
*
*    This program is free software: you can redistribute it and/or  modify
*    it under the terms of the GNU Affero General Public License, version 3,
*    as published by the Free Software Foundation.
*
*    This program is distributed in the hope that it will be useful,
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*    GNU Affero General Public License for more details.
*
*    You should have received a copy of the GNU Affero General Public License
*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*
*    As a special exception, the copyright holders give permission to link the
*    code of portions of this program with the OpenSSL library under certain
*    conditions as described in each individual source file and distribute
*    linked combinations including the program with the OpenSSL library. You
*    must comply with the GNU Affero General Public License in all respects
*    for all of the code used other than as permitted herein. If you modify
*    file(s) with this exception, you may extend this exception to your
*    version of the file(s), but you are not obligated to do so. If you do not
*    wish to do so, delete this exception statement from your version. If you
*    delete this exception statement from all source files in the program,
*    then also delete it in the license file.
*/

#pragma once

#include "mongo/util/concurrency/mutexdebugger.h"
#include "mongo/util/debug_util.h"
#include "mongo/util/goodies.h" // printStackTrace
#include "mongo/util/stacktrace.h"

namespace mongo {

    namespace race {

#ifdef _WIN32
    typedef unsigned threadId_t;
#else
    typedef pthread_t threadId_t;
#endif

#if defined(_DEBUG)

        class Block { 
            volatile int n;
            unsigned ncalls;
            const std::string file;
            const unsigned line;
            void fail() { 
                log() << "\n\n\nrace: synchronization (race condition) failure\ncurrent locks this thread (" << getThreadName() << "):" << std::endl
                      << mutexDebugger.currentlyLocked();
                printStackTrace();
                ::abort();
            }
            void enter() { 
                if( ++n != 1 ) fail();
                ncalls++;
                if( ncalls < 100 ) {
                    sleepmillis(0);
                }
                else {
                    RARELY {
                        sleepmillis(0);
                        if( ncalls < 128 * 20 ) {
                            OCCASIONALLY { 
                                sleepmillis(3);
                            }
                        }
                    }
                }
            }
            void leave() {
                if( --n != 0 ) fail();
            }
        public:
            Block(const std::string& f, unsigned l) : n(0), ncalls(0), file(f), line(l) { }
            ~Block() { 
                if( ncalls > 1000000 ) { 
                    // just so we know if we are slowing things down
                    log() << "race::Block lots of calls " << file << ' ' << line << " n:" << ncalls;
                }
            }
            class Within { 
                Block& _s;
            public:
                Within(Block& s) : _s(s) { _s.enter(); }
                ~Within() { _s.leave(); }
            };
        };
 
        /* in a rwlock situation this will fail, so not appropriate for things like that. */
# define RACECHECK \
        static race::Block __cp(__FILE__, __LINE__); \
        race::Block::Within __ck(__cp);

#else
        /* !_DEBUG */
# define RACECHECK

#endif

    }
}