#include <shmimMonitor.hpp>

Collaboration diagram for MagAOX::app::dev::shmimMonitor< derivedT, specificT >:

Public Member Functions
void	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system. More...

void	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results More...

int	appStartup ()
	Startup function. More...

int	appLogic ()
	Checks the shmimMonitor thread. More...

int	appShutdown ()
	Shuts down the shmimMonitor thread. More...

Protected Attributes
bool	m_getExistingFirst {false}
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore. More...

int	m_semaphoreNumber {5}
	The image structure semaphore index. More...

uint32_t	m_width {0}
	The width of the images in the stream. More...

uint32_t	m_height {0}
	The height of the images in the stream. More...

uint32_t	m_depth {0}
	The depth of the circular buffer in the stream. More...

uint8_t	m_dataType {0}
	The ImageStreamIO type code. More...

size_t	m_typeSize {0}
	The size of the type, in bytes. Result of sizeof. More...

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer. More...

ino_t	m_inode {0}
	The inode of the image stream file. More...

Configurable Parameters
std::string	m_shmimName {""}
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default. More...

int	m_smThreadPrio {2}
	Priority of the shmimMonitor thread, should normally be > 00. More...

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default). More...

Private Member Functions
derivedT &	derived ()

SIGSEGV & SIGBUS signal handling
These signals occur as a result of a ImageStreamIO source server resetting (e.g. changing frame sizes). When they occur a restart of the shmim monitor thread main loops is triggered.
bool	m_restart {false}
	Flag indicating tha the shared memory should be reinitialized. More...

static shmimMonitor *	m_selfMonitor = nullptr
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler. More...

int	setSigSegvHandler ()
	Sets the handler for SIGSEGV and SIGBUS. More...

void	handlerSigSegv (int signum, siginfo_t siginf, void ucont)
	Handles SIGSEGV and SIGBUS. Sets m_restart to true. More...

static void	_handlerSigSegv (int signum, siginfo_t siginf, void ucont)
	The handler called when SIGSEGV or SIGBUS is received, which will be due to ImageStreamIO server resets. Just a wrapper for handlerSigSegv. More...

shmimmonitor Thread
This thread actually monitors the shared memory buffer
bool	m_smThreadInit {true}
	Synchronizer for thread startup, to allow priority setting to finish. More...

pid_t	m_smThreadID {0}
	The s.m. thread PID. More...

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details. More...

std::thread	m_smThread
	A separate thread for the actual monitoring. More...

void	smThreadExec ()
	Execute the monitoring thread. More...

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec. More...

INDI
pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name. More...

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size. More...

int	updateINDI ()
	Update the INDI properties for this device controller. More...

Detailed Description

template<class derivedT, class specificT = shmimT>
class MagAOX::app::dev::shmimMonitor< derivedT, specificT >

MagAO-X generic shared memory monitor

The derived class derivedT must expose the following interface

//The allocate function is called after connecting to the shared memory buffer
//It should check that the buffer has the expected size, and perform any internal allocations
//to prepare for processing.
int derivedT::allocate( const specificT & ///< [in] tag to differentiate shmimMonitor parents.  Normally this is dev::shmimT for a single parent. 
                      );
 
int derivedT::processImage( void * curr_src,   ///< [in] pointer to the start of the current frame 
                            const specificT &  ///< [in] tag to differentiate shmimMonitor parents.  Normally this is dev::shmimT for a single parent.
                          )

Each of the above functions should return 0 on success, and -1 on an error.

This class should be declared a friend in the derived class, like so:

friend class dev::shmimMonitor<derivedT, specificT>;

Calls to this class's setupConfig, loadConfig, appStartup, appLogic and appShutdown functions must be placed in the derived class's functions of the same name.

The template specifier specificT allows inheritance of multiple shmimMonitor classes. This type must have at least the static member function:

static std::string indiPrefix()

which returns the string to prefix to INDI properties. The default shmimT uses "sm".

Todo:: move requirement for sigsegv handling to derived class – it should set m_restart on all shmimMonitors it inherited.

Definition at line 78 of file shmimMonitor.hpp.

Member Function Documentation

◆ _handlerSigSegv()

template<class derivedT , class specificT >

void MagAOX::app::dev::shmimMonitor< derivedT, specificT >::_handlerSigSegv	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

staticprotected

The handler called when SIGSEGV or SIGBUS is received, which will be due to ImageStreamIO server resets. Just a wrapper for handlerSigSegv.

Definition at line 431 of file shmimMonitor.hpp.

◆ appLogic()

template<class derivedT , class specificT >

int MagAOX::app::dev::shmimMonitor< derivedT, specificT >::appLogic

Checks the shmimMonitor thread.

This should be called in derivedT::appLogic as

shmimMonitor<derivedT, specificT>::appLogic();

