frontend.cxx File Reference

#include <stdio.h>
#include <math.h>
#include "midas.h"
#include "class/generic.h"
#include "device/epics_ca.h"
#include "mfe.h"

Include dependency graph for frontend.cxx:

Go to the source code of this file.

Functions
INT	poll_event (INT source, INT count, BOOL test)
INT	interrupt_configure (INT cmd, INT source, PTYPE adr)
INT	frontend_init ()
	Frontend initialization.
INT	frontend_exit ()
	Frontend exit.
INT	frontend_loop ()
	Frontend loop.
INT	begin_of_run (INT run_number, char *error)
	Begin of Run.
INT	end_of_run (INT run_number, char *error)
	End of Run.
INT	pause_run (INT run_number, char *error)
	Pause Run.
INT	resume_run (INT run_number, char *error)
	Resume Run.

Variables
const char *	frontend_name = "feEpics"
const char *	frontend_file_name = __FILE__
BOOL	frontend_call_loop = TRUE
INT	display_period = 2000
INT	max_event_size_frag = 5 * 1024 * 1024
INT	max_event_size = 10000
INT	event_buffer_size = 10 * 10000
BOOL	equipment_common_overwrite = FALSE
DEVICE_DRIVER	epics_driver []
EQUIPMENT	equipment []

Function Documentation

begin_of_run()

INT begin_of_run	(	INT	run_number,
		char *	error
	)

Begin of Run.

Called every run start transition. Set equipment status in ODB, start acquisition on the modules.

Parameters

[in]	run_number	Number of the run being started
[out]	error	Can be used to write a message string to midas.log

Definition at line 216 of file frontend.cxx.

{
   return CM_SUCCESS;
}

end_of_run()

INT end_of_run	(	INT	run_number,
		char *	error
	)

End of Run.

Called every stop run transition. Set equipment status in ODB, stop acquisition on the modules.

Parameters

[in]	run_number	Number of the run being ended
[out]	error	Can be used to write a message string to midas.log

Definition at line 223 of file frontend.cxx.

{
   return CM_SUCCESS;
}

frontend_exit()

INT frontend_exit

(

void

)

Frontend exit.

Runs at frontend shutdown. Disconnect hardware and set equipment status in ODB

Returns

Midas status code

Definition at line 153 of file frontend.cxx.

{
   return CM_SUCCESS;
}

frontend_init()

INT frontend_init

(

void

)

Frontend initialization.

Runs once at application startup. We initialize the hardware and optical interfaces and set the equipment status in ODB. We also lock the frontend to once physical cpu core.

Returns

Midas status code

Definition at line 118 of file frontend.cxx.

{
   /* enable/disable certain command in device driver */
 
   // default number of channels is set in the epics_driver struct
   // at the top of this file. If ODB has more channels, we do not want
   // them truncated. Set number of channels to what we see in ODB. K.O.
 
   int status;
   HNDLE hkey;
   std::string odb_path;
   odb_path += "/Equipment/";
   odb_path += equipment[0].name;
   odb_path += "/Variables/Measured";
   
   status = db_find_key(hDB, 0, odb_path.c_str(), &hkey);
   if (hkey) {
      KEY key;
      status = db_get_key(hDB, hkey, &key);
      if (status == DB_SUCCESS) {
    int default_values = epics_driver[0].channels;
 
    //printf("key [%s] size %d default %d\n", key.name, key.num_values, default_values);
    
    if (key.num_values > default_values) {
       epics_driver[0].channels = key.num_values;
    }
      }
   }
 
   return CM_SUCCESS;
}

Here is the call graph for this function:

frontend_loop()

INT frontend_loop

(

void

)

Frontend loop.

If frontend_call_loop is true, this routine gets called when the frontend is idle or once between every event.

Returns

Midas status code

Definition at line 163 of file frontend.cxx.

