xlap.h

#ifndef XLAP_H
#define XLAP_H

#include <stdio.h>
#include <stdint.h>
#include <time.h>

/*
 * Each timestamp contains both a cycle value and a time value, but some values
 * might remain zero
 */
typedef union XlapTimestamp {
    struct XlapActualTimestamp {
        uint64_t c;
        struct timespec t;
    } actual;
    char _cacheline[64];
} XlapTimestamp;

#include "pp.h"

/*
 * Comma-separated list of timestamp IDs
 */
#define TIMESTAMP_ID_LIST \
    PrrtSendStart, \
    PrrtSendEnd, \
    PrrtSubmitPackage, \
    PrrtEncodeStart, \
    PrrtEncodeEnd, \
    PrrtTransmitStart, \
    PrrtTransmitEnd, \
    LinkTransmitStart, \
    LinkTransmitEnd, \
    ChannelTransmit, \
    ChannelReceive, \
    LinkReceive, \
    DecodeStart, \
    DecodeEnd, \
    HandlePacketStart, \
    HandlePacketEnd, \
    CopyOutputStart, \
    CopyOutputEnd, \
    SendFeedbackStart, \
    SendFeedbackEnd, \
    PrrtReturnPackage, \
    PrrtReceivePackage, \
    PrrtDeliver \

#define TIMESSTAMP_ID_TO_NAME(id) ts_##id

/*
 * enum containing all timestamp IDs
 */
typedef enum XlapTimestampId {
    PP_foreach(PP_join_comma, TIMESSTAMP_ID_TO_NAME, TIMESTAMP_ID_LIST),
    ts_count
} XlapTimestampId;

/*
 * enum to distinguish between data and redundancy packet timstamps
 */
typedef enum XlapTimestampPacketKind {
    ts_data_packet = 0,
    ts_any_packet = 0,
    ts_redundancy_packet = 1,
} XlapTimestampPacketKind;

/*
 * Table that stores timestamps for each timestamp ID
 */
typedef struct XlapTimestampTableRow {
    XlapTimestamp time[ts_count];
} XlapTimestampTableRow;

/*
 * by default, store timestamps for 128 packages
 */
#ifndef TS_ROWS
#define TS_ROWS (1u<<12)
#endif

/*
 * Table that stores timestamp table rows
 */
#ifdef XLAP
typedef struct XlapTimestampTable {
    XlapTimestampTableRow rows[TS_ROWS];
} XlapTimestampTable;
#else /* XLAP */
typedef char XlapTimestampTable;
#endif

/*
 * Dummy data structure to store a single timestamp table row.
 */
#ifdef XLAP
typedef struct XlapTimestampPlaceholder {
    _Atomic(XlapTimestampTable *) tstable[1];
    XlapTimestampTableRow rows[1];
} XlapTimestampPlaceholder;
#else /* XLAP */
typedef char XlapTimestampPlaceholder;
#endif

/*
 * update the clock value of a timestamp by setting an explicit value
 *
 * This macro will cause a SIGSEGV if the application does not install a
 * timestamp table to the socket.
 */

#ifdef XLAP
#	define XlapTimeStampValue(sck, kind, seqno, id, value) do { \
            atomic_load_explicit(&(sck)->tstable[kind], memory_order_acquire)->rows[(seqno) % TS_ROWS].time[ts_##id].actual.t = value; \
        } while (0)
#else /* XLAP */
#	define XlapTimeStampValue(sck, kind, seqno, id, value) do { \
            (void) (sck); \
            (void) (kind); \
            (void) (seqno); \
            (void) (ts_##id); \
            (void) (value); \
        } while (0)
#endif

/*
 * update the clock value of a cyclestamp by setting an explicit value
 *
 * This macro will cause a SIGSEGV if the application does not install a
 * timestamp table to the socket.
 */

#ifdef XLAP
#	define XlapCycleStampValue(sck, kind, seqno, id, value) do { \
            atomic_load_explicit(&(sck)->tstable[kind], memory_order_acquire)->rows[(seqno) % TS_ROWS].time[ts_##id].actual.c = value; \
        } while (0)
#else /* XLAP */
#	define XlapCycleStampValue(sck, kind, seqno, id, value) do { \
            (void) (sck); \
            (void) (kind); \
            (void) (seqno); \
            (void) (ts_##id); \
            (void) (value); \
        } while (0)
#endif

/*
 * update the clock value of a timestamp
 *
 * This macro will cause a SIGSEGV if the application does not install a
 * timestamp table to the socket.
 */