MagAOX::app::dev::shmimMonitor::appLogic

int appLogic()

Checks the shmimMonitor thread.

Definition: shmimMonitor.hpp:360

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

Definition at line 360 of file shmimMonitor.hpp.

◆ appShutdown()

template<class derivedT , class specificT >

int MagAOX::app::dev::shmimMonitor< derivedT, specificT >::appShutdown

Shuts down the shmimMonitor thread.

This should be called in derivedT::appShutdown as

shmimMonitor<derivedT, specificT>::appShutdown();

MagAOX::app::dev::shmimMonitor::appShutdown

int appShutdown()

Shuts down the shmimMonitor thread.

Definition: shmimMonitor.hpp:375

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

Definition at line 375 of file shmimMonitor.hpp.

◆ appStartup()

template<class derivedT , class specificT >

int MagAOX::app::dev::shmimMonitor< derivedT, specificT >::appStartup

Startup function.

Starts the shmimMonitor thread This should be called in derivedT::appStartup as

shmimMonitor<derivedT, specificT>::appStartup();

MagAOX::app::dev::shmimMonitor::appStartup

int appStartup()

Startup function.

Definition: shmimMonitor.hpp:283

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

Definition at line 283 of file shmimMonitor.hpp.

◆ derived()

template<class derivedT , class specificT = shmimT>

derivedT& MagAOX::app::dev::shmimMonitor< derivedT, specificT >::derived ( )

inlineprivate

Definition at line 246 of file shmimMonitor.hpp.

◆ handlerSigSegv()

template<class derivedT , class specificT >

void MagAOX::app::dev::shmimMonitor< derivedT, specificT >::handlerSigSegv	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

protected

Handles SIGSEGV and SIGBUS. Sets m_restart to true.

Definition at line 440 of file shmimMonitor.hpp.

◆ loadConfig()

template<class derivedT , class specificT >

void MagAOX::app::dev::shmimMonitor< derivedT, specificT >::loadConfig ( mx::app::appConfigurator & config )

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

MagAOX::app::dev::shmimMonitor::loadConfig

void loadConfig(mx::app::appConfigurator &config)

load the configuration system results

Definition: shmimMonitor.hpp:274

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 274 of file shmimMonitor.hpp.

◆ setSigSegvHandler()

template<class derivedT , class specificT >

int MagAOX::app::dev::shmimMonitor< derivedT, specificT >::setSigSegvHandler

protected

Sets the handler for SIGSEGV and SIGBUS.

These are caused by ImageStreamIO server resets.

Definition at line 393 of file shmimMonitor.hpp.

◆ setupConfig()

template<class derivedT , class specificT >

void MagAOX::app::dev::shmimMonitor< derivedT, specificT >::setupConfig ( mx::app::appConfigurator & config )

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

MagAOX::app::dev::shmimMonitor::setupConfig

void setupConfig(mx::app::appConfigurator &config)

Setup the configuration system.

Definition: shmimMonitor.hpp:258

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 258 of file shmimMonitor.hpp.

◆ smThreadExec()

template<class derivedT , class specificT >

void MagAOX::app::dev::shmimMonitor< derivedT, specificT >::smThreadExec

protected

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 462 of file shmimMonitor.hpp.

Referenced by MagAOX::app::dev::shmimMonitor< derivedT, specificT >::smThreadStart().

◆ smThreadStart()

template<class derivedT , class specificT >

void MagAOX::app::dev::shmimMonitor< derivedT, specificT >::smThreadStart ( shmimMonitor< derivedT, specificT > * s )

staticprotected

Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec.

Parameters

[in] s a pointer to a shmimMonitor instance (normally this)

Definition at line 455 of file shmimMonitor.hpp.

◆ updateINDI()

template<class derivedT , class specificT >

int MagAOX::app::dev::shmimMonitor< derivedT, specificT >::updateINDI

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 769 of file shmimMonitor.hpp.

Member Data Documentation

◆ m_dataType

template<class derivedT , class specificT = shmimT>

uint8_t MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_dataType {0}

protected

The ImageStreamIO type code.

Definition at line 101 of file shmimMonitor.hpp.

◆ m_depth

template<class derivedT , class specificT = shmimT>

uint32_t MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_depth {0}

protected

The depth of the circular buffer in the stream.

Definition at line 99 of file shmimMonitor.hpp.

◆ m_getExistingFirst

template<class derivedT , class specificT = shmimT>

bool MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_getExistingFirst {false}

protected

If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

Definition at line 93 of file shmimMonitor.hpp.

◆ m_height

template<class derivedT , class specificT = shmimT>

uint32_t MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_height {0}

protected

The height of the images in the stream.

Definition at line 98 of file shmimMonitor.hpp.

◆ m_imageStream

template<class derivedT , class specificT = shmimT>

