Updated license
[anna.git] / source / core / mt / Guard.cpp
1 // ANNA - Anna is Not Nothingness Anymore
2 //
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
4 //
5 // https://bitbucket.org/testillano/anna
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
9 // are met:
10 //
11 //     * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 //     * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 //     * Neither the name of Google Inc. nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 // Authors: eduardo.ramos.testillano@gmail.com
34 //          cisco.tierra@gmail.com
35
36
37 #include <anna/core/mt/Guard.hpp>
38 #include <anna/core/mt/Safe.hpp>
39 #include <anna/core/functions.hpp>
40 #include <anna/core/tracing/Logger.hpp>
41
42 using namespace std;
43 using namespace anna;
44
45 #define trace_local7(method,object,file,line) \
46    if (Logger::isActive (Logger::Local7)) { \
47       string msg = (method); \
48       msg += " | Reference: "; \
49       if (a_whatis == NULL)  \
50          msg += functions::asHexString (anna_ptrnumber_cast ((object))); \
51       else { \
52          msg += "("; \
53          msg += functions::asHexString (anna_ptrnumber_cast ((object))); \
54          msg += "): "; \
55          msg += a_whatis; \
56       } \
57       Logger::write (Logger::Local7, msg, (file), (line)); \
58    }
59
60 Guard::Guard(const Safe* object) throw(RuntimeException) :
61   a_whatis(NULL) {
62   if(object == NULL)
63     throw RuntimeException("Can not lock NULL object", ANNA_FILE_LOCATION);
64
65   lock(a_safeObject = const_cast <Safe*>(object), NULL);
66 }
67
68 Guard::Guard(const Safe* object, const char* whatis) throw(RuntimeException) :
69   a_whatis(whatis) {
70   if(object == NULL)
71     throw RuntimeException("Can not lock NULL object", ANNA_FILE_LOCATION);
72
73   lock(a_safeObject = const_cast <Safe*>(object), whatis);
74 }
75
76 void Guard::deactivate()
77 throw() {
78   if(a_safeObject == NULL)
79     return;
80
81   a_safeObject->unlock();
82   trace_local7("Guard::deactivate", a_safeObject, __FILE__, __LINE__);
83   a_safeObject = NULL;
84 }
85
86 //--------------------------------------------------------------------------------------------------------------
87 // Solo sacmos trazas cuando nos mandan un 'whatis', de otro quedamos un bucle infinito porque el
88 // Logger::writer tambien usa una Guard.
89 //--------------------------------------------------------------------------------------------------------------
90 void Guard::lock(Safe* safe, const char* whatis)
91 throw(RuntimeException) {
92   trace_local7("Guard::lock", safe, __FILE__, __LINE__);
93   safe->lock();
94 }
95