Changes between Version 9 and Version 10 of PhalUserGuide

Timestamp:

11/19/08 00:28:09 (16 years ago)

Author:

ismael (IP: 62.57.188.40)

Comment:

--

PhalUserGuide

@@ -41 +41 @@
 More optional arguments can be passed to runph in the shell. The command accepts the following arguments:
 {{{
-runph [repository_path] -c [platform_cfg_file] -i [xitf_cfg_file] -p [priority] -d [debug_level] -r [fifo_report]
+runph [repository_path] -c [platform_cfg_file] -i [xitf_cfg_file] -p [priority] -d [debug_level] -r [fifo_report] [--daemon] [-o output_file]
 }}}
 Where:
@@ -50 +50 @@
  * ''-d [debug_level]'': Sets platform debug level. Currently only 2 modes are supported, level=0 or level!=0, where the first means normal operation and the second prevents EXEC daemon to kill processes which violated real time policies. ''Default'': 0
  * ''-r [fifo_report]'': File where the platform will log (in columns, for Matlab compatibility) the instantaneous waveform internal fifo utilization (in kilobytes). ''Default'': No report.
+ * ''--daemon'': Run PHAL in background. You should specify an output file (for standard output) so you can track what's happening. Also '''cmdman''' daemon should be launched as a daemon preventing to read from input (see below, Launching P-HAL as a Daemon). ''Default'': Foreground.
+ * ''-o [output_file]'': File to redirect standard output. ''Default'': None, terminal stdout.
+
 
 [[BR]]
@@ -96 +99 @@
 }}}
 
-Now the waveform is running. We can see some hardware information or current processes information typing:
-{{{
-runph$: hwcmd info
-runph$: hwcmd ps
+Now the waveform is running. We can see current processes information typing:
+{{{
+runph$: appinfo wimax
 }}}
 
@@ -114 +116 @@
 P-HAL Linux launcher admits two configuration files as arguments which modify certain Platform parameters. In this section we describe how to configure such parameters and what implications do they have:
 
-'''Platform Configuration File''': This file has one mandatory section, ''[cpu_info]'', and N optional sections, ''[daemon]''. The second selects which daemons (and their path) will be launched by runph. You can add or remove them according to which daemons you need in your platform (see PhalManual). The CPU configuration section, has two fields:
+'''Platform Configuration File''': This file has one mandatory section, ''[cpu_info]'', and N optional sections, ''[daemon]''. The second selects which daemons (and their path) will be launched by runph. You can add or remove them according to which daemons you need in your platform (see PhalManual). This sections have two fields only:
+ * ''path'': Path where the executable is.
+ * ''output'': File to redirect standard output (for loggin purposes)
+
+In the CPU section, you can specify some default P-HAL configuration parameters. '''Note''': This parameters are overriden by the ones passed as arguments to the P-HAL Launcher. See section above for more details.
  * ''mips'': Capacity in MIPS of your computer.
  * ''tslot'': Duration of the time slot, in microseconds.
+ * ''run_as_daemon'': Run in background.
+ * ''output_file'': File to redirect standard output.
+ * ''report_file'': File where save hw info reports
+ * ''debug_level'': Debug level
+ * ''priority'': Prioriry level for objects
  
 '''External Interfaces Configuration File''': This files has one section for each external TCP interface of your platform. Before creating a network of P-HAL platforms, you should be very familiar with the P-HAL Environment concepts as it compromises selecting which daemons will run every platform, which depends on your network architecture. The format of the file is a set of sections (''[xitf]'') with the following mandatory fields:
@@ -133 +144 @@
 [[BR]]
 
+== Launching P-HAL as a Daemon ==
+
+Running P-HAL in background is often interesing when long time executions are going to be performed. In foreground executions, disconnecting user terminal (or ssh session) will kill P-HAL processes as they inherit from user session. This can be prevented to happen if the user launches P-HAL with the ''daemon'' option (as an argument or in the platform configuration file, see above) and appropiate selects an output for text messages.
+
+When running in this mode, '''CMDMANAGER''' daemon must be also launched as daemon. It can't read commands from standard input anymore and a tcp socket should be created. Thus, another CMDMANAGER process (local or remote) can connect to it and send normal P-HAL commands (as if it was local).
+
+To do so, make sure you follow these steps:
+ 1. Modify Platform configuration file, adding the field '''run_as_daemon'''=''yes'' to the CPU section or launch P-HAL with the '''--daemon''' argument.
+ 2. Modify Platform configuration file, adding the field '''output_file'''=''hwapi_log_file'' to the CPU section or launch P-HAL with the '''-o''' ''hwapi_log_file'' argument.
+ 3. Modify Platform configuration file, changing the arguments of the '''cmdman''' enabling it to listen to input connections ('''-l''') and run as daemon ('''-d'''). At this step, your configuration file should show something like the following:
+  {{{
+  [cpu_info]
+   mips=...
+   tslot=...
+   ...
+   run_as_daemon=yes
+   output_file=/path/to/mylog/hwapi_output.log
+   work_path=/path/to/phal-repositories/
+   ...
+  [daemon]
+   ...
+  [daemon]
+   path=cmdman -l -p
+  }}}
+ 4.Then, if you specified '''work_path''' field in your configuration file, you can launch P-HAL just by typing:
+  {{{
+  runph
+  }}}
+  from any directory. This would launch P-HAL and send it to background.
+ 5. Now to perform commands you must connect to it (from local or remote machine):
+  {{{
+  cmdman -c 192.168.1.1
+  }}}
+  where 192.168.1.1 should obviously be replaced by the IP address where you launched the daemon. In this screen, you can type commands as usual and exit typing Ctrl+C. You will notice as you can re-connect with the same command and perform more commands.
+  At this point, you can exit your ssh session normally. P-HAL will keep running at background. When you login again, connect again with the previous cmdman command. Also, keep track of the output files (specifiyed at the configuration file) for errors or unusual behaviour.
+ 6. Finally, you can kill PHAL by sending a INT signal. This can be done typing:
+  {{{
+  killall -s INT runph
+  }}}
+ 
+
+[[BR]]
+
 == Performance Notes ==