IMAGE MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_imageStream

protected

The ImageStreamIO shared memory buffer.

Definition at line 104 of file shmimMonitor.hpp.

◆ m_indiP_frameSize

template<class derivedT , class specificT = shmimT>

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_indiP_frameSize

protected

Property used to report the current frame size.

Definition at line 230 of file shmimMonitor.hpp.

◆ m_indiP_shmimName

template<class derivedT , class specificT = shmimT>

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_indiP_shmimName

protected

Property used to report the shmim buffer name.

Definition at line 228 of file shmimMonitor.hpp.

◆ m_inode

template<class derivedT , class specificT = shmimT>

ino_t MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_inode {0}

protected

The inode of the image stream file.

Definition at line 106 of file shmimMonitor.hpp.

◆ m_restart

template<class derivedT , class specificT = shmimT>

bool MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_restart {false}

protected

Flag indicating tha the shared memory should be reinitialized.

Definition at line 175 of file shmimMonitor.hpp.

◆ m_selfMonitor

template<class derivedT , class specificT >

shmimMonitor< derivedT, specificT > * MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_selfMonitor = nullptr

staticprotected

Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

Definition at line 177 of file shmimMonitor.hpp.

◆ m_semaphoreNumber

template<class derivedT , class specificT = shmimT>

int MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_semaphoreNumber {5}

protected

The image structure semaphore index.

Definition at line 95 of file shmimMonitor.hpp.

◆ m_shmimName

template<class derivedT , class specificT = shmimT>

std::string MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_shmimName {""}

protected

The name of the shared memory image, is used in /tmp/<shmimName>.im.shm. Derived classes should set a default.

Definition at line 85 of file shmimMonitor.hpp.

◆ m_smCpuset

template<class derivedT , class specificT = shmimT>

std::string MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_smCpuset

protected

The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

Definition at line 89 of file shmimMonitor.hpp.

◆ m_smThread

template<class derivedT , class specificT = shmimT>

std::thread MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_smThread

protected

A separate thread for the actual monitoring.

Definition at line 208 of file shmimMonitor.hpp.

◆ m_smThreadID

template<class derivedT , class specificT = shmimT>

pid_t MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_smThreadID {0}

protected

The s.m. thread PID.

Definition at line 204 of file shmimMonitor.hpp.

◆ m_smThreadInit

template<class derivedT , class specificT = shmimT>

bool MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_smThreadInit {true}

protected

Synchronizer for thread startup, to allow priority setting to finish.

Definition at line 202 of file shmimMonitor.hpp.

◆ m_smThreadPrio

template<class derivedT , class specificT = shmimT>

int MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_smThreadPrio {2}

protected

Priority of the shmimMonitor thread, should normally be > 00.

Definition at line 87 of file shmimMonitor.hpp.

◆ m_smThreadProp

template<class derivedT , class specificT = shmimT>

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_smThreadProp

protected

The property to hold the s.m. thread details.

Definition at line 206 of file shmimMonitor.hpp.

◆ m_typeSize

template<class derivedT , class specificT = shmimT>

size_t MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_typeSize {0}

protected

The size of the type, in bytes. Result of sizeof.

Definition at line 102 of file shmimMonitor.hpp.

◆ m_width

template<class derivedT , class specificT = shmimT>

uint32_t MagAOX::app::dev::shmimMonitor< derivedT, specificT >::m_width {0}

protected

The width of the images in the stream.

Definition at line 97 of file shmimMonitor.hpp.

The documentation for this class was generated from the following file:

libMagAOX/app/dev/shmimMonitor.hpp

Public Member Functions

Protected Attributes

Private Member Functions

SIGSEGV & SIGBUS signal handling

shmimmonitor Thread

INDI

Detailed Description

template<class derivedT, class specificT = shmimT> class MagAOX::app::dev::shmimMonitor< derivedT, specificT >

Member Function Documentation

◆ _handlerSigSegv()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ derived()

◆ handlerSigSegv()

◆ loadConfig()

◆ setSigSegvHandler()

◆ setupConfig()

◆ smThreadExec()

◆ smThreadStart()

◆ updateINDI()

Member Data Documentation

◆ m_dataType

◆ m_depth

◆ m_getExistingFirst

◆ m_height

◆ m_imageStream

◆ m_indiP_frameSize

◆ m_indiP_shmimName

◆ m_inode

◆ m_restart

◆ m_selfMonitor

◆ m_semaphoreNumber

◆ m_shmimName

◆ m_smCpuset

◆ m_smThread

◆ m_smThreadID

◆ m_smThreadInit

◆ m_smThreadPrio

◆ m_smThreadProp

◆ m_typeSize

◆ m_width

template<class derivedT, class specificT = shmimT>
class MagAOX::app::dev::shmimMonitor< derivedT, specificT >