ebuser.cxx File Reference

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "midas.h"
#include "mevb.h"

Include dependency graph for ebuser.cxx:

Go to the source code of this file.

Functions
INT	ebuilder_init ()
INT	ebuilder_exit ()
INT	eb_begin_of_run (INT, char *, char *)
INT	eb_end_of_run (INT, char *)
INT	ebuilder_loop ()
INT	ebuser (INT, BOOL mismatch, EBUILDER_CHANNEL *, EVENT_HEADER *, void *, INT *)
INT	read_scaler_event (char *pevent, INT off)
	Scaler event readout.
INT	eb_user (INT nfrag, BOOL mismatch, EBUILDER_CHANNEL *ebch, EVENT_HEADER *pheader, void *pevent, INT *dest_size)

Variables
INT	tid_size []
const char *	frontend_name = "Ebuilder"
const char *	frontend_file_name = __FILE__
BOOL	ebuilder_call_loop = FALSE
INT	display_period = 3000
INT	max_event_size = 500000
INT	max_event_size_frag = 5 * 1024 * 1024
INT	event_buffer_size = 20 * 50000
INT	lModulo = 100
	Global var for testing passed at BOR.
EBUILDER_SETTINGS	ebset
BOOL	debug
EQUIPMENT	equipment []

Function Documentation

eb_begin_of_run()

INT eb_begin_of_run	(	INT	rn,
		char *	UserField,
		char *	error
	)

Hook to the event builder task at PreStart transition.

Parameters

rn	run number
UserField	argument from /Ebuilder/Settings
error	error string to be passed back to the system.

Returns

EB_SUCCESS

Definition at line 106 of file ebuser.cxx.

{
  printf("In eb_begin_of_run for run:%d User_field:%s \n", rn, UserField);
   lModulo = atoi(UserField);
   return EB_SUCCESS;
}

Here is the caller graph for this function:

eb_end_of_run()

INT eb_end_of_run	(	INT	rn,
		char *	error
	)

Hook to the event builder task at completion of event collection after receiving the Stop transition.

Parameters

rn	run number
error	error string to be passed back to the system.

Returns

EB_SUCCESS

Definition at line 121 of file ebuser.cxx.

{
   printf("In eb_end_of_run\n");
   return EB_SUCCESS;
}

Here is the caller graph for this function:

eb_user()

INT eb_user	(	INT	nfrag,
		BOOL	mismatch,
		EBUILDER_CHANNEL *	ebch,
		EVENT_HEADER *	pheader,
		void *	pevent,
		INT *	dest_size
	)

Hook to the event builder task after the reception of all fragments of the same serial number. The destination event has already the final EVENT_HEADER setup with the data size set to 0. It is than possible to add private data at this point using the proper bank calls. Therefore any new banks created within eb_user will be appearing before the collected banks from the fragments. When using the eb_user with the ODB flag "user build=y" (equipments/EB/settings) the automatic event builder is skipped. This allow the user to extract selectively from the different fragments the appropriate banks and compose the final destination event. In order to do so, the function "bk_copy(pevent, ebch[i].pfragment, bankname)" will copy a particular bank from a given fragment.

Note: It exists two Midas event format to address bank size less than 32KB and larger bank size <4GB. This distinction is done by the call bk_init(pevent) for the small bank size and bk_init32(pevent) for large bank size. Within an experiment, this declaration has to be consistant. Therefore the bk_init in the eb_user should follow as well the type of the frontends.

The ebch[] array structure points to nfragment channel structure with the following content:

typedef struct {
    char  name[32];         // Fragment name (Buffer name).
    DWORD serial;           // Serial fragment number.
    char *pfragment;        // Pointer to fragment (EVENT_HEADER *)
    ...
} EBUILDER_CHANNEL;

The correct code for including your own MIDAS bank is shown below where TID_xxx is one of the valid Bank type starting with TID_ for midas format bank_name is a 4 character descriptor. pdata has to be declared accordingly with the bank type. Refers to the ebuser.c source code for further description.

