qa_get_.cpp

00001 //////////////////////////////////////////////////////////////////////////////
00002 // Product: QF/C++
00003 // Last Updated for Version: 4.0.00
00004 // Date of the Last Update:  Apr 07, 2008
00005 //
00006 //                    Q u a n t u m     L e a P s
00007 //                    ---------------------------
00008 //                    innovating embedded systems
00009 //
00010 // Copyright (C) 2002-2008 Quantum Leaps, LLC. All rights reserved.
00011 //
00012 // This software may be distributed and modified under the terms of the GNU
00013 // General Public License version 2 (GPL) as published by the Free Software
00014 // Foundation and appearing in the file GPL.TXT included in the packaging of
00015 // this file. Please note that GPL Section 2[b] requires that all works based
00016 // on this software must also be made publicly available under the terms of
00017 // the GPL ("Copyleft").
00018 //
00019 // Alternatively, this software may be distributed and modified under the
00020 // terms of Quantum Leaps commercial licenses, which expressly supersede
00021 // the GPL and are specifically designed for licensees interested in
00022 // retaining the proprietary status of their code.
00023 //
00024 // Contact information:
00025 // Quantum Leaps Web site:  http://www.quantum-leaps.com
00026 // e-mail:                  info@quantum-leaps.com
00027 //////////////////////////////////////////////////////////////////////////////
00028 #include "qf_pkg.h"
00029 #include "qassert.h"
00030 
00031 Q_DEFINE_THIS_MODULE(qa_get_)
00032 
00033 /// \file
00034 /// \ingroup qf
00035 /// \brief QActive::get_() and QF::getQueueMargin() definitions.
00036 ///
00037 /// \note this source file is only included in the QF library when the native
00038 /// QF active object queue is used (instead of a message queue of an RTOS).
00039 
00040 //............................................................................
00041 QEvent const *QActive::get_(void) {
00042     QF_INT_LOCK_KEY_
00043     QF_INT_LOCK_();
00044 
00045     QACTIVE_EQUEUE_WAIT_(this);           // wait for event to arrive directly
00046 
00047     QEvent const *e = m_eQueue.m_frontEvt;
00048 
00049     if (m_eQueue.m_nFree != m_eQueue.m_end) { //any events in the ring buffer?
00050                                                  // remove event from the tail
00051         m_eQueue.m_frontEvt = m_eQueue.m_ring[m_eQueue.m_tail];
00052         if (m_eQueue.m_tail == (QEQueueCtr)0) {      // need to wrap the tail?
00053             m_eQueue.m_tail = m_eQueue.m_end;                   // wrap around
00054         }
00055         --m_eQueue.m_tail;
00056 
00057         ++m_eQueue.m_nFree;          // one more free event in the ring buffer
00058 
00059         QS_BEGIN_NOLOCK_(QS_QF_ACTIVE_GET, QS::aoObj_, this)
00060             QS_TIME_();                                           // timestamp
00061             QS_SIG_(e->sig);                       // the signal of this event
00062             QS_OBJ_(this);                               // this active object
00063             QS_U8_(e->dynamic_);        // the dynamic attributes of the event
00064             QS_EQC_(m_eQueue.m_nFree);               // number of free entries
00065         QS_END_NOLOCK_()
00066     }
00067     else {
00068         m_eQueue.m_frontEvt = (QEvent *)0;          // the queue becomes empty
00069         QACTIVE_EQUEUE_ONEMPTY_(this);
00070 
00071         QS_BEGIN_NOLOCK_(QS_QF_ACTIVE_GET_LAST, QS::aoObj_, this)
00072             QS_TIME_();                                           // timestamp
00073             QS_SIG_(e->sig);                       // the signal of this event
00074             QS_OBJ_(this);                               // this active object
00075             QS_U8_(e->dynamic_);        // the dynamic attributes of the event
00076         QS_END_NOLOCK_()
00077     }
00078     QF_INT_UNLOCK_();
00079     return e;
00080 }
00081 //............................................................................
00082 uint32_t QF::getQueueMargin(uint8_t prio) {
00083     Q_REQUIRE((prio <= (uint8_t)QF_MAX_ACTIVE)
00084               && (active_[prio] != (QActive *)0));
00085 
00086     QF_INT_LOCK_KEY_
00087     QF_INT_LOCK_();
00088     uint32_t margin = (uint32_t)(active_[prio]->m_eQueue.m_nMin);
00089     QF_INT_UNLOCK_();
00090 
00091     return margin;
00092 }