#ifdef XLAP
#	define XlapTimeStampClock(sck, kind, seqno, id) do { \
            clock_gettime(CLOCK_REALTIME, &atomic_load_explicit(&(sck)->tstable[kind], memory_order_acquire)->rows[(seqno) % TS_ROWS].time[ts_##id].actual.t); \
        } while (0)
#else /* XLAP */
#	define XlapTimeStampClock(sck, kind, seqno, id) do { \
            (void) (sck); \
            (void) (kind); \
            (void) (seqno); \
            (void) (ts_##id); \
        } while (0)
#endif


/*
 * update the cycle value of a timestamp
 *
 * This macro will cause a SIGSEGV if the application does not install a
 * timestamp table to the socket.
 */
#ifdef XLAP
#	define XlapTimeStampCycle(sck, kind, seqno, id) do { \
            atomic_load_explicit(&(sck)->tstable[kind], memory_order_acquire)->rows[(seqno) % TS_ROWS].time[ts_##id].actual.c = __builtin_ia32_rdtsc(); \
        } while (0)
#else /* XLAP */
#	define XlapTimeStampCycle(sck, kind, seqno, id) do { \
            (void) (sck); \
            (void) (kind); \
            (void) (seqno); \
            (void) (ts_##id); \
        } while (0)
#endif


/*
 * install a time stamp table to a socket
 */
#ifdef XLAP
#	define XlapTimestampTableInstall(sck, kind, tstp) do { \
            XlapTimestampTable *__tstp = (tstp); \
            memset(__tstp, 0, sizeof(XlapTimestampTable)); \
            atomic_store_explicit(&(sck)->tstable[kind], __tstp, memory_order_release); \
        } while (0)
#else /* XLAP */
#	define XlapTimestampTableInstall(sck, kind, tstp) do { \
            (void) (sck); \
            (void) (kind); \
            (void) (tstp); \
        } while (0)
#endif


/*
 * print a timestamp dump header
 */
#ifdef XLAP
extern void XlapTimestampTableDumpHeader(FILE *);
#else
#	define XlapTimestampTableDumpHeader(f) do { \
            (void) (f); \
        } while (0)
#endif

/*
 * dump a timestamp table
 */
#ifdef XLAP
extern void XlapTimestampTableDump(FILE *, XlapTimestampPacketKind, XlapTimestampTable *);
#else
#	define XlapTimestampTableDump(f, k, t) do { \
            (void) (f); \
            (void) (k); \
            (void) (t); \
        } while (0)
#endif

/*
 * intialize a timestamp table placeholder
 */
#ifdef XLAP
#	define XlapTimestampPlaceholderInitialize(ph) do { \
            XlapTimestampPlaceholder *__ph = (ph); \
            atomic_store_explicit(&__ph->tstable[0], (XlapTimestampTable *) &__ph->rows, memory_order_release); \
            memset(&__ph->rows, 0x0, sizeof(XlapTimestampTableRow)); \
        } while (0)
#else
#	define XlapTimestampPlaceholderInitialize(ph) do { \
            (void) (ph); \
        } while (0)
#endif

/*
 * copy a timestamp table placeholder into an actual timestamp table
 *
 * Since every timestamp is taken at most once, either the timestamptable or
 * the placeholder value must be zero (for each timestamp).
 */
#ifdef XLAP
#	define XlapTimestampPlaceholderUse(sck, kind, seqno, ph) do { \
            XlapTimestampPlaceholder *__ph = (ph); \
            XlapTimestampTable       *__ts = atomic_load_explicit(&(sck)->tstable[kind], memory_order_acquire); \
            for (unsigned int __t = 0; __t < ts_count; __t++) { \
                __ts->rows[seqno % TS_ROWS].time[__t].actual.t.tv_sec  += __ph->rows[0].time[__t].actual.t.tv_sec; \
                __ts->rows[seqno % TS_ROWS].time[__t].actual.t.tv_nsec += __ph->rows[0].time[__t].actual.t.tv_nsec; \
                __ts->rows[seqno % TS_ROWS].time[__t].actual.c         += __ph->rows[0].time[__t].actual.c; \
            } \
        } while (0)
#else
#	define XlapTimestampPlaceholderUse(sck, kind, seqno, ph) do { \
            (void) (sck); \
            (void) (kind); \
            (void) (seqno); \
            (void) (ph); \
        } while (0)
#endif

#endif // XLAP_H