It is not possible to mix within the same destination event different event format! No bk_swap performed when user build is requested.

  // Event is empty, fill it with BANK_HEADER
  // If you need to add your own bank at this stage
 
  // Need to match the decalration in the Frontends.
  bk_init(pevent);  
//  bk_init32(pevent);
  bk_create(pevent, bank_name, TID_xxxx, &pdata);
  *pdata++ = ...;
  *dest_size = bk_close(pevent, pdata);
  pheader->data_size = *dest_size + sizeof(EVENT_HEADER);

Parameters

nfrag	Number of fragment.
mismatch	Midas Serial number mismatch flag.
ebch	Structure to all the fragments.
pheader	Destination pointer to the header.
pevent	Destination pointer to the bank header.
dest_size	Destination event size in bytes.

Returns

EB_SUCCESS

Definition at line 192 of file ebuser.cxx.

{
  INT i, frag_size, serial, status;
  DWORD  *pdata;
 
 
  //
  // Do some extra fragment consistency check
  if (mismatch){
    printf("Serial number do not match across fragments\n");
    for (i = 0; i < nfrag; i++) {
      serial = ((EVENT_HEADER *) ebch[i].pfragment)->serial_number;
      printf("Ser[%i]:%d ", i + 1, serial);
    }
    printf("\n");
    return EB_USER_ERROR;
  }
 
  //
  // Include my own bank
  bk_init(pevent);
  bk_create(pevent, "MYOW", TID_DWORD, (void**)&pdata);
  for (i = 0; i < nfrag; i++) {
     if (ebset.preqfrag[i]) { // if channel enable
        *pdata++ = ((EVENT_HEADER *) ebch[i].pfragment)->serial_number;
        *pdata++ = ((EVENT_HEADER *) ebch[i].pfragment)->time_stamp;
     }
  }
  *dest_size = bk_close(pevent, pdata);
  pheader->data_size = *dest_size + sizeof(EVENT_HEADER);
 
  // Copy the bank TC01 if found from fragment0 to the destination
  status = bk_copy((char*)pevent, ebch[0].pfragment, "TC01");
  if (status == EB_BANK_NOT_FOUND) {
    printf("bank TC01 not found\n");
  }
 
  // Destination access
  // dest_serial = pheader->serial_number;
  // printf("DSer#:%d ", dest_serial);
 
  // Stop run if condition requires
  // if (dest_serial == 505) return EB_USER_ERROR;
 
  // Skip event if condition requires
  // if (dest_serial == 505) return EB_SKIP;
 
  //
  // Loop over fragments.
  if (debug) {
    for (i = 0; i < nfrag; i++) {
      if (1) {
   if (ebset.preqfrag[i]) { // printf if channel enable
     frag_size = ((EVENT_HEADER *) ebch[i].pfragment)->data_size;
     serial = ((EVENT_HEADER *) ebch[i].pfragment)->serial_number;
     printf("Frg#:%d Dsz:%d Ser:%d ", i, frag_size, serial);
     // For Data fragment Access.
     // psrcData = (DWORD *) (((EVENT_HEADER *) ebch[i].pfragment) + 1);
   }
      }
    }
    printf("\n");
  }
  return EB_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ebuilder_exit()

INT ebuilder_exit

(

void

)

Definition at line 87 of file ebuser.cxx.

{
  return EB_SUCCESS;
}

Here is the caller graph for this function:

ebuilder_init()

INT ebuilder_init

(

void

)

Definition at line 79 of file ebuser.cxx.

{
  setbuf(stdout, NULL);
  setbuf(stderr, NULL);
  return EB_SUCCESS;
}

Here is the caller graph for this function:

ebuilder_loop()

INT ebuilder_loop

(

void

)

Definition at line 93 of file ebuser.cxx.

{
  return EB_SUCCESS;
}

ebuser()

INT ebuser	(	INT	,
		BOOL	mismatch,
		EBUILDER_CHANNEL *	,
		EVENT_HEADER *	,
		void *	,
		INT *
	)

read_scaler_event()

INT read_scaler_event	(	char *	pevent,
		INT	off
	)

Scaler event readout.

Scaler event readout routine. Not used in this example.

Parameters

[in]	pevent	Pointer to event buffer
[in]	off	Caller info (unused here), see mfe.c

Returns

Size of the event

Definition at line 295 of file ebfe.cxx.

{
   DWORD *pdata, a;
 
   /* init bank structure */
   bk_init(pevent);
 
   /* create SCLR bank */
   bk_create(pevent, Sclx, TID_DWORD, (void**)&pdata);
 
   /* read scaler bank */
   for (a = 0; a < N_SCLR; a++)
      cam24i(CRATE, SLOT_SCLR, a, 0, pdata++);
 
   bk_close(pevent, pdata);
 
   return bk_size(pevent);
}

Variable Documentation

debug

BOOL debug

extern

Definition at line 254 of file mana.cxx.

display_period

INT display_period = 3000

Definition at line 35 of file ebuser.cxx.

ebset

EBUILDER_SETTINGS ebset

extern

Definition at line 34 of file mevb.cxx.

ebuilder_call_loop

BOOL ebuilder_call_loop = FALSE

Definition at line 32 of file ebuser.cxx.

equipment

EQUIPMENT equipment[]

Initial value:

= {
   {"EB",                
    {1, 0,                   
     "SYSTEM",               
     0,                      
     0,                      
     "MIDAS",                
     TRUE,                   
     },
    },
 
  {""}
}

Definition at line 62 of file ebuser.cxx.

                        {
   {"EB",                /* equipment name */
    {1, 0,                   /* event ID, trigger mask */
     "SYSTEM",               /* event buffer */
     0,                      /* equipment type */
     0,                      /* event source */
     "MIDAS",                /* format */
     TRUE,                   /* enabled */
     },
    },
 
  {""}
};

event_buffer_size

INT event_buffer_size = 20 * 50000

Definition at line 44 of file ebuser.cxx.

frontend_file_name

const char* frontend_file_name = __FILE__

Definition at line 29 of file ebuser.cxx.

frontend_name

const char* frontend_name = "Ebuilder"

Definition at line 26 of file ebuser.cxx.

lModulo

INT lModulo = 100

Global var for testing passed at BOR.

Globals

Definition at line 48 of file ebuser.cxx.

max_event_size

INT max_event_size = 500000

Definition at line 38 of file ebuser.cxx.

max_event_size_frag

INT max_event_size_frag = 5 * 1024 * 1024

Definition at line 41 of file ebuser.cxx.

tid_size

INT tid_size[]

extern

Definition at line 55 of file mhdump.cxx.

                 {
   0,                           /* tid == 0 not defined                               */
   1,                           /* TID_BYTE      unsigned byte         0       255    */
   1,                           /* TID_SBYTE     signed byte         -128      127    */
   1,                           /* TID_CHAR      single character      0       255    */
   2,                           /* TID_WORD      two bytes             0      65535   */
   2,                           /* TID_SHORT     signed word        -32768    32767   */
   4,                           /* TID_DWORD     four bytes            0      2^32-1  */
   4,                           /* TID_INT       signed dword        -2^31    2^31-1  */
   4,                           /* TID_BOOL      four bytes bool       0        1     */
   4,                           /* TID_FLOAT     4 Byte float format                  */
   8,                           /* TID_DOUBLE    8 Byte float format                  */
   1,                           /* TID_BITFIELD  8 Bits Bitfield    00000000 11111111 */
   0,                           /* TID_STRING    zero terminated string               */
   0,                           /* TID_ARRAY     variable length array of unkown type */
   0,                           /* TID_STRUCT    C structure                          */
   0,                           /* TID_KEY       key in online database               */
   0,                           /* TID_LINK      link in online database              */
   8,                           /* TID_INT64     8 bytes int          -2^63   2^63-1  */
   8                            /* TID_UINT64    8 bytes unsigned int  0      2^64-1  */
};