• Created by Unknown User (chevtsov), last modified on Jun 16, 2011

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 96 Next »

  1. #Setup
    1. #Environment
    2. #Dependencies
    3. #Test inside Eclipse
  2. #Development
    1. #Overview
    2. #Launch Script
    3. #Classes and Functions
      1. #Message
      2. #Other
  3. #Release
    1. #Start/Stop
  4. #Troubleshoot

Setup

Environment

  • Effectively, you can only develop MPS History Server inside Eclipse on lcls-builder.
  • Check out the CVS module physics/mps/mpshist into your workspace
    • From now on, the root of project is referred to as $MPSHIST_ROOT

Dependencies

  • ezJCA (version R0-0-10)
  • javainterfaces (current version)
  • MPS Config
  • xal4lcls
    • ext.jar (current version)
    • xal.jar (current version)

Test inside Eclipse

  • Select $MPSGUI_ROOT/src/edu.stanford.slac.mpshist/MpsHistManager
  • Right-click => select Run As... => Java Application
  • If you run the app for the first time, it should fail
    • Go to Run in the Window menu
    • Select "Open Run Dialog..."
    • Select "MpsHistManager" in the window on the left
    • Select the "Arguments" tab
    • Enter the following arguments: 
      /usr/local/lcls/epics/iocTop/MachineProtection/mpsConfiguration/database/XYZ/mpsdb.sqlite3 password
      • XYZ - the current Config version (caget IOC:BSY0:MP01:DBVERS)
      • password - the current password (see also #Launch Script)
        in the "Program arguments" area.
    • Press "Run"
  • Stop the production server (see #Start / Stop)
  • Start MPS GUI
  • Run MpsHistManager
  • "Poke" MPS 
    caput POSI:EP02:400:MTLM_LGC_BYPV 1
    wait 10 seconds! 
    caput POSI:EP02:400:MTLM_LGC_BYPV 0
  • Check the HistoryViewer tab on the MPS GUI
  • Stop MpsHistManager
  • Important: start the production server (see #Start / Stop)

Development

Overview

Launch Script

  • mpshist under $MPSHIST_ROOT
  • Gets the current version of the Config DB
    • Assembles the path to it
  • Sets up the CLASSPATH
  • Runs MpsHistManager and tells the process to write all message into a log file

Classes and Functions

Message

edu.stanford.slac.mpshist.message.Message
  • Java representation of an MPS message
///****************************************************************************
// * Data Pointers
// ****************************************************************************/
///* Note: The history message header begins at the first byte of TCP Data
// */
// 
//#define HISTORY_MESSAGE_HEADER_SECTION_POINTER(_pointerToFullMessage)      ((epicsInt8  *)(_pointerToFullMessage)   + 0)
//#define HISTORY_MESSAGE_PROTOCOL_VERSION_POINTER(_pointerToHistoryHeader)  ((epicsUInt8 *)(_pointerToHistoryHeader) + 0)
//#define HISTORY_MESSAGE_TYPE_POINTER(_pointerToHistoryHeader)              ((epicsUInt8 *)(_pointerToHistoryHeader) + 1)
//#define HISTORY_MESSAGE_DATA_SECTION_POINTER(_pointerToHistoryHeader)      ((epicsInt8  *)(_pointerToHistoryHeader) + 2)
//
//#define HISTORY_MESSAGE_PROTOCOL_VERSION(_pointerToHistoryHeader)          (*HISTORY_MESSAGE_PROTOCOL_VERSION_POINTER(_pointerToHistoryHeader))
//#define HISTORY_MESSAGE_TYPE(_pointerToHistoryHeader)                      (*HISTORY_MESSAGE_TYPE_POINTER(_pointerToHistoryHeader))
//
///****************************************************************************
// * Super Message
// ****************************************************************************/
///* All history message struct data.
// */
//
//
//
//#define HISTORY_SUPER_MESSAGE_SIZE                                           (16 + MPSHistoryProtocolHeaderSize)
//
//#define HISTORY_SUPER_TIMESTAMP_SECPASTEPOCH_POINTER(_pointerToHistoryData)  ((epicsUInt32 *)((_pointerToHistoryData) +  0))
//#define HISTORY_SUPER_TIMESTAMP_NSEC_PULSEID_POINTER(_pointerToHistoryData)  ((epicsUInt32 *)((_pointerToHistoryData) +  4))
//#define HISTORY_SUPER_TIMESLOT_POINTER(_pointerToHistoryData)                ((epicsUInt8  *)((_pointerToHistoryData) +  8))
//#define HISTORY_SUPER_TYPE_POINTER(_pointerToHistoryData)                    ((epicsUInt8  *)((_pointerToHistoryData) +  9))
//#define HISTORY_SUPER_ID_POINTER(_pointerToHistoryData)                      ((epicsUInt32 *)((_pointerToHistoryData) + 10))
//#define HISTORY_SUPER_OLD_VALUE_POINTER(_pointerToHistoryData)               ((epicsUInt32 *)((_pointerToHistoryData) + 14))
//#define HISTORY_SUPER_NEW_VALUE_POINTER(_pointerToHistoryData)               ((epicsUInt32 *)((_pointerToHistoryData) + 18))
//
//#define HISTORY_SUPER_TIMESTAMP_SECPASTEPOCH(_pointerToHistoryData)          (*HISTORY_SUPER_TIMESTAMP_SECPASTEPOCH_POINTER(_pointerToHistoryData))
//#define HISTORY_SUPER_TIMESTAMP_NSEC_PULSEID(_pointerToHistoryData)          (*HISTORY_SUPER_TIMESTAMP_NSEC_PULSEID_POINTER(_pointerToHistoryData))
//#define HISTORY_SUPER_TIMESLOT(_pointerToHistoryData)                        (*HISTORY_SUPER_TIMESLOT_POINTER(_pointerToHistoryData))
//#define HISTORY_SUPER_TYPE(_pointerToHistoryData)                            (*HISTORY_SUPER_TYPE_POINTER(_pointerToHistoryData))
//#define HISTORY_SUPER_ID(_pointerToHistoryData)                              (*HISTORY_SUPER_ID_POINTER(_pointerToHistoryData))
//#define HISTORY_SUPER_OLD_VALUE(_pointerToHistoryData)                       (*HISTORY_SUPER_OLD_VALUE_POINTER(_pointerToHistoryData))
//#define HISTORY_SUPER_NEW_VALUE(_pointerToHistoryData)                       (*HISTORY_SUPER_NEW_VALUE_POINTER(_pointerToHistoryData))
  • There are various message types that we display in human readable form
    • Beam destination: Beam destination changed from PREVIOUS DESTINATION_NAME to CURRENT DESTINATION_NAME
    • Beam rate: Beam rate rate after DEVICE_NAME changed from PREVIOUS RATE_NAME to CURRENT RATE_NAME
    • Fault: DEVICE_NAME FAULT_NAME changed from PREV_STATE to CURR_STATE
    • Bypass time: DEVICE_NAME FAULT_NAME is bypassed for BYPASS_TIME_IN_SECONDS sec OR DEVICE_NAME FAULT_NAME bypass had cleared
    • Bypass value: DEVICE_NAME FAULT_NAME changed from PREV_VALUE to CURR_VALUE
edu.stanford.slac.mpshist.message.MessageRepository
  • A singleton that caches MPS messages before they are exported to Oracle

Other

edu.stanford.slac.mpshist.MessageCounter
  • A thread-safe way to count messages, both received and exported, and periodically put the numbers into cmlog
  • Primarily used for debugging
edu.stanford.slac.mpshist.MessageExporter
  • An instance of Runnable that periodically saves messages to the Oracle DB
edu.stanford.slac.mpshist.MessageServer
  • An instance of Runnable that caches messages from MPS in memory
  • Tries to create a ServerSocket bound to a port specified as an argument to the constructor
edu.stanford.slac.mpshist.MpsHistManager
edu.stanford.slac.mpshist.MpsHistProperties
  • Contains (almost) all parameters and settings for the module
    • Including the address of the MPS IOC that sends messages 
      public static final InetSocketAddress SOCKET_ADDRESS = new InetSocketAddress("ioc-bsy0-mp01.slac.stanford.edu", 30000);
edu.stanford.slac.mpshist.ServerNotifier
  • A runnable that periodically notifies MPS about a running server
    • Sends out Datagram packets

Release

  • Add a note in $MPSHIST_ROOT/RELEASE_NOTES
    • Increment the tag version accordingly
  • Commit to CVS
  • Tag with mpshist-R#-#-#
  • Check out the tagged version into production 
    cd $PHYSICS_TOP/release
cvs co -r mpshist-R#-#-# -d mpshist-R#-#-# physics/mps/mpshist
  • Select File => New Java project => Create project from existing source
  • Select $PHYSICS_TOP/release/mpshist-R#-#-#
  • Name the project mpshist-R#-#-#
  • Press "Finish"
  • Right-click on the new project mpshist-R#-#-# => Export...
  • Select Java => JAR file
  • Check mpshist-R#-#-# in "Resources to export"
  • Check "Export generated class files and resources"
  • As the export destination, type (and/or select) 
    $PHYSICS_TOP/release/mpshist-R#-#-#/jar/mpshist.jar
  • Press "Finish"
  • Move the symbolic link 
    cd $PHYSICS_TOP/
rm -rf mpshist; ln -s release/mpshist-R#-#-# mpshist

Start / Stop

  • Only one MPS History Server is active at any time
  • To start a new server, you must login as laci on lcls-daemon2 
    /etc/rc3.d/S99st.mpshist start
  • To stop a production server, type 
    /etc/rc3.d/S99st.mpshist stop

#Programmer's Guide
#User's Guide
#References

Programmer's Guide

MPS Config

Oracle

JDBC Url
jdbc:oracle:thin:MPS_HISTORY/%s@slac-oracle02.slac.stanford.edu:1521:SLACDEV
jdbc:oracle:thin:MPS_HISTORY/%s@slac-oracle04.slac.stanford.edu:1521:MCCQA

where %s = the current password.

Schema

Procedures
BEGIN MPS_HISTORY.MPS_HISTORY_PKG.DML_%s1 (%s2); END;

where
%s1 = table name
%s2 = CSVs in the same order as in the #Schema (top-to-bottom = left-to-right); ignore the ID column; replace the FKs with enums from the referenced table.

Message Types
//#define HISTORY_SUPER_TIMESTAMP_SECPASTEPOCH(_pointerToHistoryData)          
//#define HISTORY_SUPER_TIMESTAMP_NSEC_PULSEID(_pointerToHistoryData)          
//#define HISTORY_SUPER_TIMESLOT(_pointerToHistoryData)                        
//#define HISTORY_SUPER_TYPE(_pointerToHistoryData)                            
//#define HISTORY_SUPER_ID(_pointerToHistoryData)                              
//#define HISTORY_SUPER_OLD_VALUE(_pointerToHistoryData)                       
//#define HISTORY_SUPER_NEW_VALUE(_pointerToHistoryData)

Troubleshoot

  • The clearest sign of problems is an empty table in the HistoryViewer tab on the MPS GUI
  • Every few months, there seem to be weird socket exceptions that don't halt the server (to be investigated)

Log files

  • Check /u1/lcls/tools/mpsHistoryServer/mpshist.log

Cmlog

  • To check for cmlog messages, specify "MPS History" as facility.

Is the server running?

  • To test whether the Server is running, go as laci to lcls-daemon2 
    ps -ef | grep mpshist
  • Also, check nohup.out in laci's home directory

Is the server working?

  • To test whether the server is working, use POSI:EP02:400:MTLM_LGC_BYPV, e.g. 
    caput POSI:EP02:400:MTLM_LGC_BYPV 1
    wait 10 seconds! 
    caput POSI:EP02:400:MTLM_LGC_BYPV 0
    Verify that there is a message in the MPS GUI (not in cmlog).

Reboot

References

http://java.sun.com/docs/books/tutorial/networking/ (esp. sockets and datagrams)
http://darksleep.com/player/JavaAndUnsignedTypes.html (java types from/to bytes)
MPS Fault Logging Statistic Reports

  • No labels