midas.h

Go to the documentation of this file.
00001 /********************************************************************\
00002 
00003   Name:         MIDAS.H
00004   Created by:   Stefan Ritt
00005 
00006   Contents:     Type definitions and function declarations needed
00007                 for MIDAS applications
00008 
00009 
00010   $Log: midas.h,v $
00011   Revision 1.127  2004/01/19 16:53:35  olchansk
00012   add midas_thread_t
00013 
00014   Revision 1.126  2004/01/17 05:35:53  olchansk
00015   replace #define ALIGN() with ALIGN8() to dodge namespace pollution under macosx
00016   hide strlcpy() & co #ifdef HAVE_STRLCPY (macosx already has strlcpy())
00017   correct inconsistent prototype of dbg_malloc() and dbg_calloc()
00018 
00019   Revision 1.125  2004/01/13 00:51:04  pierre
00020   fix dox comment for vxworks
00021 
00022   Revision 1.124  2004/01/08 08:40:09  midas
00023   Implemented standard indentation
00024 
00025   Revision 1.123  2004/01/08 06:29:07  pierre
00026   Doxygen the file
00027 
00028   Revision 1.122  2003/11/24 08:22:45  midas
00029   Changed timeouts from INT to DWORD, added ignore_timeout to cm_cleanup, adde '-f' flag to ODBEdit 'cleanup'
00030 
00031   Revision 1.121  2003/11/20 11:28:47  midas
00032   Added db_check_record
00033 
00034   Revision 1.120  2003/06/12 18:34:37  pierre
00035   add ss_tape_get_blockn
00036 
00037   Revision 1.119  2003/05/09 07:40:04  midas
00038   Added extra parameter to cm_get_environment
00039 
00040   Revision 1.118  2003/05/08 19:36:24  midas
00041   Changed size_t into INT
00042 
00043   Revision 1.117  2003/05/07 10:55:47  midas
00044   Export strlcpy
00045 
00046   Revision 1.116  2003/05/02 09:04:50  midas
00047   Version 1.9.3
00048 
00049   Revision 1.115  2003/05/02 09:03:01  midas
00050   Fixed buffer overflows by strlcpy()
00051 
00052   Revision 1.114  2003/04/22 15:14:09  midas
00053   Added #undef GetCurrentTime
00054 
00055   Revision 1.113  2003/04/22 12:00:56  midas
00056   Added rpc_client_check
00057 
00058   Revision 1.112  2003/04/22 10:09:21  midas
00059   Added RPC_NODELAY option
00060 
00061   Revision 1.111  2003/04/15 10:50:00  midas
00062   Removed unnecessary elements in KEY structure
00063 
00064   Revision 1.110  2003/04/15 08:16:48  midas
00065   Increased default ODB size to 1M
00066 
00067   Revision 1.109  2003/04/14 12:58:16  midas
00068   Added event_descrip to equipment
00069 
00070   Revision 1.108  2003/04/09 13:48:18  midas
00071   Added ROOT format
00072 
00073   Revision 1.107  2003/03/26 21:09:46  midas
00074   Corrected version string
00075 
00076   Revision 1.106  2003/03/22 06:56:12  olchansk
00077   add DB_CORRUPTED error code
00078 
00079   Revision 1.105  2003/03/17 06:36:55  olchansk
00080   really remove Windows-style "\r" characters
00081 
00082   Revision 1.104  2002/10/22 03:46:33  pierre
00083   add SS_NO_TAPE
00084 
00085   Revision 1.103  2002/09/19 17:50:22  pierre
00086   remove ^m
00087 
00088   Revision 1.102  2002/09/18 16:36:24  pierre
00089   add bk_list()
00090 
00091   Revision 1.101  2002/09/13 07:32:36  midas
00092   Added client name to cm_cleanup()
00093 
00094   Revision 1.100  2002/06/10 07:06:55  midas
00095   Added 'lock' parameter to db_remove_open_record() to work also remotely
00096 
00097   Revision 1.99  2002/06/06 07:49:46  midas
00098   Added DF_xxx flags for device drivers
00099 
00100   Revision 1.98  2002/06/06 07:15:03  midas
00101   Added demand_priority for SC FE
00102 
00103   Revision 1.97  2002/05/22 22:10:03  midas
00104   Version 1.9.1
00105 
00106   Revision 1.96  2002/05/22 05:43:32  midas
00107   Added extra variables to hs_enum_vars for mhist to display array size
00108 
00109   Revision 1.95  2002/05/16 18:01:13  midas
00110   Added subdir creation in logger and improved program restart scheme
00111 
00112   Revision 1.94  2002/05/15 23:44:47  midas
00113   Added EVENTID_FRAG for fragmented events
00114 
00115   Revision 1.93  2002/05/13 20:36:43  midas
00116   Changed type_t to unsigned int for malloc/free
00117 
00118   Revision 1.92  2002/05/13 17:56:36  midas
00119   Added improved malloc/free functions
00120 
00121   Revision 1.91  2002/05/10 01:41:19  midas
00122   Added optional debug output to cm_transition
00123 
00124   Revision 1.90  2002/05/09 18:16:55  midas
00125   Version 1.9.0
00126 
00127   Revision 1.89  2002/05/08 19:54:40  midas
00128   Added extra parameter to function db_get_value()
00129 
00130   Revision 1.88  2002/03/19 22:15:40  pierre
00131   Added  ~defined (OS_IRIX)
00132 
00133   Revision 1.87  2002/03/13 08:39:01  midas
00134   Added periodic alarms
00135 
00136   Revision 1.86  2001/10/03 08:36:02  midas
00137   Added DB_INVALID_LINK
00138 
00139   Revision 1.85  2001/08/22 13:51:14  midas
00140   Reorganized directio functions
00141 
00142   Revision 1.84  2001/08/08 11:44:59  midas
00143   Release 1.8.3
00144 
00145   Revision 1.83  2001/06/27 12:16:30  midas
00146   Added OS_IRIX
00147 
00148   Revision 1.82  2001/04/05 05:51:03  midas
00149   Added CMD_NAME
00150 
00151   Revision 1.81  2001/04/04 04:12:08  midas
00152   changed slow control commands
00153 
00154   Revision 1.80  2001/02/26 11:57:46  midas
00155   Added CMD_READ and CMD_WRITE
00156 
00157   Revision 1.79  2001/01/29 09:51:54  midas
00158   Put if defined(__linux__) under #if !defined(OS_LINUX)
00159 
00160   Revision 1.78  2001/01/22 08:26:58  midas
00161   Added evaluation of __linux__
00162 
00163   Revision 1.77  2001/01/04 11:27:37  midas
00164   Added bus driver commands and structures
00165 
00166   Revision 1.76  2000/11/20 12:23:17  midas
00167   Version 1.8.2
00168 
00169   Revision 1.75  2000/11/20 11:26:52  midas
00170   Added "use tests" in analyzer request
00171 
00172   Revision 1.74  2000/11/14 08:17:04  midas
00173   Added number of messages for cm_msg_retrieve and in odbedit "old" command
00174 
00175   Revision 1.73  2000/10/23 14:19:05  midas
00176   Added idle period for slow control equipment
00177 
00178   Revision 1.72  2000/09/29 13:31:10  midas
00179   ODBEdit cleanup now deletes open record with no client attached to
00180 
00181   Revision 1.71  2000/09/28 13:01:25  midas
00182   Added manual triggered events
00183 
00184   Revision 1.70  2000/08/21 14:19:11  midas
00185   bk_close return bank size
00186 
00187   Revision 1.69  2000/08/11 11:43:50  midas
00188   Added cm_msg1 to produce messages which go to a differnt logging file
00189 
00190   Revision 1.68  2000/06/07 10:49:07  midas
00191   Release 1.8.1
00192 
00193   Revision 1.67  2000/06/06 13:45:11  midas
00194   Added locking of histos
00195 
00196   Revision 1.66  2000/05/08 14:29:37  midas
00197   Added delete option in ELog
00198 
00199   Revision 1.65  2000/04/26 20:23:47  pierre
00200   - Moved doc++ comments for functions to midas.c (macros still in there)
00201 
00202   Revision 1.64  2000/04/17 17:07:05  pierre
00203   - new arg in hs_dump and hs_fdump (for mhist)
00204   - first round of doc++ comments
00205 
00206   Revision 1.63  2000/03/08 17:35:56  midas
00207   Version 1.8.0
00208 
00209   Revision 1.62  2000/03/02 21:57:31  midas
00210   Added new slow control commands
00211 
00212   Revision 1.61  2000/03/01 00:52:34  midas
00213   Added num_subevents into equipment, made events_sent a double
00214 
00215   Revision 1.60  2000/02/29 02:09:33  midas
00216   Added cm_is_ctrlc_pressed and cm_ack_ctrlc_pressed
00217 
00218   Revision 1.59  2000/02/25 22:22:45  midas
00219   Added abort feature in db_scan_tree
00220 
00221   Revision 1.58  2000/02/25 20:22:23  midas
00222   Added super-event scheme
00223 
00224   Revision 1.57  2000/02/24 22:33:16  midas
00225   Added deferred transitions
00226 
00227   Revision 1.56  2000/02/15 11:07:50  midas
00228   Changed GET_xxx to bit flags
00229 
00230   Revision 1.55  2000/02/09 08:03:27  midas
00231   Changed version to 1.7.1
00232 
00233   Revision 1.54  1999/12/08 00:29:34  pierre
00234   - Add CM_SET_LABEL for cd_gen/dd_epca (chn_acc)
00235 
00236   Revision 1.53  1999/11/19 09:49:36  midas
00237   Added watchdog_timeout to cm_set_client_info
00238 
00239   Revision 1.52  1999/11/09 13:17:00  midas
00240   Changed shared memory function names to ss_shm_xxx instead ss_xxx_shm
00241 
00242   Revision 1.51  1999/11/08 13:55:54  midas
00243   Added AT_xxx
00244 
00245   Revision 1.50  1999/11/04 15:53:54  midas
00246   Added some slow control commands
00247 
00248   Revision 1.49  1999/10/18 14:41:50  midas
00249   Use /programs/<name>/Watchdog timeout in all programs as timeout value. The
00250   default value can be submitted by calling cm_connect_experiment1(..., timeout)
00251 
00252   Revision 1.48  1999/10/08 15:07:04  midas
00253   Program check creates new internal alarm when triggered
00254 
00255   Revision 1.47  1999/10/07 13:17:34  midas
00256   Put a few EXPRT im msystem.h to make NT happy, updated NT makefile
00257 
00258   Revision 1.46  1999/10/06 08:56:33  midas
00259   Added /programs/xxx/required flag
00260 
00261   Revision 1.45  1999/09/27 13:49:03  midas
00262   Added bUnique parameter to cm_shutdown
00263 
00264   Revision 1.44  1999/09/27 12:54:55  midas
00265   Finished alarm system
00266 
00267   Revision 1.43  1999/09/23 12:45:48  midas
00268   Added 32 bit banks
00269 
00270   Revision 1.42  1999/09/22 15:39:36  midas
00271   Logger won't start run if disk file already exists
00272 
00273   Revision 1.41  1999/09/21 13:49:02  midas
00274   Added PROGRAM_INFO
00275 
00276   Revision 1.40  1999/09/17 15:06:46  midas
00277   Moved al_check into cm_yield() and rpc_server_thread
00278 
00279   Revision 1.39  1999/09/17 11:54:43  midas
00280   OS_LINUX & co automatically define OS_UNIX
00281 
00282   Revision 1.38  1999/09/17 11:48:04  midas
00283   Alarm system half finished
00284 
00285   Revision 1.37  1999/09/15 13:33:32  midas
00286   Added remote el_submit functionality
00287 
00288   Revision 1.36  1999/09/14 15:15:43  midas
00289   Moved el_xxx funtions into midas.c
00290 
00291   Revision 1.35  1999/09/14 11:46:04  midas
00292   Added EL_FIRST_MESSAGE
00293 
00294   Revision 1.34  1999/08/31 15:12:34  midas
00295   Added EL_LAST_MSG
00296 
00297   Revision 1.33  1999/08/26 15:18:22  midas
00298   Added EL_xxx codes
00299 
00300   Revision 1.32  1999/08/20 13:31:18  midas
00301   Analyzer saves and reloads online histos
00302 
00303   Revision 1.31  1999/08/03 11:15:07  midas
00304   Added bm_skip_event
00305 
00306   Revision 1.30  1999/07/15 07:35:12  midas
00307   Added ss_ctrlc_handler
00308 
00309   Revision 1.29  1999/07/13 08:24:27  midas
00310   Added ANA_TEST
00311 
00312   Revision 1.28  1999/06/28 12:01:33  midas
00313   Added hs_fdump
00314 
00315   Revision 1.27  1999/06/25 12:02:12  midas
00316   Added bk_delete function
00317 
00318   Revision 1.26  1999/06/23 09:58:28  midas
00319   Fixed typo
00320 
00321   Revision 1.25  1999/05/05 12:01:42  midas
00322   Added and modified hs_xxx functions
00323 
00324   Revision 1.24  1999/04/30 10:58:20  midas
00325   Added mode to rpc_set_debug
00326 
00327   Revision 1.23  1999/04/27 11:11:39  midas
00328   Added rpc_register_client
00329 
00330   Revision 1.22  1999/04/23 11:43:15  midas
00331   Increased version to 1.7.0
00332 
00333   Revision 1.21  1999/04/19 07:46:43  midas
00334   Added cm_msg_retrieve
00335 
00336   Revision 1.20  1999/04/15 09:59:09  midas
00337   Added key name to db_get_key_info
00338 
00339   Revision 1.19  1999/04/13 12:20:42  midas
00340   Added db_get_data1 (for Java)
00341 
00342   Revision 1.18  1999/04/08 15:23:46  midas
00343   Added CF_ASCII and db_get_key_info
00344 
00345   Revision 1.17  1999/03/02 10:00:07  midas
00346   Added ANA_CONTINUE and ANA_SKIP
00347 
00348   Revision 1.16  1999/02/18 13:06:27  midas
00349   Release 1.6.3
00350 
00351   Revision 1.15  1999/02/18 11:20:39  midas
00352   Added "level" parameter to db_scan_tree and db_scan_tree_link
00353 
00354   Revision 1.14  1999/02/11 13:20:29  midas
00355   Changed cm_msg from void to INT
00356 
00357   Revision 1.13  1999/02/09 14:38:54  midas
00358   Added debug logging facility
00359 
00360   Revision 1.12  1999/01/20 09:03:38  midas
00361   Added LAM_SOURCE_CRATE and LAM_SOURCE_STATION macros
00362 
00363   Revision 1.11  1999/01/19 10:26:39  midas
00364   Changed CRATE and STATION macros to LAM_SOURCE and LAM_STATION
00365 
00366   Revision 1.10  1999/01/13 09:40:48  midas
00367   Added db_set_data_index2 function
00368 
00369   Revision 1.9  1998/12/11 11:23:17  midas
00370   Release 1.6.2
00371 
00372   Revision 1.8  1998/12/10 10:18:38  midas
00373   Added SS_END_OF_FILE
00374 
00375   Revision 1.7  1998/10/29 15:58:05  midas
00376   Release 1.6.1
00377 
00378   Revision 1.6  1998/10/23 14:35:16  midas
00379   Added version comment
00380 
00381   Revision 1.5  1998/10/23 14:21:35  midas
00382   - Modified version scheme from 1.06 to 1.6.0
00383   - cm_get_version() now returns versino as string
00384 
00385   Revision 1.4  1998/10/23 13:11:13  midas
00386   Modified release number to 1.6
00387 
00388   Revision 1.3  1998/10/22 12:40:20  midas
00389   Added "oflag" to ss_tape_open()
00390 
00391   Revision 1.2  1998/10/12 12:18:59  midas
00392   Added Log tag in header
00393 
00394 
00395   Previous Revision history
00396   ------------------------------------------------------------------
00397   date         by    modification
00398   ---------    ---   ------------------------------------------------
00399   11-NOV-95    SR    created
00400   03-JUN-97    SR    increased number of clients to 32
00401 
00402 \********************************************************************/
00403 
00404 #ifndef _MIDAS_H_
00405 #define _MIDAS_H_
00406 
00407 /*------------------------------------------------------------------*/
00408 
00409 /* MIDAS library version number. This value is returned by 
00410    cm_get_version and will be incremented whenever changes are done
00411    to the MIDAS library. First digit is major release, second
00412    digit is minor release, third digit is patch level */
00413 
00414 /**dox***************************************************************/
00415 /** @file midas.h
00416 The main include file
00417 */
00418 
00419 /** @defgroup midasincludecode The midas.h & midas.c
00420  */
00421 /** @defgroup mdefineh Midas #define 
00422  */
00423 /** @defgroup mmacroh Midas Macros
00424  */
00425 /** @defgroup mdeferrorh Midas Error definition
00426  */
00427 /** @defgroup msectionh Midas Structure Declaration
00428  */
00429 
00430 /**dox***************************************************************/
00431 /** @addtogroup midasincludecode
00432  *  
00433  *  @{  */
00434 
00435 #define MIDAS_VERSION "1.9.3"
00436 
00437 /**dox***************************************************************/
00438 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00439 
00440 /*------------------------------------------------------------------*/
00441 
00442 /* find out on which operating system we are running */
00443 
00444 #if defined( VAX ) || defined( __VMS )
00445 #define OS_VMS
00446 #endif
00447 
00448 #if defined( _MSC_VER )
00449 #define OS_WINNT
00450 #endif
00451 
00452 #if defined( __MSDOS__ )
00453 #define OS_MSDOS
00454 #endif
00455 
00456 #if defined ( vxw )
00457 #define OS_VXWORKS
00458 #undef OS_UNIX
00459 #endif
00460 
00461 #if !defined(OS_LINUX)
00462 #if defined ( __linux__ )
00463 #define OS_LINUX
00464 #endif
00465 #endif
00466 
00467 #if defined(OS_LINUX) || defined(OS_OSF1) || defined(OS_ULTRIX) || defined(OS_FREEBSD) || defined(OS_SOLARIS) || defined(OS_IRIX) || defined(OS_DARWIN)
00468 #define OS_UNIX
00469 #endif
00470 
00471 #if !defined(OS_IRIX) && !defined(OS_VMS) && !defined(OS_MSDOS) && !defined(OS_UNIX) && !defined(OS_VXWORKS) && !defined(OS_WINNT)
00472 #error MIDAS cannot be used on this operating system
00473 #endif
00474 
00475 /*------------------------------------------------------------------*/
00476 
00477 /* Define basic data types */
00478 
00479 #ifndef MIDAS_TYPE_DEFINED
00480 #define MIDAS_TYPE_DEFINED
00481 
00482 typedef unsigned char BYTE;
00483 typedef unsigned short int WORD;
00484 
00485 #ifdef __alpha
00486 typedef unsigned int DWORD;
00487 #else
00488 typedef unsigned long int DWORD;
00489 #endif
00490 
00491 #ifndef OS_WINNT
00492 #ifndef OS_VXWORKS
00493 typedef DWORD BOOL;
00494 #endif
00495 #endif
00496 
00497 #endif                          /* MIDAS_TYPE_DEFINED */
00498 
00499 /*
00500   Definitions depending on integer types:
00501 
00502   Note that the alpha chip uses 32 bit integers by default.
00503   Therefore always use 'INT' instead 'int'.
00504 */
00505 #if defined(OS_MSDOS)
00506 typedef long int INT;
00507 #elif defined( OS_WINNT )
00508 
00509 /* INT predefined in windows.h */
00510 #ifndef _INC_WINDOWS
00511 #include <windows.h>
00512 #endif
00513 
00514 #else
00515 typedef int INT;
00516 #endif
00517 
00518 typedef INT HNDLE;
00519 
00520 /* Include vxWorks for BOOL definition */
00521 #ifdef OS_VXWORKS
00522 #ifndef __INCvxWorksh
00523 #include <vxWorks.h>
00524 #endif
00525 #endif
00526 
00527 /*
00528   Definitions depending on pointer types:
00529 
00530   Note that the alpha chip uses 64 bit pointers by default.
00531   Therefore, when converting pointer to integers, always
00532   use the (PTYPE) cast.
00533 */
00534 #ifdef __alpha
00535 #define PTYPE              long int
00536 #else
00537 #define PTYPE              int
00538 #endif
00539 
00540 /* need system-dependant thread type */
00541 #if defined(OS_WINNT)
00542 typedef HANDLE midas_thread_t;
00543 #elif defined(OS_UNIX)
00544 #include <pthread.h>
00545 typedef pthread_t midas_thread_t;
00546 #else
00547 typedef INT midas_thread_t;
00548 #endif
00549 
00550 #define TRUE  1
00551 #define FALSE 0
00552 
00553 /* directory separator */
00554 #if defined(OS_MSDOS) || defined(OS_WINNT)
00555 #define DIR_SEPARATOR     '\\'
00556 #define DIR_SEPARATOR_STR "\\"
00557 #elif defined(OS_VMS)
00558 #define DIR_SEPARATOR     ']'
00559 #define DIR_SEPARATOR_STR "]"
00560 #else
00561 #define DIR_SEPARATOR     '/'
00562 #define DIR_SEPARATOR_STR "/"
00563 #endif
00564 
00565 /* inline functions */
00566 #if defined( _MSC_VER )
00567 #define INLINE __inline
00568 #elif defined(__GNUC__)
00569 #define INLINE __inline__
00570 #else
00571 #define INLINE
00572 #endif
00573 
00574 /**dox***************************************************************/
00575 #endif                          /* DOXYGEN_SHOULD_SKIP_THIS */
00576 
00577 /*------------------------------------------------------------------*/
00578 
00579 /* Definition of implementation specific constants */
00580 
00581 /* all buffer sizes must be multiples of 4 ! */
00582 
00583 #ifdef OS_WINNT
00584 #define TAPE_BUFFER_SIZE       0x100000      /**< buffer size for taping data */
00585 #else
00586 #define TAPE_BUFFER_SIZE       0x8000        /**< buffer size for taping data */
00587 #endif
00588 #define NET_TCP_SIZE           0xFFFF        /**< maximum TCP transfer        */
00589 #define OPT_TCP_SIZE           8192          /**< optimal TCP buffer size     */
00590 #define NET_UDP_SIZE           8192          /**< maximum UDP transfer        */
00591 
00592 #define EVENT_BUFFER_SIZE      0x100000      /**< buffer used for events      */
00593 #define EVENT_BUFFER_NAME      "SYSTEM"      /**< buffer name for commands    */
00594 #define MAX_EVENT_SIZE         0x80000       /**< maximum event size 512k     */
00595 #define DEFAULT_EVENT_BUFFER_SIZE 0x200000;  /**< 2M                          */
00596 #define DEFAULT_ODB_SIZE       0x100000      /**< online database 1M          */
00597 
00598 #define NAME_LENGTH            32            /**< length of names, mult.of 8! */
00599 #define HOST_NAME_LENGTH       256           /**< length of TCP/IP names      */
00600 #define MAX_CLIENTS            32            /**< client processes per buf/db */
00601 #define MAX_EVENT_REQUESTS     10            /**< event requests per client   */
00602 #define MAX_OPEN_RECORDS       100           /**< number of open DB records   */
00603 #define MAX_ODB_PATH           256           /**< length of path in ODB       */
00604 #define MAX_EXPERIMENT         32            /**< number of different exp.    */
00605 #define BANKLIST_MAX           32            /**< max # of banks in event     */
00606 #define STRING_BANKLIST_MAX    BANKLIST_MAX * 4   /**< for bk_list()          */
00607 
00608 
00609 #define MIDAS_TCP_PORT 1175     /* port under which server is listening */
00610 
00611 /* Timeouts [ms] */
00612 #define DEFAULT_RPC_TIMEOUT    10000
00613 #define WATCHDOG_INTERVAL      1000
00614 
00615 #define DEFAULT_WATCHDOG_TIMEOUT 10000
00616 
00617 /*------------------------------------------------------------------*/
00618 
00619 /* Enumeration definitions */
00620 
00621 /**dox***************************************************************/
00622 /** @addtogroup mdefineh
00623  *  
00624  *  @{  */
00625 
00626 /**
00627 System states */
00628 #define STATE_STOPPED 1      /**< MIDAS run stopped                  */
00629 #define STATE_PAUSED  2      /**< MIDAS run paused                   */
00630 #define STATE_RUNNING 3      /**< MIDAS run running                  */
00631 
00632 /**
00633 Data format */
00634 #define FORMAT_MIDAS  1       /**< MIDAS banks                        */
00635 #define FORMAT_YBOS   2       /**< YBOS  banks                        */
00636 #define FORMAT_ASCII  3       /**< ASCII format                       */
00637 #define FORMAT_FIXED  4       /**< Fixed length binary records        */
00638 #define FORMAT_DUMP   5       /**< Dump (detailed ASCII) format       */
00639 #define FORMAT_HBOOK  6       /**< CERN hbook (rz) format             */
00640 #define FORMAT_ROOT   7       /**< CERN ROOT format                   */
00641 
00642 /**
00643 Event Sampling type */
00644 #define GET_ALL   (1<<0)      /**< get all events (consume)           */
00645 #define GET_SOME  (1<<1)      /**< get as much as possible (sampling) */
00646 #define GET_FARM  (1<<2)      /**< distribute events over several
00647                                  clients (farming)                  */
00648 
00649 /**
00650 Data types Definition                         min      max    */
00651 #define TID_BYTE      1       /**< unsigned byte         0       255    */
00652 #define TID_SBYTE     2       /**< signed byte         -128      127    */
00653 #define TID_CHAR      3       /**< single character      0       255    */
00654 #define TID_WORD      4       /**< two bytes             0      65535   */
00655 #define TID_SHORT     5       /**< signed word        -32768    32767   */
00656 #define TID_DWORD     6       /**< four bytes            0      2^32-1  */
00657 #define TID_INT       7       /**< signed dword        -2^31    2^31-1  */
00658 #define TID_BOOL      8       /**< four bytes bool       0        1     */
00659 #define TID_FLOAT     9       /**< 4 Byte float format                  */
00660 #define TID_DOUBLE   10       /**< 8 Byte float format                  */
00661 #define TID_BITFIELD 11       /**< 32 Bits Bitfield      0  111... (32) */
00662 #define TID_STRING   12       /**< zero terminated string               */
00663 #define TID_ARRAY    13       /**< array with unknown contents          */
00664 #define TID_STRUCT   14       /**< structure with fixed length          */
00665 #define TID_KEY      15       /**< key in online database               */
00666 #define TID_LINK     16       /**< link in online database              */
00667 #define TID_LAST     17       /**< end of TID list indicator            */
00668 
00669 /**
00670 Synchronous / Asynchronous flags */
00671 #define SYNC          0
00672 #define ASYNC         1
00673 
00674 /**
00675 Access modes */
00676 #define MODE_READ      (1<<0)
00677 #define MODE_WRITE     (1<<1)
00678 #define MODE_DELETE    (1<<2)
00679 #define MODE_EXCLUSIVE (1<<3)
00680 #define MODE_ALLOC     (1<<7)
00681 
00682 /**
00683 RPC options */
00684 #define RPC_OTIMEOUT       1
00685 #define RPC_OTRANSPORT     2
00686 #define RPC_OCONVERT_FLAG  3
00687 #define RPC_OHW_TYPE       4
00688 #define RPC_OSERVER_TYPE   5
00689 #define RPC_OSERVER_NAME   6
00690 #define RPC_CONVERT_FLAGS  7
00691 #define RPC_ODB_HANDLE     8
00692 #define RPC_CLIENT_HANDLE  9
00693 #define RPC_SEND_SOCK      10
00694 #define RPC_WATCHDOG_TIMEOUT 11
00695 #define RPC_NODELAY        12
00696 
00697 #define RPC_TCP            0
00698 #define RPC_FTCP           1
00699 
00700 /**
00701 Watchdog flags */
00702 #define WF_WATCH_ME   (1<<0)    /* see cm_set_watchdog_flags   */
00703 #define WF_CALL_WD    (1<<1)
00704 
00705 /**
00706 Transitions values */
00707 #define TR_START      (1<<0)  /**< Start transition  */
00708 #define TR_STOP       (1<<1)  /**< Stop transition  */
00709 #define TR_PAUSE      (1<<2)  /**< Pause transition */
00710 #define TR_RESUME     (1<<3)  /**< Resume transition  */
00711 #define TR_PRESTART   (1<<4)
00712 #define TR_POSTSTART  (1<<5)
00713 #define TR_PRESTOP    (1<<6)
00714 #define TR_POSTSTOP   (1<<7)
00715 #define TR_PREPAUSE   (1<<8)
00716 #define TR_POSTPAUSE  (1<<9)
00717 #define TR_PRERESUME  (1<<10)
00718 #define TR_POSTRESUME (1<<11)
00719 #define TR_DEFERRED   (1<<12)
00720 
00721 /** 
00722 Equipment types */
00723 #define EQ_PERIODIC   (1<<0)   /**< Periodic Event */
00724 #define EQ_POLLED     (1<<1)   /**< Polling Event */
00725 #define EQ_INTERRUPT  (1<<2)   /**< Interrupt Event */
00726 #define EQ_SLOW       (1<<3)   /**< Slow Control Event */
00727 #define EQ_MANUAL_TRIG (1<<4)  /**< Manual triggered Event */
00728 #define EQ_FRAGMENTED (1<<5)   /**< Fragmented Event */
00729 
00730 /** 
00731 Read - On flags */
00732 #define RO_RUNNING    (1<<0)   /**< While running */
00733 #define RO_STOPPED    (1<<1)   /**< Before stopping the run */
00734 #define RO_PAUSED     (1<<2)   /**< ??? */
00735 #define RO_BOR        (1<<3)   /**< At the Begin of run */
00736 #define RO_EOR        (1<<4)   /**< At the End of run */
00737 #define RO_PAUSE      (1<<5)   /**< Before pausing the run */
00738 #define RO_RESUME     (1<<6)   /**< Before resuming the run */
00739 
00740 #define RO_TRANSITIONS (RO_BOR|RO_EOR|RO_PAUSE|RO_RESUME)      /**< At all transitions */
00741 #define RO_ALWAYS      (0xFF)      /**<  Always (independent of the run status) */
00742 
00743 #define RO_ODB        (1<<8)   /**< Submit data to ODB only */
00744 
00745 /**dox***************************************************************/
00746 /** @} */ /* end of mdefineh */
00747 
00748 /**
00749 special characters */
00750 #define CH_BS             8
00751 #define CH_TAB            9
00752 #define CH_CR            13
00753 
00754 #define CH_EXT 0x100
00755 
00756 #define CH_HOME   (CH_EXT+0)
00757 #define CH_INSERT (CH_EXT+1)
00758 #define CH_DELETE (CH_EXT+2)
00759 #define CH_END    (CH_EXT+3)
00760 #define CH_PUP    (CH_EXT+4)
00761 #define CH_PDOWN  (CH_EXT+5)
00762 #define CH_UP     (CH_EXT+6)
00763 #define CH_DOWN   (CH_EXT+7)
00764 #define CH_RIGHT  (CH_EXT+8)
00765 #define CH_LEFT   (CH_EXT+9)
00766 
00767 /* event sources in equipment */
00768 /**
00769 Code the LAM crate and LAM station into a bitwise register.
00770 @param c Crate number
00771 @param s Slot number
00772 */
00773 #define LAM_SOURCE(c, s)         (c<<24 | ((s) & 0xFFFFFF))
00774 
00775 /** 
00776 Code the Station number bitwise for the LAM source.
00777 @param s Slot number
00778 */
00779 #define LAM_STATION(s)           (1<<(s-1))
00780 
00781 /** 
00782 Convert the coded LAM crate to Crate number.
00783 @param c coded crate
00784 */
00785 #define LAM_SOURCE_CRATE(c)      (c>>24)
00786 
00787 /** 
00788 Convert the coded LAM station to Station number.
00789 @param s Slot number
00790 */
00791 #define LAM_SOURCE_STATION(s)    ((s) & 0xFFFFFF)
00792 
00793 /**
00794 CNAF commands */
00795 #define CNAF        0x1         /* normal read/write                */
00796 #define CNAF_nQ     0x2         /* Repeat read until noQ            */
00797 
00798 #define CNAF_INHIBIT_SET         0x100
00799 #define CNAF_INHIBIT_CLEAR       0x101
00800 #define CNAF_CRATE_CLEAR         0x102
00801 #define CNAF_CRATE_ZINIT         0x103
00802 #define CNAF_TEST                0x110
00803 
00804 /**dox***************************************************************/
00805 /** @addtogroup mmacroh
00806  *  
00807  *  @{
00808  */
00809 
00810 /**
00811 max */
00812 #ifndef max
00813 #define max(a,b)            (((a) > (b)) ? (a) : (b))
00814 #endif
00815 
00816 /**
00817 min */
00818 #ifndef min
00819 #define min(a,b)            (((a) < (b)) ? (a) : (b))
00820 #endif
00821 
00822 /*------------------------------------------------------------------*/
00823 
00824 /**
00825 Align macro for data alignment on 8-byte boundary */
00826 #define ALIGN8(x)  (((x)+7) & ~7)
00827 
00828 /**
00829 Align macro for variable data alignment */
00830 #define VALIGN(adr,align)  (((PTYPE) (adr)+align-1) & ~(align-1))
00831 
00832 /**dox***************************************************************/
00833 /** @} */ /* end of mmacroh */
00834  
00835 /**dox***************************************************************/
00836 /** @addtogroup mdefineh
00837  *  
00838  *  @{  */
00839 /*
00840 * Bit flags */
00841 #define EVENTID_ALL        -1   /* any event id                   */
00842 #define TRIGGER_ALL        -1   /* any type of trigger            */
00843 
00844 /**
00845 System message types */
00846 #define MT_ERROR           (1<<0)     /**< - */
00847 #define MT_INFO            (1<<1)     /**< - */
00848 #define MT_DEBUG           (1<<2)     /**< - */
00849 #define MT_USER            (1<<3)     /**< - */
00850 #define MT_LOG             (1<<4)     /**< - */
00851 #define MT_TALK            (1<<5)     /**< - */
00852 #define MT_CALL            (1<<6)     /**< - */
00853 #define MT_ALL              0xFF      /**< - */
00854 
00855 #define MERROR             MT_ERROR, __FILE__, __LINE__ /**< - */
00856 #define MINFO              MT_INFO,  __FILE__, __LINE__ /**< - */
00857 #define MDEBUG             MT_DEBUG, __FILE__, __LINE__ /**< - */
00858 #define MUSER              MT_USER,  __FILE__, __LINE__ /**< produced by interactive user */
00859 #define MLOG               MT_LOG,   __FILE__, __LINE__ /**< info message which is only logged */
00860 #define MTALK              MT_TALK,  __FILE__, __LINE__ /**< info message for speech system */
00861 #define MCALL              MT_CALL,  __FILE__, __LINE__ /**< info message for telephone call */
00862 
00863 /**dox***************************************************************/
00864 /** @} */ /* end of mdefineh */
00865 
00866 
00867 /**dox***************************************************************/
00868 /** @addtogroup mdeferrorh
00869  *  
00870  *  @{
00871  */
00872 
00873 /**dox***************************************************************/
00874 /**
00875  @defgroup err21 Status and error codes
00876  @{ */
00877 #define SUCCESS                       1 /**< Success */
00878 #define CM_SUCCESS                    1 /**< Same  */
00879 #define CM_SET_ERROR                102 /**< set  */
00880 #define CM_NO_CLIENT                103 /**< nobody */
00881 #define CM_DB_ERROR                 104 /**< db access error */
00882 #define CM_UNDEF_EXP                105 /**< - */
00883 #define CM_VERSION_MISMATCH         106 /**< - */
00884 #define CM_SHUTDOWN                 107 /**< - */
00885 #define CM_WRONG_PASSWORD           108 /**< - */
00886 #define CM_UNDEF_ENVIRON            109 /**< - */
00887 #define CM_DEFERRED_TRANSITION      110 /**< - */
00888 #define CM_TRANSITION_IN_PROGRESS   111 /**< - */
00889 /**dox***************************************************************/
00890 /** @} */ /* end of err21 */
00891 
00892 /**dox***************************************************************/
00893 /**
00894  @defgroup err22 Buffer Manager error codes
00895  @{ */
00896 #define BM_SUCCESS                    1   /**< - */
00897 #define BM_CREATED                  202   /**< - */
00898 #define BM_NO_MEMORY                203   /**< - */
00899 #define BM_INVALID_NAME             204   /**< - */
00900 #define BM_INVALID_HANDLE           205   /**< - */
00901 #define BM_NO_SLOT                  206   /**< - */
00902 #define BM_NO_MUTEX                 207   /**< - */
00903 #define BM_NOT_FOUND                208   /**< - */
00904 #define BM_ASYNC_RETURN             209   /**< - */
00905 #define BM_TRUNCATED                210   /**< - */
00906 #define BM_MULTIPLE_HOSTS           211   /**< - */
00907 #define BM_MEMSIZE_MISMATCH         212   /**< - */
00908 #define BM_CONFLICT                 213   /**< - */
00909 #define BM_EXIT                     214   /**< - */
00910 #define BM_INVALID_PARAM            215   /**< - */
00911 #define BM_MORE_EVENTS              216   /**< - */
00912 #define BM_INVALID_MIXING           217   /**< - */
00913 #define BM_NO_SHM                   218   /**< - */
00914 /**dox***************************************************************/
00915 /** @} */ /* end of group 22 */
00916 
00917 /**dox***************************************************************/
00918 /**  @defgroup err23 Online Database error codes 
00919 @{ */
00920 #define DB_SUCCESS                    1   /**< - */
00921 #define DB_CREATED                  302   /**< - */
00922 #define DB_NO_MEMORY                303   /**< - */
00923 #define DB_INVALID_NAME             304   /**< - */
00924 #define DB_INVALID_HANDLE           305   /**< - */
00925 #define DB_NO_SLOT                  306   /**< - */
00926 #define DB_NO_MUTEX                 307   /**< - */
00927 #define DB_MEMSIZE_MISMATCH         308   /**< - */
00928 #define DB_INVALID_PARAM            309   /**< - */
00929 #define DB_FULL                     310   /**< - */
00930 #define DB_KEY_EXIST                311   /**< - */
00931 #define DB_NO_KEY                   312   /**< - */
00932 #define DB_KEY_CREATED              313   /**< - */
00933 #define DB_TRUNCATED                314   /**< - */
00934 #define DB_TYPE_MISMATCH            315   /**< - */
00935 #define DB_NO_MORE_SUBKEYS          316   /**< - */
00936 #define DB_FILE_ERROR               317   /**< - */
00937 #define DB_NO_ACCESS                318   /**< - */
00938 #define DB_STRUCT_SIZE_MISMATCH     319   /**< - */
00939 #define DB_OPEN_RECORD              320   /**< - */
00940 #define DB_OUT_OF_RANGE             321   /**< - */
00941 #define DB_INVALID_LINK             322   /**< - */
00942 #define DB_CORRUPTED                323   /**< - */
00943 #define DB_STRUCT_MISMATCH          324   /**< - */
00944 /**dox***************************************************************/
00945 /** @} */ /* end of group 23 */
00946 
00947 /**dox***************************************************************/
00948 /**  @defgroup err24 System Services error code
00949 @{ */
00950 #define SS_SUCCESS                    1   /**< - */
00951 #define SS_CREATED                  402   /**< - */
00952 #define SS_NO_MEMORY                403   /**< - */
00953 #define SS_INVALID_NAME             404   /**< - */
00954 #define SS_INVALID_HANDLE           405   /**< - */
00955 #define SS_INVALID_ADDRESS          406   /**< - */
00956 #define SS_FILE_ERROR               407   /**< - */
00957 #define SS_NO_MUTEX                 408   /**< - */
00958 #define SS_NO_PROCESS               409   /**< - */
00959 #define SS_NO_THREAD                410   /**< - */
00960 #define SS_SOCKET_ERROR             411   /**< - */
00961 #define SS_TIMEOUT                  412   /**< - */
00962 #define SS_SERVER_RECV              413   /**< - */
00963 #define SS_CLIENT_RECV              414   /**< - */
00964 #define SS_ABORT                    415   /**< - */
00965 #define SS_EXIT                     416   /**< - */
00966 #define SS_NO_TAPE                  417   /**< - */
00967 #define SS_DEV_BUSY                 418   /**< - */
00968 #define SS_IO_ERROR                 419   /**< - */
00969 #define SS_TAPE_ERROR               420   /**< - */
00970 #define SS_NO_DRIVER                421   /**< - */
00971 #define SS_END_OF_TAPE              422   /**< - */
00972 #define SS_END_OF_FILE              423   /**< - */
00973 #define SS_FILE_EXISTS              424   /**< - */
00974 #define SS_NO_SPACE                 425   /**< - */
00975 #define SS_INVALID_FORMAT           426   /**< - */
00976 #define SS_NO_ROOT                  427   /**< - */
00977 /**dox***************************************************************/
00978 /** @} */ /* end of group 24 */
00979 
00980 /**dox***************************************************************/
00981 /**  @defgroup err25 Remote Procedure Calls error codes
00982 @{ */
00983 #define RPC_SUCCESS                   1   /**< - */
00984 #define RPC_ABORT              SS_ABORT   /**< - */
00985 #define RPC_NO_CONNECTION           502   /**< - */
00986 #define RPC_NET_ERROR               503   /**< - */
00987 #define RPC_TIMEOUT                 504   /**< - */
00988 #define RPC_EXCEED_BUFFER           505   /**< - */
00989 #define RPC_NOT_REGISTERED          506   /**< - */
00990 #define RPC_CONNCLOSED              507   /**< - */
00991 #define RPC_INVALID_ID              508   /**< - */
00992 #define RPC_SHUTDOWN                509   /**< - */
00993 #define RPC_NO_MEMORY               510   /**< - */
00994 #define RPC_DOUBLE_DEFINED          511   /**< - */
00995 /**dox***************************************************************/
00996 /** @} */ /* end of group 25 */
00997 
00998 /**dox***************************************************************/
00999 /**  @defgroup err26 Other errors
01000 @{ */
01001 #define FE_SUCCESS                    1   /**< - */
01002 #define FE_ERR_ODB                  602   /**< - */
01003 #define FE_ERR_HW                   603   /**< - */
01004 #define FE_ERR_DISABLED             604   /**< - */
01005 #define FE_ERR_DRIVER               605   /**< - */
01006 
01007 /** 
01008 History error code */
01009 #define HS_SUCCESS                    1   /**< - */
01010 #define HS_FILE_ERROR               702   /**< - */
01011 #define HS_NO_MEMORY                703   /**< - */
01012 #define HS_TRUNCATED                704   /**< - */
01013 #define HS_WRONG_INDEX              705   /**< - */
01014 #define HS_UNDEFINED_EVENT          706   /**< - */
01015 #define HS_UNDEFINED_VAR            707   /**< - */
01016 
01017 /** 
01018 FTP error code */
01019 #define FTP_SUCCESS                   1   /**< - */
01020 #define FTP_NET_ERROR               802   /**< - */
01021 #define FTP_FILE_ERROR              803   /**< - */
01022 #define FTP_RESPONSE_ERROR          804   /**< - */
01023 #define FTP_INVALID_ARG             805   /**< - */
01024 
01025 /** 
01026 ELog error code */
01027 #define EL_SUCCESS                    1   /**< - */
01028 #define EL_FILE_ERROR               902   /**< - */
01029 #define EL_NO_MESSAGE               903   /**< - */
01030 #define EL_TRUNCATED                904   /**< - */
01031 #define EL_FIRST_MSG                905   /**< - */
01032 #define EL_LAST_MSG                 906   /**< - */
01033 
01034 /** 
01035 Alarm error code */
01036 #define AL_SUCCESS                    1   /**< - */
01037 #define AL_INVALID_NAME            1002   /**< - */
01038 #define AL_ERROR_ODB               1003   /**< - */
01039 #define AL_RESET                   1004   /**< - */
01040 
01041 /** 
01042 Slow control commands error code */
01043 #define CMD_INIT                    (1<<0)
01044 #define CMD_EXIT                    (1<<1)
01045 #define CMD_IDLE                    (1<<2)
01046 #define CMD_SET                     (1<<3)
01047 #define CMD_SET_ALL                 (1<<4)
01048 #define CMD_GET                     (1<<5)
01049 #define CMD_GET_ALL                 (1<<6)
01050 #define CMD_GET_CURRENT             (1<<7)
01051 #define CMD_GET_CURRENT_ALL         (1<<8)
01052 #define CMD_SET_CURRENT_LIMIT       (1<<9)
01053 #define CMD_SET_CURRENT_LIMIT_ALL  (1<<10)
01054 #define CMD_GET_DEMAND             (1<<11)
01055 #define CMD_GET_DEFAULT_NAME       (1<<12)
01056 #define CMD_GET_DEFAULT_THRESHOLD  (1<<13)
01057 #define CMD_SET_LABEL              (1<<14)
01058 #define CMD_ENABLE_COMMAND         (1<<15)
01059 #define CMD_DISABLE_COMMAND        (1<<16)
01060 
01061 /** 
01062 Bus driver commands */
01063 #define CMD_WRITE                   100
01064 #define CMD_READ                    101
01065 #define CMD_PUTS                    102
01066 #define CMD_GETS                    103
01067 #define CMD_DEBUG                   104
01068 #define CMD_NAME                    105
01069 
01070 /** 
01071 Commands for interrupt events error code */
01072 #define CMD_INTERRUPT_ENABLE        100
01073 #define CMD_INTERRUPT_DISABLE       101
01074 #define CMD_INTERRUPT_ATTACH        102
01075 #define CMD_INTERRUPT_DETACH        103
01076 
01077 /**
01078 macros for bus driver access */
01079 #define BD_GETS(s,z,p,t)   info->bd(CMD_GETS, info->bd_info, s, z, p, t)
01080 #define BD_READS(s,z,p,t)  info->bd(CMD_READ, info->bd_info, s, z, p, t)
01081 #define BD_PUTS(s)         info->bd(CMD_PUTS, info->bd_info, s)
01082 #define BD_WRITES(s)       info->bd(CMD_WRITE, info->bd_info, s)
01083 
01084 /**dox***************************************************************/
01085 /** @} */ /* end of 26 */
01086 
01087 /**dox***************************************************************/
01088 /** @} */ /* end of mdeferrorh */
01089 
01090 
01091 #define ANA_CONTINUE                  1
01092 #define ANA_SKIP                      0
01093 
01094 
01095 /*---- Buffer manager structures -----------------------------------*/
01096 
01097 /**dox***************************************************************/
01098 /** @addtogroup msectionh
01099  *  
01100  *  @{  */
01101 
01102 /**dox***************************************************************/
01103 /** @defgroup mbufferh Buffer Section
01104  *  @{  */
01105 /**
01106 Event header */
01107 typedef struct {
01108    short int event_id;           /**< event ID starting from one      */
01109    short int trigger_mask;       /**< hardware trigger mask           */
01110    DWORD serial_number;          /**< serial number starting from one */
01111    DWORD time_stamp;             /**< time of production of event     */
01112    DWORD data_size;              /**< size of event in bytes w/o header */
01113 } EVENT_HEADER;
01114 
01115 /**
01116 TRIGGER_MASK
01117 Extract or set the trigger mask field pointed by the argument.
01118 @param e pointer to the midas event (pevent)
01119 */
01120 #define TRIGGER_MASK(e)    ((((EVENT_HEADER *) e)-1)->trigger_mask)
01121 
01122 /**
01123 EVENT_ID
01124 Extract or set the event ID field pointed by the argument..
01125 @param e pointer to the midas event (pevent)
01126 */
01127 #define EVENT_ID(e)        ((((EVENT_HEADER *) e)-1)->event_id)
01128 
01129 /**
01130 SERIAL_NUMBER
01131 Extract or set/reset the serial number field pointed by the argument.
01132 @param e pointer to the midas event (pevent)
01133 */
01134 #define SERIAL_NUMBER(e)   ((((EVENT_HEADER *) e)-1)->serial_number)
01135 
01136 /**
01137 TIME_STAMP
01138 Extract or set/reset the time stamp field pointed by the argument.
01139 @param e pointer to the midas event (pevent)
01140 */
01141 #define TIME_STAMP(e)      ((((EVENT_HEADER *) e)-1)->time_stamp)
01142 #define EVENT_SOURCE(e,o)  (* (INT*) (e+o))
01143 
01144 /**
01145 system event IDs */
01146 #define EVENTID_BOR      ((short int) 0x8000)  /**< Begin-of-run      */
01147 #define EVENTID_EOR      ((short int) 0x8001)  /**< End-of-run        */
01148 #define EVENTID_MESSAGE  ((short int) 0x8002)  /**< Message events    */
01149 
01150 /**
01151 fragmented events */
01152 #define EVENTID_FRAG1    ((unsigned short) 0xC000)      /* first fragment */
01153 #define EVENTID_FRAG     ((unsigned short) 0xD000)      /* added to real event-id */
01154 
01155 /**
01156 magic number used in trigger_mask for BOR event */
01157 #define MIDAS_MAGIC      0x494d            /**< 'MI' */
01158 
01159 
01160 /**
01161 Buffer structure */
01162 typedef struct {
01163    INT id;                       /**< request id                      */
01164    BOOL valid;                   /**< indicating a valid entry        */
01165    short int event_id;           /**< event ID                        */
01166    short int trigger_mask;       /**< trigger mask                    */
01167    INT sampling_type;            /**< GET_ALL, GET_SOME, GET_FARM     */
01168                                  /**< dispatch function */
01169    void (*dispatch) (HNDLE, HNDLE, EVENT_HEADER *, void *);
01170 } EVENT_REQUEST;
01171 
01172 typedef struct {
01173    char name[NAME_LENGTH];            /**< name of client             */
01174    INT pid;                           /**< process ID                 */
01175    INT tid;                           /**< thread ID                  */
01176    INT thandle;                       /**< thread handle              */
01177    INT port;                          /**< UDP port for wake up       */
01178    INT read_pointer;                  /**< read pointer to buffer     */
01179    INT max_request_index;             /**< index of last request      */
01180    INT num_received_events;           /**< no of received events      */
01181    INT num_sent_events;               /**< no of sent events          */
01182    INT num_waiting_events;            /**< no of waiting events       */
01183    float data_rate;                   /**< data rate in kB/sec        */
01184    BOOL read_wait;                    /**< wait for read - flag       */
01185    INT write_wait;                    /**< wait for write # bytes     */
01186    BOOL wake_up;                      /**< client got a wake-up msg   */
01187    BOOL all_flag;                     /**< at least one GET_ALL request */
01188    DWORD last_activity;               /**< time of last activity      */
01189    DWORD watchdog_timeout;            /**< timeout in ms              */
01190 
01191    EVENT_REQUEST event_request[MAX_EVENT_REQUESTS];
01192 
01193 } BUFFER_CLIENT;
01194 
01195 typedef struct {
01196    char name[NAME_LENGTH];            /**< name of buffer             */
01197    INT num_clients;                   /**< no of active clients       */
01198    INT max_client_index;              /**< index of last client       */
01199    INT size;                          /**< size of data area in bytes */
01200    INT read_pointer;                  /**< read pointer               */
01201    INT write_pointer;                 /**< read pointer               */
01202    INT num_in_events;                 /**< no of received events      */
01203    INT num_out_events;                /**< no of distributed events   */
01204 
01205    BUFFER_CLIENT client[MAX_CLIENTS]; /**< entries for clients        */
01206 
01207 } BUFFER_HEADER;
01208 
01209 /* Per-process buffer access structure (descriptor) */
01210 
01211 typedef struct {
01212    BOOL attached;                   /**< TRUE if buffer is attached   */
01213    INT client_index;                /**< index to CLIENT str. in buf. */
01214    BUFFER_HEADER *buffer_header;    /**< pointer to buffer header     */
01215    void *buffer_data;               /**< pointer to buffer data       */
01216    char *read_cache;                /**< cache for burst read         */
01217    INT read_cache_size;             /**< cache size in bytes          */
01218    INT read_cache_rp;               /**< cache read pointer           */
01219    INT read_cache_wp;               /**< cache write pointer          */
01220    char *write_cache;               /**< cache for burst read         */
01221    INT write_cache_size;            /**< cache size in bytes          */
01222    INT write_cache_rp;              /**< cache read pointer           */
01223    INT write_cache_wp;              /**< cache write pointer          */
01224    HNDLE mutex;                     /**< mutex/semaphore handle       */
01225    INT shm_handle;                  /**< handle to shared memory      */
01226    INT index;                       /**< connection index / tid       */
01227    BOOL callback;                   /**< callback defined for this buffer */
01228 
01229 } BUFFER;
01230 
01231 typedef struct {
01232    DWORD type;                        /**< TID_xxx type                      */
01233    INT num_values;                    /**< number of values                  */
01234    char name[NAME_LENGTH];            /**< name of variable                  */
01235    INT data;                          /**< Address of variable (offset)      */
01236    INT total_size;                    /**< Total size of data block          */
01237    INT item_size;                     /**< Size of single data item          */
01238    WORD access_mode;                  /**< Access mode                       */
01239    WORD notify_count;                 /**< Notify counter                    */
01240    INT next_key;                      /**< Address of next key               */
01241    INT parent_keylist;                /**< keylist to which this key belongs */
01242    INT last_written;                  /**< Time of last write action  */
01243 } KEY;
01244 
01245 typedef struct {
01246    INT parent;                        /**< Address of parent key      */
01247    INT num_keys;                      /**< number of keys             */
01248    INT first_key;                     /**< Address of first key       */
01249 } KEYLIST;
01250 
01251 /**dox***************************************************************/
01252 /** @} */ /* end of msectionh */
01253 
01254 /*---- Equipment ---------------------------------------------------*/
01255 
01256 /**dox***************************************************************/
01257 /** @defgroup mequipment Equipment related
01258  *  @{  */
01259 
01260 #define DF_INPUT       (1<<0)         /**< channel is input           */
01261 #define DF_OUTPUT      (1<<1)         /**< channel is output          */
01262 #define DF_PRIO_DEVICE (1<<2)         /**< get demand values from device instead of ODB */
01263 #define DF_READ_ONLY   (1<<3)         /**< never write demand values to device */
01264 
01265 typedef struct {
01266    char name[NAME_LENGTH];            /**< Driver name                       */
01267     INT(*bd) (INT cmd, ...);          /**< Device driver entry point         */
01268    void *bd_info;                     /**< Private info for bus driver       */
01269 } BUS_DRIVER;
01270 
01271 typedef struct {
01272    char name[NAME_LENGTH];            /**< Driver name                       */
01273     INT(*dd) (INT cmd, ...);          /**< Device driver entry point         */
01274    INT channels;                      /**< Number of channels                */
01275     INT(*bd) (INT cmd, ...);          /**< Bus driver entry point            */
01276    DWORD flags;                       /**< Combination of DF_xx              */
01277    void *dd_info;                     /**< Private info for device driver    */
01278 } DEVICE_DRIVER;
01279 
01280 typedef struct {
01281    WORD event_id;                     /**< Event ID associated with equipm.  */
01282    WORD trigger_mask;                 /**< Trigger mask                      */
01283    char buffer[NAME_LENGTH];          /**< Event buffer to send events into  */
01284    INT eq_type;                       /**< One of EQ_xxx                     */
01285    INT source;                        /**< Event source (LAM/IRQ)            */
01286    char format[8];                    /**< Data format to produce            */
01287    BOOL enabled;                      /**< Enable flag                       */
01288    INT read_on;                       /**< Combination of Read-On flags RO_xxx */
01289    INT period;                        /**< Readout interval/Polling time in ms */
01290    double event_limit;                /**< Stop run when limit is reached    */
01291    DWORD num_subevents;               /**< Number of events in super event */
01292    INT history;                       /**< Log history                       */
01293    char frontend_host[NAME_LENGTH];   /**< Host on which FE is running       */
01294    char frontend_name[NAME_LENGTH];   /**< Frontend name                     */
01295    char frontend_file_name[256];      /**< Source file used for user FE      */
01296 } EQUIPMENT_INFO;
01297 
01298 typedef struct {
01299    double events_sent;
01300    double events_per_sec;
01301    double kbytes_per_sec;
01302 } EQUIPMENT_STATS;
01303 
01304 typedef struct eqpmnt *PEQUIPMENT;
01305 
01306 typedef struct eqpmnt {
01307    char name[NAME_LENGTH];              /**< Equipment name                            */
01308    EQUIPMENT_INFO info;                 /**< From above                                */
01309     INT(*readout) (char *, INT);        /**< Pointer to user readout routine           */
01310     INT(*cd) (INT cmd, PEQUIPMENT);     /**< Class driver routine                      */
01311    DEVICE_DRIVER *driver;               /**< Device driver list                        */
01312    void *event_descrip;                 /**< Init string for fixed events or bank list */
01313    void *cd_info;                       /**< private data for class driver             */
01314    INT status;                          /**< One of FE_xxx                             */
01315    DWORD last_called;                   /**< Last time event was read                  */
01316    DWORD last_idle;                     /**< Last time idle func was called            */
01317    DWORD poll_count;                    /**< Needed to poll 'period'                   */
01318    INT format;                          /**< FORMAT_xxx                                */
01319    HNDLE buffer_handle;                 /**< MIDAS buffer handle                       */
01320    HNDLE hkey_variables;                /**< Key to variables subtree in ODB           */
01321    DWORD serial_number;                 /**< event serial number                       */
01322    DWORD subevent_number;               /**< subevent number                           */
01323    DWORD odb_out;                       /**< # updates FE -> ODB                       */
01324    DWORD odb_in;                        /**< # updated ODB -> FE                       */
01325    DWORD bytes_sent;                    /**< number of bytes sent                      */
01326    DWORD events_sent;                   /**< number of events sent                     */
01327    EQUIPMENT_STATS stats;
01328 } EQUIPMENT;
01329 /**dox***************************************************************/
01330 /** @} */ /* end of mequipmenth */
01331 
01332 /*---- Banks -------------------------------------------------------*/
01333 
01334 /**dox***************************************************************/
01335 /** @defgroup mbank Bank related
01336  *  @{  */
01337 
01338 #define BANK_FORMAT_VERSION     1      /**< - */
01339 #define BANK_FORMAT_32BIT   (1<<4)     /**< - */
01340 
01341 typedef struct {
01342    DWORD data_size;                    /**< Size in bytes */
01343    DWORD flags;                        /**< internal flag */
01344 } BANK_HEADER;
01345 
01346 typedef struct {
01347    char name[4];                       /**< - */
01348    WORD type;                          /**< - */
01349    WORD data_size;                     /**< - */
01350 } BANK;
01351 
01352 typedef struct {
01353    char name[4];                       /**< - */
01354    DWORD type;                         /**< - */
01355    DWORD data_size;                    /**< - */
01356 } BANK32;
01357 
01358 typedef struct {
01359    char name[NAME_LENGTH];             /**< - */
01360    DWORD type;                         /**< - */
01361    DWORD n_data;                       /**< - */
01362 } TAG;
01363 
01364 typedef struct {
01365    char name[9];                       /**< - */
01366    WORD type;                          /**< - */
01367    DWORD size;                         /**< - */
01368    char **init_str;                    /**< - */
01369    BOOL output_flag;                   /**< - */
01370    void *addr;                         /**< - */
01371    DWORD n_data;                       /**< - */
01372    HNDLE def_key;                      /**< - */
01373 } BANK_LIST;
01374 /**dox***************************************************************/
01375 /** @} */ /* end of mbank */
01376 
01377 /*---- Analyzer request --------------------------------------------*/
01378 /**dox***************************************************************/
01379 /** @defgroup manalyzer Analyzer related
01380  *  @{  */
01381 
01382 typedef struct {
01383    char name[NAME_LENGTH];            /**< Module name                       */
01384    char author[NAME_LENGTH];          /**< Author                            */
01385     INT(*analyzer) (EVENT_HEADER *, void *);
01386                                            /**< Pointer to user analyzer routine  */
01387     INT(*bor) (INT run_number);       /**< Pointer to begin-of-run routine   */
01388     INT(*eor) (INT run_number);       /**< Pointer to end-of-run routine     */
01389     INT(*init) ();                    /**< Pointer to init routine           */
01390     INT(*exit) ();                    /**< Pointer to exit routine           */
01391    void *parameters;                  /**< Pointer to parameter structure    */
01392    INT param_size;                    /**< Size of parameter structure       */
01393    char **init_str;                   /**< Parameter init string             */
01394    BOOL enabled;                      /**< Enabled flag                      */
01395 } ANA_MODULE;
01396 
01397 typedef struct {
01398    INT event_id;                      /**< Event ID associated with equipm.  */
01399    INT trigger_mask;                  /**< Trigger mask                      */
01400    INT sampling_type;                 /**< GET_ALL/GET_SOME                  */
01401    char buffer[NAME_LENGTH];          /**< Event buffer to send events into  */
01402    BOOL enabled;                      /**< Enable flag                       */
01403    char client_name[NAME_LENGTH];     /**< Analyzer name                     */
01404    char host[NAME_LENGTH];            /**< Host on which analyzer is running */
01405 } AR_INFO;
01406 
01407 typedef struct {
01408    double events_received;
01409    double events_per_sec;
01410    double events_written;
01411 } AR_STATS;
01412 
01413 typedef struct {
01414    char event_name[NAME_LENGTH];      /**< Event name                        */
01415    AR_INFO ar_info;                   /**< From above                        */
01416     INT(*analyzer) (EVENT_HEADER *, void *);
01417                                            /**< Pointer to user analyzer routine  */
01418    ANA_MODULE **ana_module;           /**< List of analyzer modules          */
01419    BANK_LIST *bank_list;              /**< List of banks for event           */
01420    INT rwnt_buffer_size;              /**< Size in events of RW N-tuple buf  */
01421    BOOL use_tests;                    /**< Use tests for this event          */
01422    char **init_string;
01423    INT status;                        /**< One of FE_xxx                     */
01424    HNDLE buffer_handle;               /**< MIDAS buffer handle               */
01425    HNDLE request_id;                  /**< Event request handle              */
01426    HNDLE hkey_variables;              /**< Key to variables subtree in ODB   */
01427    HNDLE hkey_common;                 /**< Key to common subtree             */
01428    void *addr;                        /**< Buffer for CWNT filling           */
01429    struct {                           /**< Buffer for event number for CWNT  */
01430       DWORD run;
01431       DWORD serial;
01432       DWORD time;
01433    } number;
01434    DWORD events_received;             /**< number of events sent             */
01435    DWORD events_written;              /**< number of events written          */
01436    AR_STATS ar_stats;
01437 
01438 } ANALYZE_REQUEST;
01439 
01440 /*---- Tests -------------------------------------------------------*/
01441 
01442 typedef struct {
01443    char name[80];
01444    BOOL registered;
01445    DWORD count;
01446    BOOL value;
01447 } ANA_TEST;
01448 
01449 #define SET_TEST(t, v) { if (!t.registered) test_register(&t); t.value = (v); }
01450 #define TEST(t) (t.value)
01451 
01452 #ifdef DEFINE_TESTS
01453 #define DEF_TEST(t) ANA_TEST t = { #t, 0, 0, FALSE };
01454 #else
01455 #define DEF_TEST(t) extern ANA_TEST t;
01456 #endif
01457 /**dox***************************************************************/
01458 /** @} */ /* end of mbank */
01459 
01460 /*---- History structures ------------------------------------------*/
01461 
01462 /**dox***************************************************************/
01463 /** @defgroup mhistoryh History related
01464  *  @{  */
01465 
01466 #define RT_DATA (*((DWORD *) "HSDA"))
01467 #define RT_DEF  (*((DWORD *) "HSDF"))
01468 
01469 typedef struct {
01470    DWORD record_type;           /* RT_DATA or RT_DEF */
01471    DWORD event_id;
01472    DWORD time;
01473    DWORD def_offset;            /* place of definition */
01474    DWORD data_size;             /* data following this header in bytes */
01475 } HIST_RECORD;
01476 
01477 typedef struct {
01478    DWORD event_id;
01479    char event_name[NAME_LENGTH];
01480    DWORD def_offset;
01481 } DEF_RECORD;
01482 
01483 typedef struct {
01484    DWORD event_id;
01485    DWORD time;
01486    DWORD offset;
01487 } INDEX_RECORD;
01488 
01489 typedef struct {
01490    DWORD event_id;
01491    char event_name[NAME_LENGTH];
01492    DWORD n_tag;
01493    TAG *tag;
01494    DWORD hist_fh;
01495    DWORD index_fh;
01496    DWORD def_fh;
01497    DWORD base_time;
01498    DWORD def_offset;
01499 } HISTORY;
01500 /**dox***************************************************************/
01501 /** @} */ /* end of mhistory */
01502 
01503 /*---- ODB runinfo -------------------------------------------------*/
01504 
01505 /**dox***************************************************************/
01506 /** @defgroup modbh ODB runinfo related
01507  *  @{  */
01508 /** Contains the main parameters regarding the run status.
01509     The containt reflects the current system ONLY if Midas clients
01510     are connected. Otherwise the status is erroneous.
01511 */
01512 typedef struct {
01513    INT state;                         /**< Current run condition  */
01514    INT online_mode;                   /**< Mode of operation online/offline */
01515    INT run_number;                    /**< Current processing run number      */
01516    INT transition_in_progress;        /**< Intermediate state during transition */
01517    INT requested_transition;          /**< Deferred transition request */
01518    char start_time[32];               /**< ASCII of the last start time */
01519    DWORD start_time_binary;           /**< Bin of the last start time */
01520    char stop_time[32];                /**< ASCII of the last stop time */
01521    DWORD stop_time_binary;            /**< ASCII of the last stop time */
01522 } RUNINFO;
01523 
01524 #define RUNINFO_STR(_name) char *_name[] = {\
01525 "[.]",\
01526 "State = INT : 1",\
01527 "Online Mode = INT : 1",\
01528 "Run number = INT : 0",\
01529 "Transition in progress = INT : 0",\
01530 "Requested transition = INT : 0",\
01531 "Start time = STRING : [32] Tue Sep 09 15:04:42 1997",\
01532 "Start time binary = DWORD : 0",\
01533 "Stop time = STRING : [32] Tue Sep 09 15:04:42 1997",\
01534 "Stop time binary = DWORD : 0",\
01535 "",\
01536 NULL }
01537 /**dox***************************************************************/
01538 /** @} */ /* end of mhistory */
01539 
01540 /*---- Alarm system ------------------------------------------------*/
01541 /**dox***************************************************************/
01542 /** @defgroup malarmh Alarm related
01543  * Alarm structre. 
01544  *  @{  */
01545 
01546 /********************************************************************/
01547 /**
01548 Program information structure */
01549 typedef struct {
01550    BOOL required;
01551    INT watchdog_timeout;
01552    DWORD check_interval;
01553    char start_command[256];
01554    BOOL auto_start;
01555    BOOL auto_stop;
01556    BOOL auto_restart;
01557    char alarm_class[32];
01558    DWORD first_failed;
01559 } PROGRAM_INFO;
01560 
01561 #define AT_INTERNAL   1 /**< - */
01562 #define AT_PROGRAM    2 /**< - */
01563 #define AT_EVALUATED  3 /**< - */
01564 #define AT_PERIODIC   4 /**< - */
01565 #define AT_LAST       4 /**< - */
01566 
01567 #define PROGRAM_INFO_STR(_name) char *_name[] = {\
01568 "[.]",\
01569 "Required = BOOL : n",\
01570 "Watchdog timeout = INT : 10000",\
01571 "Check interval = DWORD : 180000",\
01572 "Start command = STRING : [256] ",\
01573 "Auto start = BOOL : n",\
01574 "Auto stop = BOOL : n",\
01575 "Auto restart = BOOL : n",\
01576 "Alarm class = STRING : [32] ",\
01577 "First failed = DWORD : 0",\
01578 "",\
01579 NULL }
01580 
01581 /**
01582 Alarm class structure */
01583 typedef struct {
01584    BOOL write_system_message;
01585    BOOL write_elog_message;
01586    INT system_message_interval;
01587    DWORD system_message_last;
01588    char execute_command[256];
01589    INT execute_interval;
01590    DWORD execute_last;
01591    BOOL stop_run;
01592    char display_bgcolor[32];
01593    char display_fgcolor[32];
01594 } ALARM_CLASS;
01595 
01596 #define ALARM_CLASS_STR(_name) char *_name[] = {\
01597 "[.]",\
01598 "Write system message = BOOL : y",\
01599 "Write Elog message = BOOL : n",\
01600 "System message interval = INT : 60",\
01601 "System message last = DWORD : 0",\
01602 "Execute command = STRING : [256] ",\
01603 "Execute interval = INT : 0",\
01604 "Execute last = DWORD : 0",\
01605 "Stop run = BOOL : n",\
01606 "Display BGColor = STRING : [32] red",\
01607 "Display FGColor = STRING : [32] black",\
01608 "",\
01609 NULL }
01610 
01611 /**
01612 Alarm structure */
01613 typedef struct {
01614    BOOL active;
01615    INT triggered;
01616    INT type;
01617    INT check_interval;
01618    DWORD checked_last;
01619    char time_triggered_first[32];
01620    char time_triggered_last[32];
01621    char condition[256];
01622    char alarm_class[32];
01623    char alarm_message[80];
01624 } ALARM;
01625 
01626 #define ALARM_ODB_STR(_name) char *_name[] = {\
01627 "[.]",\
01628 "Active = BOOL : n",\
01629 "Triggered = INT : 0",\
01630 "Type = INT : 3",\
01631 "Check interval = INT : 60",\
01632 "Checked last = DWORD : 0",\
01633 "Time triggered first = STRING : [32] ",\
01634 "Time triggered last = STRING : [32] ",\
01635 "Condition = STRING : [256] /Runinfo/Run number > 100",\
01636 "Alarm Class = STRING : [32] Alarm",\
01637 "Alarm Message = STRING : [80] Run number became too large",\
01638 "",\
01639 NULL }
01640 
01641 #define ALARM_PERIODIC_STR(_name) char *_name[] = {\
01642 "[.]",\
01643 "Active = BOOL : n",\
01644 "Triggered = INT : 0",\
01645 "Type = INT : 4",\
01646 "Check interval = INT : 28800",\
01647 "Checked last = DWORD : 0",\
01648 "Time triggered first = STRING : [32] ",\
01649 "Time triggered last = STRING : [32] ",\
01650 "Condition = STRING : [256] ",\
01651 "Alarm Class = STRING : [32] Warning",\
01652 "Alarm Message = STRING : [80] Please do your shift checks",\
01653 "",\
01654 NULL }
01655 
01656 /**dox***************************************************************/
01657 /** @} */ /* end of malarmh */
01658 
01659 /**dox***************************************************************/
01660 #ifndef DOXYGEN_SHOULD_SKIP_THIS
01661 
01662 /*---- malloc/free routines for debugging --------------------------*/
01663 
01664 #ifdef _MEM_DBG
01665 #define M_MALLOC(x)   dbg_malloc((x), __FILE__, __LINE__)
01666 #define M_CALLOC(x,y) dbg_calloc((x), (y), __FILE__, __LINE__)
01667 #define M_FREE(x)     dbg_free  ((x), __FILE__, __LINE__)
01668 #else
01669 #define M_MALLOC(x) malloc(x)
01670 #define M_CALLOC(x,y) calloc(x,y)
01671 #define M_FREE(x) free(x)
01672 #endif
01673 
01674 void *dbg_malloc(unsigned int size, char *file, int line);
01675 void *dbg_calloc(unsigned int size, unsigned int count, char *file, int line);
01676 void dbg_free(void *adr, char *file, int line);
01677 
01678 /*---- CERN libray -------------------------------------------------*/
01679 
01680 #ifdef extname
01681 #define PAWC_NAME pawc_
01682 #else
01683 #define PAWC_NAME PAWC
01684 #endif
01685 
01686 #define PAWC_DEFINE(size) \
01687 INT PAWC_NAME[size/4];    \
01688 INT pawc_size = size
01689 
01690 /* bug in ROOT include files */
01691 #undef GetCurrentTime
01692 
01693 /*---- RPC ---------------------------------------------------------*/
01694 
01695 /**
01696 flags */
01697 #define RPC_IN       (1 << 0)
01698 #define RPC_OUT      (1 << 1)
01699 #define RPC_POINTER  (1 << 2)
01700 #define RPC_FIXARRAY (1 << 3)
01701 #define RPC_VARARRAY (1 << 4)
01702 #define RPC_OUTGOING (1 << 5)
01703 
01704 /**
01705 Server types */
01706 #define ST_NONE            0
01707 #define ST_SINGLE          1
01708 #define ST_MTHREAD         2
01709 #define ST_MPROCESS        3
01710 #define ST_SUBPROCESS      4
01711 #define ST_REMOTE          5
01712 
01713 /**
01714 function list */
01715 typedef struct {
01716    WORD tid;
01717    WORD flags;
01718    INT n;
01719 } RPC_PARAM;
01720 
01721 typedef struct {
01722    INT id;
01723    char *name;
01724    RPC_PARAM param[20];
01725     INT(*dispatch) (INT, void **);
01726 } RPC_LIST;
01727 
01728 /**
01729 IDs allow for users */
01730 #define RPC_MIN_ID    1
01731 #define RPC_MAX_ID 9999
01732 
01733 /**
01734 Data conversion flags */
01735 #define CF_ENDIAN          (1<<0)
01736 #define CF_IEEE2VAX        (1<<1)
01737 #define CF_VAX2IEEE        (1<<2)
01738 #define CF_ASCII           (1<<3)
01739 
01740 #define CBYTE(_i)        (* ((BYTE *)       prpc_param[_i]))
01741 #define CPBYTE(_i)       (  ((BYTE *)       prpc_param[_i]))
01742 
01743 #define CSHORT(_i)       (* ((short *)      prpc_param[_i]))
01744 #define CPSHORT(_i)      (  ((short *)      prpc_param[_i]))
01745 
01746 #define CINT(_i)         (* ((INT *)        prpc_param[_i]))
01747 #define CPINT(_i)        (  ((INT *)        prpc_param[_i]))
01748 
01749 #define CWORD(_i)        (* ((WORD *)       prpc_param[_i]))
01750 #define CPWORD(_i)       (  ((WORD *)       prpc_param[_i]))
01751 
01752 #define CLONG(_i)        (* ((long *)       prpc_param[_i]))
01753 #define CPLONG(_i)       (  ((long *)       prpc_param[_i]))
01754 
01755 #define CDWORD(_i)       (* ((DWORD *)      prpc_param[_i]))
01756 #define CPDWORD(_i)      (  ((DWORD *)      prpc_param[_i]))
01757 
01758 #define CHNDLE(_i)       (* ((HNDLE *)      prpc_param[_i]))
01759 #define CPHNDLE(_i)      (  ((HNDLE *)      prpc_param[_i]))
01760 
01761 #define CBOOL(_i)        (* ((BOOL *)       prpc_param[_i]))
01762 #define CPBOOL(_i)       (  ((BOOL *)       prpc_param[_i]))
01763 
01764 #define CFLOAT(_i)       (* ((float *)      prpc_param[_i]))
01765 #define CPFLOAT(_i)      (  ((float *)      prpc_param[_i]))
01766 
01767 #define CDOUBLE(_i)      (* ((double *)     prpc_param[_i]))
01768 #define CPDOUBLE(_i)     (  ((double *)     prpc_param[_i]))
01769 
01770 #define CSTRING(_i)      (  ((char *)       prpc_param[_i]))
01771 #define CARRAY(_i)       (  ((void *)       prpc_param[_i]))
01772 
01773 #define CBYTE(_i)        (* ((BYTE *)       prpc_param[_i]))
01774 #define CPBYTE(_i)       (  ((BYTE *)       prpc_param[_i]))
01775 
01776 #define CSHORT(_i)       (* ((short *)      prpc_param[_i]))
01777 #define CPSHORT(_i)      (  ((short *)      prpc_param[_i]))
01778 
01779 #define CINT(_i)         (* ((INT *)        prpc_param[_i]))
01780 #define CPINT(_i)        (  ((INT *)        prpc_param[_i]))
01781 
01782 #define CWORD(_i)        (* ((WORD *)       prpc_param[_i]))
01783 #define CPWORD(_i)       (  ((WORD *)       prpc_param[_i]))
01784 
01785 #define CLONG(_i)        (* ((long *)       prpc_param[_i]))
01786 #define CPLONG(_i)       (  ((long *)       prpc_param[_i]))
01787 
01788 #define CDWORD(_i)       (* ((DWORD *)      prpc_param[_i]))
01789 #define CPDWORD(_i)      (  ((DWORD *)      prpc_param[_i]))
01790 
01791 #define CHNDLE(_i)       (* ((HNDLE *)      prpc_param[_i]))
01792 #define CPHNDLE(_i)      (  ((HNDLE *)      prpc_param[_i]))
01793 
01794 #define CBOOL(_i)        (* ((BOOL *)       prpc_param[_i]))
01795 #define CPBOOL(_i)       (  ((BOOL *)       prpc_param[_i]))
01796 
01797 #define CFLOAT(_i)       (* ((float *)      prpc_param[_i]))
01798 #define CPFLOAT(_i)      (  ((float *)      prpc_param[_i]))
01799 
01800 #define CDOUBLE(_i)      (* ((double *)     prpc_param[_i]))
01801 #define CPDOUBLE(_i)     (  ((double *)     prpc_param[_i]))
01802 
01803 #define CSTRING(_i)      (  ((char *)       prpc_param[_i]))
01804 #define CARRAY(_i)       (  ((void *)       prpc_param[_i]))
01805 
01806 
01807 
01808 #define cBYTE            (* ((BYTE *)       prpc_param[--n_param]))
01809 #define cPBYTE           (  ((BYTE *)       prpc_param[--n_param]))
01810 
01811 #define cSHORT           (* ((short *)      prpc_param[--n_param]))
01812 #define cPSHORT          (  ((short *)      prpc_param[--n_param]))
01813 
01814 #define cINT             (* ((INT *)        prpc_param[--n_param]))
01815 #define cPINT            (  ((INT *)        prpc_param[--n_param]))
01816 
01817 #define cWORD            (* ((WORD *)       prpc_param[--n_param]))
01818 #define cPWORD           (  ((WORD *)       prpc_param[--n_param]))
01819 
01820 #define cLONG            (* ((long *)       prpc_param[--n_param]))
01821 #define cPLONG           (  ((long *)       prpc_param[--n_param]))
01822 
01823 #define cDWORD           (* ((DWORD *)      prpc_param[--n_param]))
01824 #define cPDWORD          (  ((DWORD *)      prpc_param[--n_param]))
01825 
01826 #define cHNDLE           (* ((HNDLE *)      prpc_param[--n_param]))
01827 #define cPHNDLE          (  ((HNDLE *)      prpc_param[--n_param]))
01828 
01829 #define cBOOL            (* ((BOOL *)       prpc_param[--n_param]))
01830 #define cPBOOL           (  ((BOOL *)       prpc_param[--n_param]))
01831 
01832 #define cFLOAT           (* ((float *)      prpc_param[--n_param]))
01833 #define cPFLOAT          (  ((float *)      prpc_param[--n_param]))
01834 
01835 #define cDOUBLE          (* ((double *)     prpc_param[--n_param]))
01836 #define cPDOUBLE         (  ((double *)     prpc_param[--n_param]))
01837 
01838 #define cSTRING          (  ((char *)       prpc_param[--n_param]))
01839 #define cARRAY           (  ((void *)       prpc_param[--n_param]))
01840 
01841 /*---- Function declarations ---------------------------------------*/
01842 
01843 /* make functions callable from a C++ program */
01844 #ifdef __cplusplus
01845 extern "C" {
01846 #endif
01847 
01848 /* make functions under WinNT dll exportable */
01849 #if defined(OS_WINNT) && defined(MIDAS_DLL)
01850 #define EXPRT __declspec(dllexport)
01851 #else
01852 #define EXPRT
01853 #endif
01854 
01855 /*---- common routines ----*/
01856    INT EXPRT cm_get_error(INT code, char *string);
01857    char EXPRT *cm_get_version(void);
01858    INT EXPRT cm_get_environment(char *host_name, int host_name_size,
01859                                 char *exp_name, int exp_name_size);
01860    INT EXPRT cm_list_experiments(char *host_name,
01861                                  char exp_name[MAX_EXPERIMENT][NAME_LENGTH]);
01862    INT EXPRT cm_select_experiment(char *host_name, char *exp_name);
01863    INT EXPRT cm_connect_experiment(char *host_name, char *exp_name,
01864                                    char *client_name, void (*func) (char *));
01865    INT EXPRT cm_connect_experiment1(char *host_name, char *exp_name,
01866                                     char *client_name,
01867                                     void (*func) (char *), INT odb_size,
01868                                     DWORD watchdog_timeout);
01869    INT EXPRT cm_disconnect_experiment(void);
01870    INT EXPRT cm_register_transition(INT transition, INT(*func) (INT, char *));
01871    INT EXPRT cm_register_deferred_transition(INT transition, BOOL(*func) (INT, BOOL));
01872    INT EXPRT cm_check_deferred_transition(void);
01873    INT EXPRT cm_transition(INT transition, INT run_number, char *error,
01874                            INT strsize, INT async_flag, INT debug_flag);
01875    INT EXPRT cm_register_server(void);
01876    INT EXPRT cm_register_function(INT id, INT(*func) (INT, void **));
01877    INT EXPRT cm_connect_client(char *client_name, HNDLE * hConn);
01878    INT EXPRT cm_disconnect_client(HNDLE hConn, BOOL bShutdown);
01879    INT EXPRT cm_set_experiment_database(HNDLE hDB, HNDLE hKeyClient);
01880    INT EXPRT cm_get_experiment_database(HNDLE * hDB, HNDLE * hKeyClient);
01881    INT EXPRT cm_set_experiment_mutex(INT mutex_alarm, INT mutex_elog);
01882    INT EXPRT cm_get_experiment_mutex(INT * mutex_alarm, INT * mutex_elog);
01883    INT EXPRT cm_set_client_info(HNDLE hDB, HNDLE * hKeyClient,
01884                                 char *host_name, char *client_name,
01885                                 INT computer_id, char *password, DWORD watchdog_timeout);
01886    INT EXPRT cm_get_client_info(char *client_name);
01887    INT EXPRT cm_set_watchdog_params(BOOL call_watchdog, DWORD timeout);
01888    INT EXPRT cm_get_watchdog_params(BOOL * call_watchdog, DWORD * timeout);
01889    INT EXPRT cm_get_watchdog_info(HNDLE hDB, char *client_name,
01890                                   DWORD * timeout, DWORD * last);
01891    INT EXPRT cm_enable_watchdog(BOOL flag);
01892    void EXPRT cm_watchdog(int);
01893    INT EXPRT cm_shutdown(char *name, BOOL bUnique);
01894    INT EXPRT cm_exist(char *name, BOOL bUnique);
01895    INT EXPRT cm_cleanup(char *client_name, BOOL ignore_timeout);
01896    INT EXPRT cm_yield(INT millisec);
01897    INT EXPRT cm_execute(char *command, char *result, INT buf_size);
01898    INT EXPRT cm_synchronize(DWORD * sec);
01899    INT EXPRT cm_asctime(char *str, INT buf_size);
01900    INT EXPRT cm_time(DWORD * time);
01901    BOOL EXPRT cm_is_ctrlc_pressed();
01902    void EXPRT cm_ack_ctrlc_pressed();
01903 
01904    INT EXPRT cm_set_msg_print(INT system_mask, INT user_mask, int (*func) (const char *));
01905    INT EXPRT cm_msg(INT message_type, char *filename, INT line,
01906                     const char *routine, const char *format, ...);
01907    INT EXPRT cm_msg1(INT message_type, char *filename, INT line,
01908                      const char *facility, const char *routine, const char *format, ...);
01909    INT EXPRT cm_msg_register(void (*func)
01910                               (HNDLE, HNDLE, EVENT_HEADER *, void *));
01911    INT EXPRT cm_msg_retrieve(INT n_message, char *message, INT * buf_size);
01912 
01913    BOOL EXPRT equal_ustring(char *str1, char *str2);
01914 #ifndef HAVE_STRLCPY
01915    INT EXPRT strlcpy(char *dst, const char *src, INT size);
01916    INT EXPRT strlcat(char *dst, const char *src, INT size);
01917 #endif
01918 
01919 /*---- buffer manager ----*/
01920    INT EXPRT bm_open_buffer(char *buffer_name, INT buffer_size, INT * buffer_handle);
01921    INT EXPRT bm_close_buffer(INT buffer_handle);
01922    INT EXPRT bm_close_all_buffers(void);
01923    INT EXPRT bm_init_buffer_counters(INT buffer_handle);
01924    INT EXPRT bm_get_buffer_info(INT buffer_handle, BUFFER_HEADER * buffer_header);
01925    INT EXPRT bm_get_buffer_level(INT buffer_handle, INT * n_bytes);
01926    INT EXPRT bm_set_cache_size(INT buffer_handle, INT read_size, INT write_size);
01927    INT EXPRT bm_compose_event(EVENT_HEADER * event_header,
01928                               short int event_id, short int trigger_mask,
01929                               DWORD size, DWORD serial);
01930    INT EXPRT bm_request_event(INT buffer_handle, short int event_id,
01931                               short int trigger_mask, INT sampling_type,
01932                               INT * request_id, void (*func) (HNDLE, HNDLE,
01933                                                               EVENT_HEADER *, void *));
01934    INT EXPRT bm_add_event_request(INT buffer_handle, short int event_id,
01935                                   short int trigger_mask,
01936                                   INT sampling_type, void (*func) (HNDLE,
01937                                                                    HNDLE,
01938                                                                    EVENT_HEADER
01939                                                                    *,
01940                                                                    void *),
01941                                   INT request_id);
01942    INT EXPRT bm_delete_request(INT request_id);
01943    INT EXPRT bm_send_event(INT buffer_handle, void *event, INT buf_size, INT async_flag);
01944    INT EXPRT bm_receive_event(INT buffer_handle, void *destination,
01945                               INT * buf_size, INT async_flag);
01946    INT EXPRT bm_skip_event(INT buffer_handle);
01947    INT EXPRT bm_flush_cache(INT buffer_handle, INT async_flag);
01948    INT EXPRT bm_poll_event(INT flag);
01949    INT EXPRT bm_empty_buffers(void);
01950 
01951 /*---- online database functions -----*/
01952    INT EXPRT db_open_database(char *database_name, INT database_size,
01953                               HNDLE * hdb, char *client_name);
01954    INT EXPRT db_close_database(HNDLE database_handle);
01955    INT EXPRT db_close_all_databases(void);
01956    INT EXPRT db_protect_database(HNDLE database_handle);
01957 
01958    INT EXPRT db_create_key(HNDLE hdb, HNDLE key_handle, char *key_name, DWORD type);
01959    INT EXPRT db_create_link(HNDLE hdb, HNDLE key_handle, char *link_name,
01960                             char *destination);
01961    INT EXPRT db_set_value(HNDLE hdb, HNDLE hKeyRoot, char *key_name,
01962                           void *data, INT size, INT num_values, DWORD type);
01963    INT EXPRT db_get_value(HNDLE hdb, HNDLE hKeyRoot, char *key_name,
01964                           void *data, INT * size, DWORD type, BOOL create);
01965    INT EXPRT db_find_key(HNDLE hdb, HNDLE hkey, char *name, HNDLE * hsubkey);
01966    INT EXPRT db_find_link(HNDLE hDB, HNDLE hKey, char *key_name, HNDLE * subhKey);
01967    INT EXPRT db_find_key1(HNDLE hdb, HNDLE hkey, char *name, HNDLE * hsubkey);
01968    INT EXPRT db_find_link1(HNDLE hDB, HNDLE hKey, char *key_name, HNDLE * subhKey);
01969    INT EXPRT db_scan_tree(HNDLE hDB, HNDLE hKey, int level,
01970                           INT(*callback) (HNDLE, HNDLE, KEY *, INT, void *), void *info);
01971    INT EXPRT db_scan_tree_link(HNDLE hDB, HNDLE hKey, int level,
01972                                void (*callback) (HNDLE, HNDLE, KEY *, INT,
01973                                                  void *), void *info);
01974    INT EXPRT db_get_path(HNDLE hDB, HNDLE hKey, char *path, INT buf_size);
01975    INT EXPRT db_delete_key(HNDLE database_handle, HNDLE key_handle, BOOL follow_links);
01976    INT EXPRT db_enum_key(HNDLE hdb, HNDLE key_handle, INT index, HNDLE * subkey_handle);
01977    INT EXPRT db_enum_link(HNDLE hdb, HNDLE key_handle, INT index, HNDLE * subkey_handle);
01978    INT EXPRT db_get_next_link(HNDLE hdb, HNDLE key_handle, HNDLE * subkey_handle);
01979    INT EXPRT db_get_key(HNDLE hdb, HNDLE key_handle, KEY * key);
01980    INT EXPRT db_get_key_info(HNDLE hDB, HNDLE hKey, char *name,
01981                              INT name_size, INT * type, INT * num_values,
01982                              INT * item_size);
01983    INT EXPRT db_get_key_time(HNDLE hdb, HNDLE key_handle, DWORD * delta);
01984    INT EXPRT db_rename_key(HNDLE hDB, HNDLE hKey, char *name);
01985    INT EXPRT db_reorder_key(HNDLE hDB, HNDLE hKey, INT index);
01986    INT EXPRT db_get_data(HNDLE hdb, HNDLE key_handle, void *data,
01987                          INT * buf_size, DWORD type);
01988    INT EXPRT db_get_data1(HNDLE hDB, HNDLE hKey, void *data,
01989                           INT * buf_size, DWORD type, INT * num_values);
01990    INT EXPRT db_get_data_index(HNDLE hDB, HNDLE hKey, void *data,
01991                                INT * buf_size, INT index, DWORD type);
01992    INT EXPRT db_set_data(HNDLE hdb, HNDLE hKey, void *data, INT buf_size,
01993                          INT num_values, DWORD type);
01994    INT EXPRT db_set_data_index(HNDLE hDB, HNDLE hKey, void *data, INT size,
01995                                INT index, DWORD type);
01996    INT EXPRT db_set_data_index2(HNDLE hDB, HNDLE hKey, void *data,
01997                                 INT size, INT index, DWORD type, BOOL bNotify);
01998    INT EXPRT db_set_num_values(HNDLE hDB, HNDLE hKey, INT num_values);
01999    INT EXPRT db_merge_data(HNDLE hDB, HNDLE hKeyRoot, char *name,
02000                            void *data, INT data_size, INT num_values, INT type);
02001    INT EXPRT db_set_mode(HNDLE hdb, HNDLE key_handle, WORD mode, BOOL recurse);
02002    INT EXPRT db_create_record(HNDLE hdb, HNDLE hkey, char *name, char *init_str);
02003    INT EXPRT db_check_record(HNDLE hDB, HNDLE hKey, char *key_name,
02004                              char *rec_str, BOOL correct);
02005    INT EXPRT db_open_record(HNDLE hdb, HNDLE hkey, void *ptr, INT rec_size,
02006                             WORD access, void (*dispatcher) (INT, INT,
02007                                                              void *), void *info);
02008    INT EXPRT db_close_record(HNDLE hdb, HNDLE hkey);
02009    INT EXPRT db_get_record(HNDLE hdb, HNDLE hKey, void *data, INT * buf_size, INT align);
02010    INT EXPRT db_get_record_size(HNDLE hdb, HNDLE hKey, INT align, INT * buf_size);
02011    INT EXPRT db_set_record(HNDLE hdb, HNDLE hKey, void *data, INT buf_size, INT align);
02012    INT EXPRT db_send_changed_records(void);
02013    INT EXPRT db_get_open_records(HNDLE hDB, HNDLE hKey, char *str,
02014                                  INT buf_size, BOOL fix);
02015 
02016    INT EXPRT db_add_open_record(HNDLE hDB, HNDLE hKey, WORD access_mode);
02017    INT EXPRT db_remove_open_record(HNDLE hDB, HNDLE hKey, BOOL lock);
02018 
02019    INT EXPRT db_load(HNDLE hdb, HNDLE key_handle, char *filename, BOOL bRemote);
02020    INT EXPRT db_save(HNDLE hdb, HNDLE key_handle, char *filename, BOOL bRemote);
02021    INT EXPRT db_copy(HNDLE hDB, HNDLE hKey, char *buffer, INT * buffer_size, char *path);
02022    INT EXPRT db_paste(HNDLE hDB, HNDLE hKeyRoot, char *buffer);
02023    INT EXPRT db_save_struct(HNDLE hDB, HNDLE hKey, char *file_name,
02024                             char *struct_name, BOOL append);
02025    INT EXPRT db_save_string(HNDLE hDB, HNDLE hKey, char *file_name,
02026                             char *string_name, BOOL append);
02027 
02028    INT EXPRT db_sprintf(char *string, void *data, INT data_size, INT index, DWORD type);
02029    INT EXPRT db_sprintfh(char *string, void *data, INT data_size, INT index, DWORD type);
02030    INT EXPRT db_sscanf(char *string, void *data, INT * data_size, INT index, DWORD type);
02031    char EXPRT *strcomb(char **list);
02032 
02033 /*---- Bank routines ----*/
02034    void EXPRT bk_init(void *pbh);
02035    void EXPRT bk_init32(void *event);
02036    BOOL EXPRT bk_is32(void *event);
02037    INT EXPRT bk_size(void *pbh);
02038    void EXPRT bk_create(void *pbh, const char *name, WORD type, void *pdata);
02039    INT EXPRT bk_delete(void *event, const char *name);
02040    INT EXPRT bk_close(void *pbh, void *pdata);
02041    INT EXPRT bk_list(void *pbh, char *bklist);
02042    INT EXPRT bk_locate(void *pbh, const char *name, void *pdata);
02043    INT EXPRT bk_iterate(void *pbh, BANK ** pbk, void *pdata);
02044    INT EXPRT bk_iterate32(void *pbh, BANK32 ** pbk, void *pdata);
02045    INT EXPRT bk_swap(void *event, BOOL force);
02046    INT EXPRT bk_find(BANK_HEADER * pbkh, const char *name, DWORD * bklen,
02047                      DWORD * bktype, void **pdata);
02048 
02049 /*---- RPC routines ----*/
02050    INT EXPRT rpc_register_functions(RPC_LIST * new_list, INT(*func) (INT, void **));
02051    INT EXPRT rpc_register_function(INT id, INT(*func) (INT, void **));
02052    INT EXPRT rpc_get_option(HNDLE hConn, INT item);
02053    INT EXPRT rpc_set_option(HNDLE hConn, INT item, INT value);
02054    INT EXPRT rpc_set_name(char *name);
02055    INT EXPRT rpc_get_name(char *name);
02056    INT EXPRT rpc_is_remote(void);
02057    INT EXPRT rpc_set_debug(void (*func) (char *), INT mode);
02058 
02059    INT EXPRT rpc_register_server(INT server_type, char *name, INT * port,
02060                                  INT(*func) (INT, void **));
02061    INT EXPRT rpc_register_client(char *name, RPC_LIST * list);
02062    INT EXPRT rpc_server_thread(void *pointer);
02063    INT EXPRT rpc_server_shutdown(void);
02064    INT EXPRT rpc_client_call(HNDLE hConn, const INT routine_id, ...);
02065    INT EXPRT rpc_call(const INT routine_id, ...);
02066    INT EXPRT rpc_tid_size(INT id);
02067    char EXPRT *rpc_tid_name(INT id);
02068    INT EXPRT rpc_server_connect(char *host_name, char *exp_name);
02069    INT EXPRT rpc_client_connect(char *host_name, INT midas_port,
02070                                 char *client_name, HNDLE * hConnection);
02071    INT EXPRT rpc_client_disconnect(HNDLE hConn, BOOL bShutdown);
02072 
02073    INT EXPRT rpc_send_event(INT buffer_handle, void *source, INT buf_size,
02074                             INT async_flag);
02075    INT EXPRT rpc_flush_event(void);
02076 
02077    void EXPRT rpc_get_convert_flags(INT * convert_flags);
02078    void EXPRT rpc_convert_single(void *data, INT tid, INT flags, INT convert_flags);
02079    void EXPRT rpc_convert_data(void *data, INT tid, INT flags, INT size,
02080                                INT convert_flags);
02081 
02082 /*---- system services ----*/
02083    DWORD EXPRT ss_millitime(void);
02084    DWORD EXPRT ss_time(void);
02085    DWORD EXPRT ss_settime(DWORD seconds);
02086    char EXPRT *ss_asctime(void);
02087    INT EXPRT ss_sleep(INT millisec);
02088    BOOL EXPRT ss_kbhit(void);
02089 
02090    void EXPRT ss_clear_screen(void);
02091    void EXPRT ss_printf(INT x, INT y, const char *format, ...);
02092    void ss_set_screen_size(int x, int y);
02093 
02094    char EXPRT *ss_getpass(char *prompt);
02095    INT EXPRT ss_getchar(BOOL reset);
02096    char EXPRT *ss_crypt(char *key, char *salt);
02097    char EXPRT *ss_gets(char *string, int size);
02098 
02099    void EXPRT *ss_ctrlc_handler(void (*func) (int));
02100 
02101 /*---- direct io routines ----*/
02102    INT EXPRT ss_directio_give_port(INT start, INT end);
02103    INT EXPRT ss_directio_lock_port(INT start, INT end);
02104 
02105 /*---- tape routines ----*/
02106    INT EXPRT ss_tape_open(char *path, INT oflag, INT * channel);
02107    INT EXPRT ss_tape_close(INT channel);
02108    INT EXPRT ss_tape_status(char *path);
02109    INT EXPRT ss_tape_read(INT channel, void *pdata, INT * count);
02110    INT EXPRT ss_tape_write(INT channel, void *pdata, INT count);
02111    INT EXPRT ss_tape_write_eof(INT channel);
02112    INT EXPRT ss_tape_fskip(INT channel, INT count);
02113    INT EXPRT ss_tape_rskip(INT channel, INT count);
02114    INT EXPRT ss_tape_rewind(INT channel);
02115    INT EXPRT ss_tape_spool(INT channel);
02116    INT EXPRT ss_tape_mount(INT channel);
02117    INT EXPRT ss_tape_unmount(INT channel);
02118    INT EXPRT ss_tape_get_blockn(INT channel);
02119 
02120 /*---- disk routines ----*/
02121    double EXPRT ss_disk_free(char *path);
02122 /*-PAA-*/
02123    double EXPRT ss_file_size(char *path);
02124    INT EXPRT ss_file_remove(char *path);
02125    INT EXPRT ss_file_find(char *path, char *pattern, char **plist);
02126    double EXPRT ss_disk_size(char *path);
02127 
02128 /*---- history routines ----*/
02129    INT EXPRT hs_set_path(char *path);
02130    INT EXPRT hs_define_event(DWORD event_id, char *name, TAG * tag, DWORD size);
02131    INT EXPRT hs_write_event(DWORD event_id, void *data, DWORD size);
02132    INT EXPRT hs_count_events(DWORD ltime, DWORD * count);
02133    INT EXPRT hs_enum_events(DWORD ltime, char *event_name,
02134                             DWORD * name_size, INT event_id[], DWORD * id_size);
02135    INT EXPRT hs_count_vars(DWORD ltime, DWORD event_id, DWORD * count);
02136    INT EXPRT hs_enum_vars(DWORD ltime, DWORD event_id, char *var_name,
02137                           DWORD * size, DWORD * var_n, DWORD * n_size);
02138    INT EXPRT hs_get_var(DWORD ltime, DWORD event_id, char *var_name,
02139                         DWORD * type, INT * n_data);
02140    INT EXPRT hs_get_event_id(DWORD ltime, char *name, DWORD * id);
02141    INT EXPRT hs_read(DWORD event_id, DWORD start_time, DWORD end_time,
02142                      DWORD interval, char *tag_name, DWORD var_index,
02143                      DWORD * time_buffer, DWORD * tbsize,
02144                      void *data_buffer, DWORD * dbsize, DWORD * type, DWORD * n);
02145    INT EXPRT hs_dump(DWORD event_id, DWORD start_time, DWORD end_time,
02146                      DWORD interval, BOOL binary_time);
02147    INT EXPRT hs_fdump(char *file_name, DWORD id, BOOL binary_time);
02148 
02149 /*---- ELog functions ----*/
02150    INT EXPRT el_retrieve(char *tag, char *date, int *run, char *author,
02151                          char *type, char *system, char *subject,
02152                          char *text, int *textsize, char *orig_tag,
02153                          char *reply_tag, char *attachment1,
02154                          char *attachment2, char *attachment3, char *encoding);
02155    INT EXPRT el_submit(int run, char *author, char *type, char *system,
02156                        char *subject, char *text, char *reply_to,
02157                        char *encoding, char *afilename1, char *buffer1,
02158                        INT buffer_size1, char *afilename2, char *buffer2,
02159                        INT buffer_size2, char *afilename3, char *buffer3,
02160                        INT buffer_size3, char *tag, INT tag_size);
02161    INT EXPRT el_search_message(char *tag, int *fh, BOOL walk);
02162    INT EXPRT el_search_run(int run, char *return_tag);
02163    INT EXPRT el_delete_message(char *tag);
02164 
02165 /*---- Alarm functions ----*/
02166    INT EXPRT al_check();
02167    INT EXPRT al_trigger_alarm(char *alarm_name, char *alarm_message,
02168                               char *default_class, char *cond_str, INT type);
02169    INT EXPRT al_trigger_class(char *alarm_class, char *alarm_message, BOOL first);
02170    INT EXPRT al_reset_alarm(char *alarm_name);
02171    BOOL EXPRT al_evaluate_condition(char *condition, char *value);
02172 
02173 /*---- analyzer functions ----*/
02174    void EXPRT test_register(ANA_TEST * t);
02175    void EXPRT add_data_dir(char *result, char *file);
02176    void EXPRT lock_histo(INT id);
02177 
02178 #ifdef __cplusplus
02179 }
02180 #endif
02181 #endif                          /* _MIDAS_H */
02182 /**dox***************************************************************/
02183 #endif                          /* DOXYGEN_SHOULD_SKIP_THIS */
02184 
02185 /**dox***************************************************************/
02186 /** @} */ /* end of midasincludecode */

Midas DOC Version 1.9.3 ---- PSI Stefan Ritt ----
Contributions: Pierre-Andre Amaudruz - Suzannah Daviel - Doxygen - Peter Green - Greg Hackman - Gertjan Hofman - Paul Knowles - Rudi Meier - Glenn Moloney - Dave Morris - Konstantin Olchanski - Renee Poutissou - Andreas Suter - Piotr Adam Zolnierczuk