FT means Fault-Tolerance.

This is the README file of FT application monitor under RT-Linux.

Written by A. Lanusse <lanusse@cea.fr>, P. Vanuxeem<vanuxeem@cea.fr>
Copyright (C) [date] OCERA Consortium.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation version 2.

Description :
-------------

The FT application monitor component, named ftappmon, is a higher level
component that analyzes possible consequences of an abnormal event on
application threads and activates application mode change if required.

The FT application monitor component provides a particular FT API interface
to the application.

The FT application monitor component is in relation with the FT controller
component.

The RT-Linux ftappmon module, associated to the FT application monitor
component, is build in order to be installed and executed, necessary by
the root user, under RT-Linux.

In complement, you can see README of the FT application module in the
directory ft/ftcontroller/examples/ftappli.

Implementation :
----------------

The ftappmon directory is composed of the following directories:
	- doc
	- examples
	- include
	- src

and the following files:
	- README
	- INSTALL
	- Makefile

The include directory contains the following files:
	- ft_appli_monitor.h
	- ft_api_appli_monitor.h

	The ft_appli_monitor.h file is the standart include of the
	ft_appli_monitor.c file.

	The ft_api_appli_monitor.h file defines the FT API interface between
	the FT application and the FT application monitor.
	This interface has to be used by an FT application file (ft_appli.c).
	It contains notably the prototypes of the FT API interface functions.

The src directory contains the following files:	
	- ft_appli_monitor.c

	The ft_appli_monitor.c file is the source code which implements
	the FT application monitor.
	It includes ft_appli_monitor.h file and ft_api_controller.h file
	(see README of ftcontroller component).

The Makefile file allows to make the RT-Linux ftappmon module, named
ftappmon.o.

Compilation :
-------------

In order to make the compilation of the ftappmon module, please follow
next steps:

	- Be a root user
	$ su
	Password:
	#

	- Go to the ft/ftappmon directory:
	# cd ft/ftappmon

	- Clean the ft/ftappmon directory:
	# make clean
	Notably an old ftappmon.o file is clean up.

	- Compile the ftappmon module:
	# make all
	The ftappmon.o module is now available under the ft/ftappmon
	directory.

Installation :
--------------
Note that the Makefile does'nt actually allow to install and execute the
ftappmon module.

Only the Makefile file in ftcontroller/examples directory allows actually
to install and execute all the modules, included ftappmon module, within a
whole application context.

Then it is recommended to use the Makefile in ft/ftcontrolller/examples
directory in order to install and execute notably the ftappmon module.

Note that the installation order between modules is important due to
the dependances between the FT components (API).
The imperative order is:
	- rtlinux start           (notably for rtl_ktrace)
	- insmod ftcontroller.o   (notably for ft_api_controller.h)
	- insmod ftappmon.o       (notably for ft_api_appli_monitor.h)
	- insmod ftappli.o