1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _SALHELPER_MONITOR_HXX_ 25*b1cdbd2cSJim Jagielski #define _SALHELPER_MONITOR_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <sal/types.h> 28*b1cdbd2cSJim Jagielski #include <osl/conditn.hxx> 29*b1cdbd2cSJim Jagielski #include <osl/diagnose.h> 30*b1cdbd2cSJim Jagielski #include <osl/interlck.h> 31*b1cdbd2cSJim Jagielski #include <rtl/ref.hxx> 32*b1cdbd2cSJim Jagielski #include <salhelper/refobj.hxx> 33*b1cdbd2cSJim Jagielski #include <salhelper/future.hxx> 34*b1cdbd2cSJim Jagielski #include <salhelper/futurequeue.hxx> 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski namespace salhelper 37*b1cdbd2cSJim Jagielski { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski #ifndef SALHELPER_COPYCTOR_API 42*b1cdbd2cSJim Jagielski #define SALHELPER_COPYCTOR_API(C) C (const C&); C& operator= (const C&) 43*b1cdbd2cSJim Jagielski #endif 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski class MonitorCondition : protected osl::Condition 48*b1cdbd2cSJim Jagielski { 49*b1cdbd2cSJim Jagielski /** Representation. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski oslInterlockedCount m_nReferenceCount; 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** Not implemented. 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski SALHELPER_COPYCTOR_API(MonitorCondition); 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski public: 58*b1cdbd2cSJim Jagielski /** Construction. 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielski inline MonitorCondition() SAL_THROW(()) : m_nReferenceCount (0) 61*b1cdbd2cSJim Jagielski { 62*b1cdbd2cSJim Jagielski Condition::set(); 63*b1cdbd2cSJim Jagielski } 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** Destruction. 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski inline ~MonitorCondition() SAL_THROW(()) 68*b1cdbd2cSJim Jagielski { 69*b1cdbd2cSJim Jagielski OSL_ASSERT(m_nReferenceCount == 0); 70*b1cdbd2cSJim Jagielski } 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski /** Acquire or enter the monitor. 73*b1cdbd2cSJim Jagielski */ acquire()74*b1cdbd2cSJim Jagielski inline void acquire() SAL_THROW(()) 75*b1cdbd2cSJim Jagielski { 76*b1cdbd2cSJim Jagielski if (osl_incrementInterlockedCount (&m_nReferenceCount) == 1) 77*b1cdbd2cSJim Jagielski { 78*b1cdbd2cSJim Jagielski Condition::reset(); 79*b1cdbd2cSJim Jagielski } 80*b1cdbd2cSJim Jagielski } 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski /** Release or leave the monitor. 83*b1cdbd2cSJim Jagielski */ release()84*b1cdbd2cSJim Jagielski inline void release() SAL_THROW(()) 85*b1cdbd2cSJim Jagielski { 86*b1cdbd2cSJim Jagielski if (osl_decrementInterlockedCount (&m_nReferenceCount) == 0) 87*b1cdbd2cSJim Jagielski { 88*b1cdbd2cSJim Jagielski Condition::set(); 89*b1cdbd2cSJim Jagielski } 90*b1cdbd2cSJim Jagielski } 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski /** Wait until all references are released. 93*b1cdbd2cSJim Jagielski */ wait()94*b1cdbd2cSJim Jagielski inline void wait() SAL_THROW(()) 95*b1cdbd2cSJim Jagielski { 96*b1cdbd2cSJim Jagielski Condition::wait(); 97*b1cdbd2cSJim Jagielski } 98*b1cdbd2cSJim Jagielski }; 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski class QueuedReaderWriterMonitor : public salhelper::ReferenceObject 103*b1cdbd2cSJim Jagielski { 104*b1cdbd2cSJim Jagielski /** Representation. 105*b1cdbd2cSJim Jagielski */ 106*b1cdbd2cSJim Jagielski typedef salhelper::Future<sal_Int32> future_type; 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski salhelper::FutureQueue<sal_Int32> m_aQueue; 109*b1cdbd2cSJim Jagielski salhelper::MonitorCondition m_aMonitor; 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski /** Not implemented. 112*b1cdbd2cSJim Jagielski */ 113*b1cdbd2cSJim Jagielski SALHELPER_COPYCTOR_API(QueuedReaderWriterMonitor); 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski public: 116*b1cdbd2cSJim Jagielski /** Construction. 117*b1cdbd2cSJim Jagielski */ QueuedReaderWriterMonitor()118*b1cdbd2cSJim Jagielski inline QueuedReaderWriterMonitor() 119*b1cdbd2cSJim Jagielski { 120*b1cdbd2cSJim Jagielski // Insert the token. 121*b1cdbd2cSJim Jagielski m_aQueue.put(0); 122*b1cdbd2cSJim Jagielski } 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski /** Acquire read access. 125*b1cdbd2cSJim Jagielski */ acquireReader()126*b1cdbd2cSJim Jagielski inline void acquireReader() 127*b1cdbd2cSJim Jagielski { 128*b1cdbd2cSJim Jagielski // Obtain the token. 129*b1cdbd2cSJim Jagielski rtl::Reference<future_type> xFuture (m_aQueue.get()); 130*b1cdbd2cSJim Jagielski xFuture->get(); 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski // Enter the monitor. 133*b1cdbd2cSJim Jagielski m_aMonitor.acquire(); 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski // Push back the token. 136*b1cdbd2cSJim Jagielski m_aQueue.put(0); 137*b1cdbd2cSJim Jagielski } 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski /** Release read access. 140*b1cdbd2cSJim Jagielski */ releaseReader()141*b1cdbd2cSJim Jagielski inline void releaseReader() 142*b1cdbd2cSJim Jagielski { 143*b1cdbd2cSJim Jagielski // Leave the monitor. 144*b1cdbd2cSJim Jagielski m_aMonitor.release(); 145*b1cdbd2cSJim Jagielski } 146*b1cdbd2cSJim Jagielski 147*b1cdbd2cSJim Jagielski /** Acquire write access. 148*b1cdbd2cSJim Jagielski */ acquireWriter()149*b1cdbd2cSJim Jagielski inline void acquireWriter() 150*b1cdbd2cSJim Jagielski { 151*b1cdbd2cSJim Jagielski // Obtain the token. 152*b1cdbd2cSJim Jagielski rtl::Reference<future_type> xFuture (m_aQueue.get()); 153*b1cdbd2cSJim Jagielski xFuture->get(); 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski // Wait until all readers have left. 156*b1cdbd2cSJim Jagielski m_aMonitor.wait(); 157*b1cdbd2cSJim Jagielski } 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski /** Release write access. 160*b1cdbd2cSJim Jagielski */ releaseWriter()161*b1cdbd2cSJim Jagielski inline void releaseWriter() 162*b1cdbd2cSJim Jagielski { 163*b1cdbd2cSJim Jagielski // Push back the token. 164*b1cdbd2cSJim Jagielski m_aQueue.put(0); 165*b1cdbd2cSJim Jagielski } 166*b1cdbd2cSJim Jagielski 167*b1cdbd2cSJim Jagielski protected: 168*b1cdbd2cSJim Jagielski /** Destruction. 169*b1cdbd2cSJim Jagielski */ ~QueuedReaderWriterMonitor()170*b1cdbd2cSJim Jagielski virtual ~QueuedReaderWriterMonitor() 171*b1cdbd2cSJim Jagielski {} 172*b1cdbd2cSJim Jagielski }; 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski template<class monitor_type> 177*b1cdbd2cSJim Jagielski class ReaderGuard 178*b1cdbd2cSJim Jagielski { 179*b1cdbd2cSJim Jagielski /** Representation. 180*b1cdbd2cSJim Jagielski */ 181*b1cdbd2cSJim Jagielski monitor_type *m_pMonitor; 182*b1cdbd2cSJim Jagielski 183*b1cdbd2cSJim Jagielski /** Not implemented. 184*b1cdbd2cSJim Jagielski */ 185*b1cdbd2cSJim Jagielski SALHELPER_COPYCTOR_API(ReaderGuard<monitor_type>); 186*b1cdbd2cSJim Jagielski 187*b1cdbd2cSJim Jagielski public: 188*b1cdbd2cSJim Jagielski /** Construction. Acquire monitor read access. 189*b1cdbd2cSJim Jagielski */ ReaderGuard(monitor_type & rMonitor)190*b1cdbd2cSJim Jagielski inline ReaderGuard (monitor_type & rMonitor) : m_pMonitor (&rMonitor) 191*b1cdbd2cSJim Jagielski { 192*b1cdbd2cSJim Jagielski m_pMonitor->acquireReader(); 193*b1cdbd2cSJim Jagielski } 194*b1cdbd2cSJim Jagielski 195*b1cdbd2cSJim Jagielski /** Construction. Acquire monitor read access. 196*b1cdbd2cSJim Jagielski */ ReaderGuard(monitor_type * pMonitor)197*b1cdbd2cSJim Jagielski inline ReaderGuard (monitor_type * pMonitor) : m_pMonitor (pMonitor) 198*b1cdbd2cSJim Jagielski { 199*b1cdbd2cSJim Jagielski OSL_PRECOND(m_pMonitor, "ReaderGuard::ReaderGuard(): No Monitor"); 200*b1cdbd2cSJim Jagielski m_pMonitor->acquireReader(); 201*b1cdbd2cSJim Jagielski } 202*b1cdbd2cSJim Jagielski 203*b1cdbd2cSJim Jagielski /** Destruction. Release monitor read access. 204*b1cdbd2cSJim Jagielski */ ~ReaderGuard()205*b1cdbd2cSJim Jagielski inline ~ReaderGuard() 206*b1cdbd2cSJim Jagielski { 207*b1cdbd2cSJim Jagielski if (m_pMonitor) 208*b1cdbd2cSJim Jagielski m_pMonitor->releaseReader(); 209*b1cdbd2cSJim Jagielski } 210*b1cdbd2cSJim Jagielski 211*b1cdbd2cSJim Jagielski /** Release monitor read access. 212*b1cdbd2cSJim Jagielski */ clear()213*b1cdbd2cSJim Jagielski inline void clear() 214*b1cdbd2cSJim Jagielski { 215*b1cdbd2cSJim Jagielski if (m_pMonitor) 216*b1cdbd2cSJim Jagielski { 217*b1cdbd2cSJim Jagielski m_pMonitor->releaseReader(); 218*b1cdbd2cSJim Jagielski m_pMonitor = 0; 219*b1cdbd2cSJim Jagielski } 220*b1cdbd2cSJim Jagielski } 221*b1cdbd2cSJim Jagielski }; 222*b1cdbd2cSJim Jagielski 223*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 224*b1cdbd2cSJim Jagielski 225*b1cdbd2cSJim Jagielski typedef ReaderGuard<QueuedReaderWriterMonitor> QueuedReaderGuard; 226*b1cdbd2cSJim Jagielski 227*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 228*b1cdbd2cSJim Jagielski 229*b1cdbd2cSJim Jagielski template<class monitor_type> 230*b1cdbd2cSJim Jagielski class WriterGuard 231*b1cdbd2cSJim Jagielski { 232*b1cdbd2cSJim Jagielski /** Representation. 233*b1cdbd2cSJim Jagielski */ 234*b1cdbd2cSJim Jagielski monitor_type *m_pMonitor; 235*b1cdbd2cSJim Jagielski 236*b1cdbd2cSJim Jagielski /** Not implemented. 237*b1cdbd2cSJim Jagielski */ 238*b1cdbd2cSJim Jagielski SALHELPER_COPYCTOR_API(WriterGuard<monitor_type>); 239*b1cdbd2cSJim Jagielski 240*b1cdbd2cSJim Jagielski public: 241*b1cdbd2cSJim Jagielski /** Construction. Acquire monitor write access. 242*b1cdbd2cSJim Jagielski */ WriterGuard(monitor_type & rMonitor)243*b1cdbd2cSJim Jagielski inline WriterGuard (monitor_type & rMonitor) : m_pMonitor (&rMonitor) 244*b1cdbd2cSJim Jagielski { 245*b1cdbd2cSJim Jagielski m_pMonitor->acquireWriter(); 246*b1cdbd2cSJim Jagielski } 247*b1cdbd2cSJim Jagielski 248*b1cdbd2cSJim Jagielski /** Construction. Acquire monitor write access. 249*b1cdbd2cSJim Jagielski */ WriterGuard(monitor_type * pMonitor)250*b1cdbd2cSJim Jagielski inline WriterGuard (monitor_type * pMonitor) : m_pMonitor (pMonitor) 251*b1cdbd2cSJim Jagielski { 252*b1cdbd2cSJim Jagielski OSL_PRECOND(m_pMonitor, "WriterGuard::WriterGuard(): No Monitor"); 253*b1cdbd2cSJim Jagielski m_pMonitor->acquireWriter(); 254*b1cdbd2cSJim Jagielski } 255*b1cdbd2cSJim Jagielski 256*b1cdbd2cSJim Jagielski /** Destruction. Release monitor write access. 257*b1cdbd2cSJim Jagielski */ ~WriterGuard()258*b1cdbd2cSJim Jagielski inline ~WriterGuard() 259*b1cdbd2cSJim Jagielski { 260*b1cdbd2cSJim Jagielski if (m_pMonitor) 261*b1cdbd2cSJim Jagielski m_pMonitor->releaseWriter(); 262*b1cdbd2cSJim Jagielski } 263*b1cdbd2cSJim Jagielski 264*b1cdbd2cSJim Jagielski /** Release monitor write access. 265*b1cdbd2cSJim Jagielski */ clear()266*b1cdbd2cSJim Jagielski inline void clear() 267*b1cdbd2cSJim Jagielski { 268*b1cdbd2cSJim Jagielski if (m_pMonitor) 269*b1cdbd2cSJim Jagielski { 270*b1cdbd2cSJim Jagielski m_pMonitor->releaseWriter(); 271*b1cdbd2cSJim Jagielski m_pMonitor = 0; 272*b1cdbd2cSJim Jagielski } 273*b1cdbd2cSJim Jagielski } 274*b1cdbd2cSJim Jagielski }; 275*b1cdbd2cSJim Jagielski 276*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 277*b1cdbd2cSJim Jagielski 278*b1cdbd2cSJim Jagielski typedef WriterGuard<QueuedReaderWriterMonitor> QueuedWriterGuard; 279*b1cdbd2cSJim Jagielski 280*b1cdbd2cSJim Jagielski //---------------------------------------------------------------------------- 281*b1cdbd2cSJim Jagielski 282*b1cdbd2cSJim Jagielski } // namespace salhelper 283*b1cdbd2cSJim Jagielski 284*b1cdbd2cSJim Jagielski #endif /* !_SALHELPER_MONITOR_HXX_ */ 285