FesaDefs.h

Go to the documentation of this file.

// Copyright CERN 2012 - Developed in collaboration with GSI

#ifndef FESA_DEFS_H_
#define FESA_DEFS_H_

#include <string>
#include <signal.h>

#include <stdint.h>

namespace fesa
{

const int32_t DEFAULT_RT_PRIO_DIAGNOSTIC_LAYER = 5;
const int32_t DEFAULT_RT_PRIO_PERSISTANCE_THREAD = 25;
const int32_t DEFAULT_RT_PRIO_CLIENT_NOTIFICATION_THREAD = 25;
const int32_t DEFAULT_RT_PRIO_SIGNAL_HANDLER_THREAD = 25;

//DEFAULT_PRIO_SERVER_NOTIF_THREAD > PRIO_CLIENT_NOTIFICATION_THREAD for all client notif threads
const int32_t DEFAULT_RT_PRIO_SERVER_NOTIF_THREAD = 26;

//DEFAULT_PRIO_RDA_SERVER_THREAD > DEFAULT_PRIO_SERVER_NOTIF_THREAD
const int32_t DEFAULT_RT_PRIO_RDA_SERVER_THREAD = 27;

const int32_t DEFAULT_RT_PRIO_CONCURRENCY_LAYER = 50;
const int32_t DEFAULT_RT_PRIO_EVENT_SOURCE = 51;

const int32_t DEFAULT_NICE_PRIO_DIAGNOSTIC_LAYER = 17;
const int32_t DEFAULT_NICE_PRIO_PERSISTANCE_THREAD = 15;
const int32_t DEFAULT_NICE_PRIO_CLIENT_NOTIFICATION_THREAD = 15;
const int32_t DEFAULT_NICE_PRIO_SIGNAL_HANDLER_THREAD = 15;

//DEFAULT_PRIO_SERVER_NOTIF_THREAD > PRIO_CLIENT_NOTIFICATION_THREAD for all client notif threads
const int32_t DEFAULT_NICE_PRIO_SERVER_NOTIF_THREAD = 10;

//DEFAULT_PRIO_RDA_SERVER_THREAD > DEFAULT_PRIO_SERVER_NOTIF_THREAD
const int32_t DEFAULT_NICE_PRIO_RDA_SERVER_THREAD = 8;

const int32_t DEFAULT_NICE_PRIO_CONCURRENCY_LAYER = 5;
const int32_t DEFAULT_NICE_PRIO_EVENT_SOURCE = 3;

const uint32_t FEC_NAME_LENGTH = 31;

const uint32_t CLASS_NAME_LENGTH = 31;

const uint32_t MUXCONTEXT_NAME_LENGTH = 31;

const uint32_t CLASS_VERSION_LENGTH = 31;

const uint32_t CLASS_DESC_LENGTH = 63;

const uint32_t DEVICE_NAME_LENGTH = 31;

const uint32_t DEVICE_DESC_LENGTH = 63;

const uint32_t FIELD_STRING_LENGTH = 15;

const uint32_t FIELD_NAME_LENGTH = 15;

const uint32_t PROPERTY_NAME_LENGTH = 31;

const uint32_t DIAG_TRACE_DEVICE_LENGTH = 320;

const uint32_t DIAG_BYPASS_ACTION_LENGTH = 320;

const uint32_t HW_MODULE_TYPE_LENGTH = 31;

enum DataIntegrity
{
    SingleBuffered = 1, DoubleBuffered = 2
};

enum FieldCategory
{
    Configuration, Setting, Acquisition, Generic
};

const uint32_t NO_NOTIFICATION = 0;

const int32_t NO_TIMING_SELECTOR = -1;

const uint32_t COMMAND_STRING_MAXSIZE = 100;

const uint32_t DIAG_HOST_NAME_LENGTH = 31;

struct DiagnosticEventPayload
{
    char hostName_[DIAG_HOST_NAME_LENGTH];
    int32_t port_;
    char className_[CLASS_NAME_LENGTH];
    uint32_t state_;
    double tsCounterPeriod_;
    int32_t fwkTopic_;
    int32_t customTopic_;
};

/* 5 types of event-source are supported (defined by type/name/key):
 * hardware/timer/""                    one source only (no key)
 * hardware/timing|timingSim/""         one source only (no key)
 * on-demand/onDemand/""                one source only (no key)
 * on-subscription/onSubscription/""    one source only (no key)
 * custom/<name>/<key>                  multiple sources allowed
 *
 * Notes:
 * . <name> are unique, they are defined by the user in the design document.
 * . <key> is a string which is required for dynamic instantiation of the
 *   custom-event-source which supports multiple occurrences.
 */

const std::string TIMER_EVENT_SOURCE_NAME = "Timer";

const std::string TIMING_EVENT_SOURCE_NAME = "Timing";

const std::string ON_DEMAND_EVENT_SOURCE_NAME = "OnDemand";

/*
 * \brief fixed name of the on-subscription event source
 */
const std::string ON_SUBSCRIPTION_EVENT_SOURCE_NAME = "OnSubscription";

const std::string DEFAULT_EVENT_SOURCE_KEY = "default-source";

const std::string EXTRA_CRITERION_NAME = "ExtraCriterion";

const std::string DIAGNOSTIC_LAYER = "diagnosticLayer";

const uint32_t MaxLength = 20;

enum FesaProcessType
{
    splitServerOnly,    // Only a Server-process exists for this binary
    splitRealTimeOnly,  // Only a RT-process exists for this binary
    splitServerMixed,   // Server- and RT-process both exist on the FEC, this binary is the Server-Process
    splitRealTimeMixed, // Server- and RT-process both exist on the FEC, this binary is the RT-Process
    unsplit             // Server and RT part are running in the same process
};

enum RunMode
{
        blocking,
        nonBlocking
};

const std::string OD_MQ_Prefix = "/OD_MQ_";

const uint32_t OD_MSG_SIZE_MAX = 1024;

const uint32_t OD_MSG_NUM_MAX = 10;

enum RequestType //merged with NOTIFICATION_UPDATE_FLAGS
{
    GET = 0, SUBSCRIBE = 1, SET = 2
};

enum IOType
{
    Input = 0, Output = 1
};

enum PropertyType
{
    SETTING = 0, ACQUISITION = 1
};


const int32_t SIGFESA_NOTIFICATION_FAILURE = SIGRTMIN + 4; // +4 to avoid conflicts with Linux Thread library signals
const int32_t SIGFESA_RT_DOWN = SIGRTMIN + 5;
const int32_t SIGFESA_CHECK_PROCESS_ALIVE = SIGRTMIN + 6;

} // fesa

#endif // FESA_DEFS_H_