Events.h

Go to the documentation of this file.

//===-- temu-c/Events.h - Event Queue API -----------------------*- C++ -*-===//
//
// T-EMU: The Terma Emulator
// (c) Terma 2015, 2016
// Authors: Mattias Holm <maho (at) terma.com>
//
//===----------------------------------------------------------------------===//

#ifndef TEMU_EVENTS_H
#define TEMU_EVENTS_H

#include <stdint.h>
#include "temu-c/Support/Objsys.h"
#include "temu-c/Support/LegacyEvents.h"
#include "temu-c/Support/Attributes.h"
#ifdef __cplusplus
extern "C" {
#endif

// Queue allocation and disposal
TEMU_API void* temu_allocateEventQueue(void);

TEMU_API void temu_disposeEventQueue(void *Queue);

// New style events
typedef struct temu_EventQueue temu_EventQueue;

typedef struct temu_Event {
  int64_t Time;           // Managed internally, do not touch
  int64_t EventId;        // Managed internally, do not touch
  uint32_t Flags;         // Internal use, do not touch
  int QueueIdx;           // Managed internally, do not touch
  temu_EventQueue *Queue; // Managed internally, do not touch
  void *Obj;              // Managed internally, only for reading
  void (*Func)(struct temu_Event*);

  void *Data;             // Managed: For old style event support
  int64_t Period;         // Managed: Period (cycles) for cyclic events
  int64_t RTTime;         // Managed: Time (monotonic ns) for RT exec
  int64_t RTPeriod;       // Managed: Period (ns) for RT events
} temu_Event;

// Posting callback from other threads
typedef void (*temu_ThreadSafeCb)(void*);
TEMU_API void temu_postCallbackInQueue(void *Queue, temu_ThreadSafeCb Cb, void *Arg);

TEMU_API void temu_removeCallbackInQueue(void *Queue, temu_ThreadSafeCb Cb, void *Arg);

typedef struct {
  // Async callbacks
  void (*postCallback)(void *Obj, temu_ThreadSafeCb Cb, void *Arg);
  void (*removeCallback)(void *Obj, temu_ThreadSafeCb Cb, void *Arg);

  // New event API
  void (*postAbsolute)(void *Obj, int64_t EvId, int64_t T);
  void (*postRelative)(void *Obj, int64_t EvId, int64_t T);
  void (*postOnStack)(void *Obj, int64_t EvId);
} temu_EventIface;
#define TEMU_EVENT_IFACE_TYPE "EventIface"
TEMU_IFACE_REFERENCE_TYPE(temu_Event);

// Publication of old style events
// Note that OLD STYLE EVENTS are DEPRECATED, these functions will be
// removed in T-EMU 2.3.
TEMU_API int64_t temu_eventPublishOldStyle(const char *Name, void *Obj,
                                  void (*Ev)(void*,void*));

TEMU_API int64_t temu_eventGetOldStyleID(void (*Ev)(void*,void*), void *Sender);


TEMU_API int64_t temu_eventPublishStruct(const char *EvName, temu_Event *Ev, void *Obj,
                                void (*Func)(temu_Event*));

TEMU_API void temu_eventDepublish(int64_t EvID);

TEMU_API int64_t temu_eventPublish(const char *EvName, void *Obj,
                          void (*Func)(temu_Event*));

// Synchronisation events
typedef enum {
  teSE_Cpu,     // Trigger event when CPU reaches timer
  teSE_Machine, // Synchronise event on machine
} temu_SyncEvent;

TEMU_API void temu_eventPostCycles(void *Q, int64_t EvID, int64_t Delta,
                          temu_SyncEvent Sync);
TEMU_API void temu_eventPostNanos(void *Q, int64_t EvID, int64_t Delta,
                         temu_SyncEvent Sync);
TEMU_API void temu_eventPostSecs(void *Q, int64_t EvID, double Delta,
                        temu_SyncEvent Sync);

TEMU_API void temu_eventPostStack(void *Q, int64_t EvID, temu_SyncEvent Sync);

TEMU_API int temu_eventIsScheduled(int64_t EvID);

TEMU_API void temu_eventDeschedule(int64_t EvID);

TEMU_API int64_t temu_eventGetCycles(void *Q, int64_t EvID);

TEMU_API int64_t temu_eventGetNanos(void *Q, int64_t EvID);

TEMU_API double temu_eventGetSecs(void *Q, int64_t EvID);


//======================== EXPERIMENTAL API ==================================//
#define TEMU_ASYNC_CYCLIC   1
#define TEMU_ASYNC_READ    (1 << 1)
#define TEMU_ASYNC_WRITE   (1 << 2)

TEMU_API int temu_asyncTimerAdd(void *Q, double T,
                       unsigned Flags, void (*CB)(void*),
                       void *Data);

TEMU_API void temu_asyncTimerRemove(int Fd);

TEMU_API int temu_asyncSocketAdd(void *Q, int Sock, unsigned Flags,
                        void (*CB)(void*),
                        void *Data);

TEMU_API void temu_asyncSocketRemove(int Fd, unsigned Flags);

TEMU_API void temu_eventPostAsync(void *Q, temu_ThreadSafeCb CB, void *Data,
                         temu_SyncEvent Sync);


TEMU_API int temu_eventSetRealTime(int64_t EvID);


TEMU_API void temu_eventSetPeriodCycles(int64_t EvID, int64_t Period);

TEMU_API void temu_eventSetRTPeriodNanos(int64_t EvID, int64_t Period);

TEMU_API void temu_eventSetRTTime(int64_t EvID, int64_t Time);

TEMU_API uint64_t temu_eventQueueGetFreq(void *Q);

//================= END OF EXPERIMENTAL API ==================================//

#ifdef __cplusplus
}
#endif

#endif /*  ! TEMU_EVENTS_H */