From 50990b6ac9c9f901923f3de1a838ad01c7434309 Mon Sep 17 00:00:00 2001
From: Rodrigo Arias <rodrigo.arias@bsc.es>
Date: Thu, 14 Oct 2021 08:10:03 +0200
Subject: [PATCH] Document emulator events

---
 doc/emu_events.txt | 94 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 doc/emu_events.txt

diff --git a/doc/emu_events.txt b/doc/emu_events.txt
new file mode 100644
index 0000000..60a1629
--- /dev/null
+++ b/doc/emu_events.txt
@@ -0,0 +1,94 @@
+This file contains an exhaustive list of events supported by the emulator.
+
+- Punctual events don't produce a state transition.
+- All events refer to the current thread.
+- Descriptions must be kept short.
+
+**********************************************************
+Please keep this list synchronized with the emulator code!
+**********************************************************
+
+MCV = Model Category Value
+
+------------------------------------------------------------
+MCV	Description
+--------------------- Ovni (model=O) -----------------------
+
+OHC	Creates a new thread (punctual event)
+OHx	Begins the execution
+OHp	Pauses the execution
+OHc	Enters the cooling state (about to be paused)
+OHw	Enters the warming state (about to be running)
+OHe	Ends the execution
+
+OAs	Switches it's own affinity to the given CPU
+OAr	Remotely switches the affinity of the given thread
+
+OB.	Emits a burst event to measure latency
+
+-------------------- nOS-V (model=V) ----------------------
+
+VTc	Creates a new task (punctual event)
+VTx	Task execute
+VTe	Task end
+VTp	Task pause
+VTr	Task resume
+
+VYc	Task type create (punctual event)
+
+VSr	Receives a task from another thread (punctual event)
+VSs	Sends a task to another thread (punctual event)
+VS@	Self-assigns itself a task (punctual event)
+VSh	Enters the hungry state, waiting for a task
+VSf	Is no longer hungry
+VS[	Enters the scheduler server mode
+VS]	Ends the scheduler server mode
+
+VU[	Starts to submit a task
+VU]	Ends the submission of a task
+
+VM[	Starts allocating memory
+VM]	Ends allocating memory
+
+VP[	Enters nosv_pause()
+VP]	Exits nosv_pause()
+
+VI[	Enters nosv_yield()
+VI]	Exits nosv_yield()
+
+VW[	Enters nosv_waitfor()
+VW]	Exits nosv_waitfor()
+
+VD[	Enters nosv_schedpoint()
+VD]	Exits nosv_schedpoint()
+
+VC[	Begins executing nosv code
+VC]	Ends executing nosv code
+
+-------------------- TAMPI (model=T) ----------------------
+
+TS[	MPI_Send() enter
+TS]	MPI_Send() exit
+
+TR[	MPI_Recv() enter
+TR]	MPI_Recv() exit
+
+Ts[	MPI_Isend() enter
+Ts]	MPI_Isend() exit
+
+Tr[	MPI_Irecv() enter
+Tr]	MPI_Irecv() exit
+
+TV[	MPI_Wait() enter
+TV]	MPI_Wait() exit
+
+TW[	MPI_Waitall() enter
+TW]	MPI_Waitall() exit
+
+-------------------- OpenMP (model=M) ----------------------
+
+MT[	Task begins
+MT]	Task ends
+
+MP]	Parallel region begins
+MP[	Parallel region ends