qarm/qarmtransaction.cpp

Go to the documentation of this file.

/*
 * Copyright (c) 2005 MyARM GbR, Germany
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or 
 * without modification, are permitted provided that the 
 * following conditions are met:
 * 1. Redistributions of source code must retain the above
 *    copyright notice, this list of conditions and the
 *    following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the
 *    following disclaimer in the documentation and/or other
 *    materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of
 *    this software must display the following acknowledgement:
 *        This product includes software developed by
 *        MyARM GbR and its contributors.
 * 4. Neither the name of MyARM GbR nor the names of its
 *    contributors may be used to endorse or promote products
 *    derived from this software without specific prior written
 *    permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY MYARM GBR. AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL MYARM OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 */


#include <QArmTransaction>
#include <QArmApplication>
#include <QArmMetric>
#include <QArmMetricList>
#include <QArmTranDefinition>

#include "arm4.h"

/* hack to support correlator_getenv() functions which uses 
 * "static" arm calls. */
static
arm_error_t my_get_corrlen(const arm_correlator_t *correlator, 
                           arm_correlator_length_t *length);


ARM4_API_DYNAMIC(arm_error_t)
arm_get_correlator_length(const arm_correlator_t *correlator, 
                          arm_correlator_length_t *length)
{
  return my_get_corrlen(correlator, length);
}

#include "myarmsdk.h"
#include "myarmsdk_dynload.h"

static
arm_error_t my_get_corrlen(const arm_correlator_t *correlator, 
                           arm_correlator_length_t *length)
{
  if((myarmsdkdyn_callbacks != NULL) && 
     (myarmsdkdyn_callbacks->get_correlator_length != NULL))            
    {  
      return myarmsdkdyn_callbacks->get_correlator_length(correlator, length);
    }
  return -1;
}


/*---------------------------------------------------------------------------*/

QArmTransaction::QArmTransaction(const QArmTranDefinition & _trandef,
                                 QArmTransaction          * _parent) 
  :QArmInstance(_trandef), m_tranDefinition(0),
   m_children(0), m_tranParent(_parent) {

  connectParent();
}

/*---------------------------------------------------------------------------*/

QArmTransaction::QArmTransaction(QArmTranDefinition * _trandef,
                                 QArmTransaction    * _parent) 
  :QArmInstance(*_trandef), m_tranDefinition(_trandef),
   m_children(0), m_tranParent(_parent) {

  connectParent();
}

/*---------------------------------------------------------------------------*/

QArmTransaction::~QArmTransaction() {

  // If current transaction is active abort it!
  if(m_active)
    stop(QArmTransaction::ABORTED);
  // Subtract one from the child counter.
  if(m_tranParent != 0) {
    // Inform parent that there is a new child.
    m_tranParent->subtractChild();
  }
}


/*---------------------------------------------------------------------------*/

void QArmTransaction::connectParent() {
  // Connect this object to the parent so that it will stop automatically
  // when the parent stops.
  if(m_tranParent != 0) {
    connect(m_tranParent,
            SIGNAL(stopped(const QArmStatus)),
            this,
            SLOT(stop(const QArmStatus)));
    // Inform parent that there is a new child.
    m_tranParent->addChild();
  }
}

/*---------------------------------------------------------------------------*/

void QArmTransaction::start(const QArmApplication      * _app,
                            const QArmContextValueList * _context_values,
                            const QArmMetricList       * _metric_values) {
  
  if(!m_active) {
    armsdk_subbuffer_tran_context_t  sdk_sb_tran_context;
    armsdk_subbuffer_metric_values_t sdk_sb_metric_values;
    arm_subbuffer_user_t             sb_user;
    armsdk_buffer4_t                 buf4;
    int num_sb = 0;

    bool context = (_context_values != 0) && (_context_values->count() > 0);
    bool metrics = (_metric_values != 0) && (_metric_values->count() > 0);

    m_active = true;
      
    // CONTEXT VALUES
    // Undefined behaviour in case values and names/bindings do not match
    if(context) {
      // Initialize the context values buffer.
      armsdk_tran_context_initialize(&sdk_sb_tran_context);
      QArmContextValueListIterator it(*_context_values);
      int i = 0;
      while(it.hasNext()) {
        armsdk_tran_context_set(&sdk_sb_tran_context, 
                                i, 
                                it.next().toAscii().constData());
        ++i;
      }// end while
        
      num_sb = addSubbuffer(num_sb, buf4, ARM_SDKSB(sdk_sb_tran_context));
    }// end if
      
    // METRIC VALUES
    if(metrics) {
      // Initialize the metric values buffer.
      armsdk_metric_initialize(&sdk_sb_metric_values);
      // Fill it with content.
      QArmMetricListIterator it(*_metric_values);
      while(it.hasNext()) {
        it.next()->fill(&sdk_sb_metric_values);
      }// end while
        
      // Give this to the subbuffer.
      num_sb = addSubbuffer(num_sb, buf4, ARM_SDKSB(sdk_sb_metric_values));
    }// end if
      

    // USER handling
    if(!m_user.isEmpty()) {
      // Initialize the user buffer.
      armsdk_user_initialize(&sb_user);
        
      armsdk_user_set(&sb_user,
                      m_user.toAscii().constData());
        
      // and inform buf4.
      num_sb = addSubbuffer(num_sb, buf4, ARM_SB(sb_user));
    }
      
    // Check for a parent either from the outside 
    // (via environment variable) or from the inside
    if(m_tranParent != 0) {
      m_parentCorr = &m_tranParent->m_tranCorr;
    }
    else {
      m_parentCorr = myarmsdk_correlator_getenv(&m_parentCorrBuf,NULL); 
    }
    arm_start_transaction(_app->getHandle(),
                          m_id,
                          m_parentCorr,
                          ARM_FLAG_NONE,
                          num_sb > 0 ? &buf4.header : ARM_BUF4_NONE,
                          &m_tranHandle,
                          &m_tranCorr);

    // Now check for children. If there are any we do not need to set 
    // the environment variable. Otherwise we need to do it since there
    // might be a child transaction outside this process
    if(!childrenExist()) {
      myarmsdk_correlator_setenv(&m_tranCorr);
    }
  } // end if
}

/*--------------------------------------------------------------------------*/

void QArmTransaction::stop(const QArmTransaction::QArmStatus status) {
  
  if(m_active) {
      
    emit stopped(status);
      
    arm_stop_transaction(m_tranHandle,
                         static_cast<arm_tran_status_t>(status),
                         ARM_FLAG_NONE,
                         ARM_BUF4_NONE);
      
    // Make the external correlator the current correlator for followup
    // transactions, but only in case there is no internal parent.
    if(m_tranParent == 0) {
      myarmsdk_correlator_setenv(m_parentCorr);
    }
    else if(!childrenExist()) {
      // In this case the current correlator was set as environment variable.
      // This variable has to be reset.
        myarmsdk_correlator_setenv(ARM_CORR_NONE);
    }

    m_active = false;
  }
}

/*--------------------------------------------------------------------------*/

char *QArmTransaction::getStringifiedCorrelator(char *corrstr, 
                                                size_t size) const {

  const arm_correlator_t *c = getCorrelator();
  char *ret = NULL;

  if(c != ARM_CORR_NONE) {
    if(-1 != myarmsdk_correlator_stringify(MYARMSDK_CORR_HEX_NO_HEADER,
                                           c,
                                           corrstr, 
                                           size)) {
      ret = corrstr;
    }
  }
  return ret;
}

---