{
  int status, size;
  static HNDLE hDB, hWatch=0, hRespond;
  static DWORD watchdog_time=0;
  static float  dog=0.f;
  
  /* slow down frontend not to eat all CPU cycles */
  /* ss_sleep(50); */
  status = cm_yield(50); /* 15Feb05 */
  
  //if (status != SS_TIMEOUT)
  //  cm_msg(MERROR, "frontend_loop", "cm_yield status %d", status);
 
  if (status == RPC_SHUTDOWN || status == SS_ABORT) {
    return status;
  }
  
  if (ss_time() - watchdog_time > 10)
    {
      //const float wraparound = 100;
      watchdog_time = ss_time();
      if (!hWatch)
        {
          cm_get_experiment_database(&hDB, NULL);
          status = db_find_key(hDB, 0, "/equipment/Beamline/variables/demand", &hWatch);
          status = db_find_key(hDB, 0, "/equipment/Beamline/variables/measured", &hRespond);
          if (status != DB_SUCCESS) {
            cm_msg(MERROR, "frontend_loop", "key not found");
            return FE_ERR_HW;
          }
        }
      if (hWatch) {
        /* Check if Epics alive */
        float cat=0.f;
        size = sizeof(float);
        db_get_data_index(hDB, hRespond, &cat, &size, 19, TID_FLOAT);
        if (fabs(dog - cat) > 10) {
          cm_msg(MINFO,"feEpics","Epics R/W access watchdog failure, wrote %f, read %f!", dog, cat);
        }
        
        db_set_data_index(hDB, hWatch, &dog, sizeof(float), 19, TID_FLOAT);
      }
      dog += 1;
      // watchdog mismatch check above does not know how to check for wraparound. K.O.
      //if (dog > wraparound)
      //  dog = 0;
    }
  return CM_SUCCESS;
}

Here is the call graph for this function:

interrupt_configure()

INT interrupt_configure	(	INT	cmd,
		INT	source,
		PTYPE	adr
	)

Definition at line 111 of file frontend.cxx.

{
   return 1;
};

pause_run()

INT pause_run	(	INT	run_number,
		char *	error
	)

Pause Run.

Called every pause run transition.

Parameters

[in]	run_number	Number of the run being ended
[out]	error	Can be used to write a message string to midas.log

Returns

Midas status code

Definition at line 230 of file frontend.cxx.

{
   return CM_SUCCESS;
}

poll_event()

INT poll_event	(	INT	source,
		INT	count,
		BOOL	test
	)

Definition at line 107 of file frontend.cxx.

{
   return 1;
};

resume_run()

INT resume_run	(	INT	run_number,
		char *	error
	)

Resume Run.

Called every resume run transition.

Parameters

[in]	run_number	Number of the run being ended
[out]	error	Can be used to write a message string to midas.log

Returns

Midas status code

Definition at line 237 of file frontend.cxx.

{
   return CM_SUCCESS;
}

Variable Documentation

display_period

INT display_period = 2000

Definition at line 31 of file frontend.cxx.

epics_driver

DEVICE_DRIVER epics_driver[]

Initial value:

= {
  {"Beamline", epics_ca, 20, NULL},  
  {""}
}

Definition at line 76 of file frontend.cxx.

                               {
  {"Beamline", epics_ca, 20, NULL},  /* disable CMD_SET_LABEL */
  {""}
};

equipment

EQUIPMENT equipment[]

Initial value:

= {
 
   {"Beamline",                 
    { 3, 0,                       
    "SYSTEM",                   
    EQ_SLOW,                    
    0,                          
    "FIXED",                    
    TRUE,                       
    RO_RUNNING | RO_TRANSITIONS,        
    60000,                      
    0,                          
    0,                          
    1,                          
    "", "", "" },
    cd_gen_read,                
    cd_gen,                     
    epics_driver,               
    NULL,                       
    },
 
   {""}
}

Definition at line 81 of file frontend.cxx.

                        {
 
   {"Beamline",                 /* equipment name */
    { 3, 0,                       /* event ID, trigger mask */
    "SYSTEM",                   /* event buffer */
    EQ_SLOW,                    /* equipment type */
    0,                          /* event source */
    "FIXED",                    /* format */
    TRUE,                       /* enabled */
    RO_RUNNING | RO_TRANSITIONS,        /* read when running and on transitions */
    60000,                      /* read every 60 sec */
    0,                          /* stop run after this event limit */
    0,                          /* number of sub events */
    1,                          /* log history every event */
    "", "", "" },
    cd_gen_read,                /* readout routine */
    cd_gen,                     /* class driver main routine */
    epics_driver,               /* device driver list */
    NULL,                       /* init string */
    },
 
   {""}
};

equipment_common_overwrite

BOOL equipment_common_overwrite = FALSE

Definition at line 42 of file frontend.cxx.

event_buffer_size

INT event_buffer_size = 10 * 10000

Definition at line 40 of file frontend.cxx.

frontend_call_loop

BOOL frontend_call_loop = TRUE

Definition at line 28 of file frontend.cxx.

frontend_file_name

const char* frontend_file_name = __FILE__

Definition at line 25 of file frontend.cxx.

frontend_name

const char* frontend_name = "feEpics"

Definition at line 23 of file frontend.cxx.

max_event_size

INT max_event_size = 10000

Definition at line 37 of file frontend.cxx.

max_event_size_frag

INT max_event_size_frag = 5 * 1024 * 1024

Definition at line 34 of file frontend.cxx.