Project

General

Profile

Running DAQ Interface » History » Version 188

John Freeman, 10/10/2015 05:51 PM

1 58 John Freeman
{{toc}}
2 58 John Freeman
3 96 John Freeman
!DAQ_communication_diagram4.png!
4 96 John Freeman
5 49 Erik Blaufuss
h1. Getting help
6 1 John Freeman
7 78 John Freeman
If, after reading this document (in particular, the "Troubleshooting and FAQ" section) you run into issues, or have questions, please contact:
8 49 Erik Blaufuss
* DAQInterface
9 49 Erik Blaufuss
** John Freeman - jcfree@fnal.gov
10 62 John Freeman
* RunControl
11 49 Erik Blaufuss
** Erik Blaufuss - blaufuss@icecube.umd.edu
12 66 John Freeman
* Configuration Manager
13 1 John Freeman
** Jon Paley - jpaley@anl.gov
14 123 John Freeman
* TDU XML-RPC server
15 123 John Freeman
** Tom Dealtry - thomas.dealtry@physics.ox.ac.uk
16 1 John Freeman
17 102 Erik Blaufuss
h1. Logbook
18 102 Erik Blaufuss
19 102 Erik Blaufuss
Please document all changes, software updates, and operational activities to the ELog:
20 102 Erik Blaufuss
21 102 Erik Blaufuss
http://dbweb3.fnal.gov:8080/ECL/lbne_35t
22 120 John Freeman
23 1 John Freeman
h1. Brief preliminaries
24 1 John Freeman
25 136 John Freeman
This guide assumes you have access to the lbnedaq account on the LBNE 35 ton gateway node, lbne35t-gateway01.fnal.gov . It also assumes you have a rudimentary knowledge of how to navigate a bash environment in Linux (how to change directories, log onto different machines, perform time-ordered listings of files, edit a file using emacs or vi, etc.). 
26 49 Erik Blaufuss
27 188 John Freeman
The installed code is located at lbne35t-gateway01.fnal.gov:/data/lbnedaq/daqarea/lbnerc. If you need access to the lbnedaq lbne35t-gateway01.fnal.gov account, please contact one of the people listed above under "Getting Help". Once you have access, to get started, login (<code>ssh -l lbnedaq lbne35t-gateway01.fnal.gov</code>) and first setup the environment:
28 1 John Freeman
29 1 John Freeman
<pre>
30 1 John Freeman
cd /data/lbnedaq/daqarea
31 1 John Freeman
source fireup
32 188 John Freeman
re</pre>
33 1 John Freeman
34 1 John Freeman
This will take you into the /data/lbnedaq/daqarea/lbnerc directory, out of which the DAQ is controlled. For the remainder of this wiki, the assumption is that you've already setup the environment using the above commands. 
35 1 John Freeman
36 188 John Freeman
Keep in mind that you shouldn't run the DAQ if someone else is using it. To figure out whether this is the case, see "Getting the status", further down this document. Also keep in mind that when you use the DAQ, you should make a note of it in the elog, along with how long you plan to use it and whether you're willing to let someone else step in if you're work is non-urgent.  A reminder to this effect is printed whenever you log into lbne35t-gateway01.fnal.gov. 
37 1 John Freeman
38 188 John Freeman
To see the terminal output of RunControl and DAQInterface, you'll want to be in the same terminal from where they were launched. This means it's typically not a good idea to try to use a "stale" RunControl and/or DAQInterface that someone else may have started hours (or even days) ago. 
39 188 John Freeman
40 188 John Freeman
Concerning example output shown in this document:  when you see an ellipse ("…"), that is to be interpreted as a placeholder for output which is considered irrelevant to the point being explained.
41 188 John Freeman
42 123 John Freeman
h1. Killing, launching, and getting the status of the DAQ applications
43 123 John Freeman
44 123 John Freeman
The DAQ application suite consists of RunControl, the configuration manager, DAQInterface (the component which intermediates between RunControl, the configuration manager, and the artdaq processes) and the XML-RPC server for the TDU (the program which allows a sync pulse to be sent to the hardware at the start of DAQ running). The following points about these programs should be observed:
45 123 John Freeman
** These applications all need to be running in order for the DAQ to work
46 188 John Freeman
** DAQInterface needs to be launched _after_ RunControl
47 1 John Freeman
** The actual names of the processes are "lbnecontrol" (RunControl), "daqinterface" (DAQInterface), "CfgMgrApp" (the configuration manager) and "tdu" (the TDU XML-RPC server)
48 1 John Freeman
49 167 John Freeman
h2. Getting the status
50 167 John Freeman
51 165 John Freeman
In order to determine which DAQ applications are already active, two approaches can be taken, depending on whether or not RunControl is itself active. If it isn't, you'll need to enter the following:
52 1 John Freeman
53 1 John Freeman
<pre>
54 165 John Freeman
check_daq_applications.sh
55 165 John Freeman
</pre>
56 176 John Freeman
which will produce output which looks like this:
57 1 John Freeman
<pre>
58 176 John Freeman
59 188 John Freeman
lbnecontrol: **Not Found**
60 188 John Freeman
CfgMgr: Available
61 176 John Freeman
DAQInterface: Available
62 176 John Freeman
TDUControl: **Not Found**
63 176 John Freeman
64 176 John Freeman
Most recent DAQ logfile written (current US Central Time is Apr 10 09:56):
65 176 John Freeman
Apr 8 17:25 /data/lbnedaq/daqlogs/pmt/pmt-32342.1-20150408171225.log
66 155 John Freeman
</pre>
67 1 John Freeman
68 188 John Freeman
In other words, the above command will both tell you which, if any, of the four primary DAQ applications are running, and then tell you the time of the most recently modified logfile; this last piece of information is helpful in determining whether the DAQ is currently in active use by another individual. In particular, you see that the configuration manager and DAQInterface already exist, but RunControl and the TDU's XML-RPC server do not. In this case, you would not only want to launch RunControl and the server, but you would also want to kill and relaunch DAQInterface. Unless someone had just posted in the elog that they were planning to run on the DAQ (and did so before you had a chance to post!), you wouldn't need to worry about interfering with someone else's DAQ work, since you can see above that it's been almost two days since any DAQ output was logged. 
69 155 John Freeman
70 176 John Freeman
Another way of checking which applications are alive is through "@lbnecmd check@"; note this command will only work if RunControl (lbnecontrol) is itself alive:
71 1 John Freeman
<pre>
72 1 John Freeman
lbnecmd check
73 1 John Freeman
</pre>
74 138 John Freeman
75 176 John Freeman
You'll then see output similar to that of check_daq_applications.sh as far as which applications are alive; however, it contains additional information not shown which will be discussed later:
76 124 John Freeman
<pre>
77 124 John Freeman
lbnecontrol: Available
78 124 John Freeman
CfgMgr: **Not Found**
79 1 John Freeman
DAQInterface: Available
80 124 John Freeman
TDUControl: **Not Found**
81 1 John Freeman
...
82 1 John Freeman
</pre>
83 91 John Freeman
84 176 John Freeman
Be aware that if you attempt "lbnecmd check" when RunControl is not yet available, you'll simply see "<code>check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?</code>".
85 49 Erik Blaufuss
86 124 John Freeman
h2. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
87 1 John Freeman
88 152 John Freeman
As of March 30, 2015, a new script called "kill_daq_applications.sh" can be run at the command line to kill the DAQ applications. In order to kill all four applications, one would run:
89 152 John Freeman
90 152 John Freeman
<pre>
91 152 John Freeman
kill_daq_applications.sh -c -d -r -t
92 152 John Freeman
</pre>
93 152 John Freeman
94 160 John Freeman
where each option corresponds to the killing of a particular application: "-c" for the configuration manager, "-d" for DAQInterface, "-r" for RunControl, and "-t" for the TDU XML-RPC server. If only a subset of these four applications are running, then only use the relevant options (e.g., simply run "<code>kill_daq_applications.sh -t</code>" if the only application running is the TDU server). Running the script without any options at all will print out instructions similar to what you see here. Be aware that it's good etiquette to make sure someone's not currently using the DAQ before you start killing applications. 
95 152 John Freeman
96 153 John Freeman
For the previous instructions for killing the applications (still correct, though more work-intensive), click on "Show", below:
97 152 John Freeman
98 152 John Freeman
{{collapse()
99 152 John Freeman
100 124 John Freeman
Killing RunControl has its own special syntax, and is simply:
101 1 John Freeman
102 109 Thomas Dealtry
<pre>
103 124 John Freeman
lbnecmd kill
104 1 John Freeman
</pre>
105 105 John Freeman
106 124 John Freeman
The other DAQ applications, however, need to be killed via the standard Linux command <code>kill <pid></code>, where "<pid>" is the process ID of the application. To find the process IDs of all possible DAQ applications, you can run:
107 105 John Freeman
108 105 John Freeman
<pre>
109 124 John Freeman
ps aux | grep -v grep | grep -v emacs | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
110 105 John Freeman
</pre>
111 1 John Freeman
112 140 John Freeman
For each application which exists, a row will appear, the second field of which is that application's process ID. Keep in mind, of course, that if these processes are running, it might mean that someone else is using the DAQ. As the 9th and 10th fields of the row of variables "ps aux" returns concern how long the program has been running, you can use these values as well as your best judgement, then, before deciding these processes are not in active use and killing them.
113 152 John Freeman
}}
114 105 John Freeman
115 124 John Freeman
h2. Launching RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
116 105 John Freeman
117 154 John Freeman
Also as of March 30, 2015, a new script called "launch_daq_applications.sh" can be run at the command line to launch the DAQ applications. In order to launch all four applications, one would run:
118 154 John Freeman
<pre>
119 154 John Freeman
launch_daq_applications.sh -c -t -r -d <daqinterface configuration file>
120 154 John Freeman
</pre>
121 154 John Freeman
122 161 John Freeman
where unless you have your own working copy of the DAQInterface configuration file (what this is will be described later in this wiki), "<code><daqinterface configuration file></code>" should be "<code>docs/config.txt</code>". The options refer to the same applications as in the case of kill_daq_applications.sh, and like kill_daq_applications.sh, executing the script without any options will print out instructions. Be aware, however, that DAQInterface will not be launched if RunControl isn't already running. In practice, though, you can launch RunControl in the same launch_daq_applications.sh command by preceding the DAQInterface option with the RunControl option -- so, if the configuration manager and the TDU server are already up and available, then one would only need to execute "<code>launch_daq_applications.sh -r -d <daqinterface configuration file></code>" in order to have the full suite of DAQ applications available for use. 
123 154 John Freeman
124 154 John Freeman
Note that if an application of a given type is already running, launch_daq_applications.sh will not launch a duplicate application, but will instead print a warning to the screen. 
125 154 John Freeman
126 161 John Freeman
For the previous instructions on how to launch the DAQ applications (still correct, but more detailed and labor-demanding), click on "Show" below:
127 154 John Freeman
128 154 John Freeman
{{collapse()
129 154 John Freeman
130 181 John Freeman
_Old instructions for launching RunControl_
131 49 Erik Blaufuss
132 124 John Freeman
<pre>
133 49 Erik Blaufuss
rm -f /tmp/lbnecontrol.pid  # (This should only be necessary if last RunControl session wasn't killed via "lbnecmd kill")
134 1 John Freeman
lbnecmd launch
135 1 John Freeman
</pre>
136 61 John Freeman
137 181 John Freeman
_Old instructions for launching DAQInterface_
138 151 John Freeman
139 151 John Freeman
<pre>
140 151 John Freeman
daqinterface -f <daqinterface file> &
141 151 John Freeman
</pre>
142 1 John Freeman
143 1 John Freeman
The "-f <daqinterface file>" is optional; if left out, the lbnerc/docs/config.txt file will be used to configure DAQInterface, otherwise <daqinterface file> will be used. The DAQInterface configuration is not to be confused with run configurations handled by the configuration manager; see the section "The DAQInterface configuration file" for more. 
144 1 John Freeman
145 154 John Freeman
Other "expert" arguments:
146 151 John Freeman
<pre>
147 1 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
148 1 John Freeman
</pre>
149 1 John Freeman
Here, the "daqint" argument is arbitrary, and is the name you'll give the DAQInterface process in RunControl; the "5570" argument is the port off of which DAQInterface will run.  "-c" refers to the host on which RunControl is running, and "-H" the host on which DAQInterface is running. 
150 141 John Freeman
151 154 John Freeman
152 154 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
153 1 John Freeman
<pre>
154 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
155 1 John Freeman
</pre>
156 1 John Freeman
This will launch daqinterface in the background, with all messages being appended to the bottom of the file ~/DI.log  (The stdbuf -oL prevents buffering of output to the file, so the file should update in real time)
157 141 John Freeman
158 154 John Freeman
159 181 John Freeman
_Old instructions for launching the configuration manager_
160 1 John Freeman
161 1 John Freeman
Please see the "Starting up the CfgMgrApp on lbne35t-gateway01" section of Jon Paley's documentation here: https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki
162 109 Thomas Dealtry
163 181 John Freeman
_Old instructions for launching the TDU XMLRPC server_
164 109 Thomas Dealtry
165 109 Thomas Dealtry
<pre>
166 124 John Freeman
tdu -T 192.168.100.201 -P 10001 -H localhost -r 50008 &
167 1 John Freeman
</pre>
168 1 John Freeman
169 109 Thomas Dealtry
?Note that if you are using emulators, you don't need to run using the TDU. Remember to set 'TDU XMLRPC port' to less than or equal 0.
170 125 John Freeman
171 154 John Freeman
See [[Starting and using TDUControl]] for more details.
172 1 John Freeman
173 154 John Freeman
}}
174 62 John Freeman
175 162 John Freeman
h1. Performing a Run
176 1 John Freeman
177 142 John Freeman
With the applications launched, you can take the DAQ system through the standard transitions to perform a DAQ run. The "ground state" of the DAQ is called the "stopped" state. Each successful transition brings the DAQ into a different state.  Described in more detail later, the chain of states (in quotes) and transitions (in italics) in the DAQ system can be represented as follows:
178 1 John Freeman
179 142 John Freeman
---
180 143 John Freeman
181 188 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "paused" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
182 143 John Freeman
183 142 John Freeman
---
184 142 John Freeman
185 125 John Freeman
h2. Checking the state of the DAQ
186 127 John Freeman
187 125 John Freeman
At all stages, you can use the "lbnecmd check" command to see what state DAQInterface is in; example output of this is as follows:
188 1 John Freeman
<pre>
189 125 John Freeman
lbnecontrol: Available
190 125 John Freeman
CfgMgr: Available
191 125 John Freeman
DAQInterface: Available
192 125 John Freeman
TDUControl: Available
193 125 John Freeman
194 125 John Freeman
Run number: 797
195 125 John Freeman
Run configuration: ganglia_test
196 125 John Freeman
Run type: Test
197 125 John Freeman
daqint@localhost:5570 (synchronous): running
198 125 John Freeman
</pre>
199 125 John Freeman
200 125 John Freeman
Here, you've already seen how lbnecmd check can tell you whether a given application type has been launched or not; on the bottom line, however, you'll also see a description of the _state_ of the DAQ -- in this case, "running", meaning that it's actively acquiring data. 
201 108 John Freeman
202 108 John Freeman
Note that you'll want to wait for a transition to complete before issuing another one, otherwise you'll receive a warning and the transition request will be ignored. DAQInterface will also report when transitions are complete -- e.g., at the end of the "initialize" transition, you'd see:
203 117 John Freeman
<pre>
204 108 John Freeman
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
205 1 John Freeman
</pre>
206 142 John Freeman
If a high "debug level" has been set for DAQInterface (see below for more on this), this message can get buried in a set of output messages; in this case "lbnecmd check" may be the easiest way to determine what state the system is in.
207 1 John Freeman
208 94 John Freeman
h2.  Selecting a run configuration and DAQ components
209 49 Erik Blaufuss
210 125 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQ components must be selected.  This is done via RunControl.
211 1 John Freeman
212 49 Erik Blaufuss
h3. List and select a configuration:
213 1 John Freeman
214 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
215 49 Erik Blaufuss
<pre>
216 1 John Freeman
lbnecmd listconfigs
217 1 John Freeman
</pre>
218 143 John Freeman
This lists all available configs, as well as the current selected config (Note, default config is "No Config"):
219 49 Erik Blaufuss
<pre>
220 49 Erik Blaufuss
Available configs (Name : description)
221 1 John Freeman
222 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
223 111 John Freeman
6xssp_ext : Sorry, no description found.
224 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
225 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
226 30 John Freeman
...
227 49 Erik Blaufuss
228 1 John Freeman
Current selected config: No Config
229 49 Erik Blaufuss
</pre>
230 143 John Freeman
You can then select a configuration -- for the purposes of this tutorial, let's go with "demo", which creates simulated data without using any hardware:
231 49 Erik Blaufuss
<pre> 
232 49 Erik Blaufuss
lbnecmd setconfig demo
233 1 John Freeman
</pre>
234 90 John Freeman
This will return "OK" if successful; "lbnecmd listconfigs" will then show this as the current config.  If the specified configuration is not known, an error is returned. Instructions on how to add a configuration are given later in this document.
235 1 John Freeman
236 49 Erik Blaufuss
h3. List and select DAQ components.
237 1 John Freeman
238 62 John Freeman
You can select which portions of the LBNE DAQ setup you want to use in the upcoming run.  These are mapped generally to the ArtDAQ BoardReaderMain processes
239 90 John Freeman
that read them out.   As an operator, you need to ensure that there are configuration files available in the configuration manager for the DAQ Components that you select here, or DAQInterface will return an error.
240 1 John Freeman
241 49 Erik Blaufuss
To see the list of available DAQ components:
242 1 John Freeman
<pre>
243 49 Erik Blaufuss
lbnecmd listdaqcomps
244 62 John Freeman
</pre>
245 1 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
246 112 John Freeman
<pre>
247 112 John Freeman
Available:
248 112 John Freeman
component01 (lbnedaq2:5205)
249 112 John Freeman
component02 (lbnedaq2:5206)
250 112 John Freeman
251 112 John Freeman
ssp08 (lbnedaq1:5214)
252 112 John Freeman
253 112 John Freeman
Selected:
254 112 John Freeman
component01 (lbnedaq2:5205)
255 112 John Freeman
component02 (lbnedaq2:5206)
256 1 John Freeman
257 1 John Freeman
ssp08 (lbnedaq1:5214)
258 62 John Freeman
</pre>
259 143 John Freeman
The components are shown by name, along with the requested host/port to run the component's corresponding BoardReaderMain process on. You can then select a list of DAQ components to use in the run:
260 1 John Freeman
<pre>
261 1 John Freeman
lbnecmd setdaqcomps component0{1,2}
262 118 John Freeman
</pre>
263 49 Erik Blaufuss
(n.b. the {1,2} in brackets is a Linux bash shell trick which expands <code>component0{1,2}</code> to <code>component01 component02</code>). This will return "OK" if successful ("lbnecmd listdaqcomps" will show this in the "selected" set of components).  If the specified components are not known, an error is returned.
264 143 John Freeman
265 143 John Freeman
How to make a new component available to RunControl is described later in this document. 
266 29 John Freeman
267 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
268 1 John Freeman
269 66 John Freeman
For each of these transitions, please recall that while "lbnecmd <cmd>" returns very quickly, the actual issued command can take several seconds or minutes to complete.  Before issuing another command, be sure that the transition is complete by using the check command:
270 1 John Freeman
<pre>
271 49 Erik Blaufuss
lbnecmd check
272 1 John Freeman
</pre>
273 62 John Freeman
For example, before issuing the "start" transition, you can use this command to ensure that the DAQ is in the "ready" state and not still in the "initializing" stage.
274 1 John Freeman
275 167 John Freeman
First, take DAQInterface from the "stopped" to the "ready" state; this will create the artdaq processes on the hosts they've been assigned, and initialize them with the FHiCL documents:
276 1 John Freeman
<pre>
277 1 John Freeman
lbnecmd init daq
278 1 John Freeman
</pre>
279 1 John Freeman
280 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
281 29 John Freeman
<pre>
282 1 John Freeman
lbnecmd start daq
283 49 Erik Blaufuss
</pre>
284 179 John Freeman
Immediately, you'll see a request for a confirmation that the configuration and selected components are in fact the ones you want; it will look something like the following:
285 179 John Freeman
<pre>
286 179 John Freeman
DAQ config
287 179 John Freeman
**********
288 179 John Freeman
Run Type: Test
289 179 John Freeman
Selected config: ganglia_test
290 179 John Freeman
Selected DAQ components:
291 179 John Freeman
   ssp01 (lbnedaq1:5207)
292 179 John Freeman
   ssp02 (lbnedaq1:5208)
293 179 John Freeman
   ssp03 (lbnedaq1:5209)
294 179 John Freeman
Start DAQ with these settings? [y]|n: y
295 179 John Freeman
</pre>
296 179 John Freeman
Assuming you're happy with the configuration and components, hit "y" to proceed, and as with the other transitions, wait for the "transition complete" message to appear. 
297 179 John Freeman
298 186 John Freeman
Note that the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command. If the start transition was successful, information about the run is saved in the run records directory, @/data/lbnedaq/run_records/<run_number>@, where @<run_number>@ is to be taken as a stand-in for the actual run number. More on how to understand the directory's contents is described below, under "Examining the output". Of immediate interest, the real-time output of the DAQ will be saved in a logfile located in /data/lbnedaq/daqlogs/pmt/. While in the running state, you can obtain its name just by executing the "check_daq_applications.sh" script described above; with its name, if you open up a fresh terminal and run "tail -f <logfilename>" you'll see the logfile updating in real time. Please note that after reaching a predefined number of bytes, the logfile will cease being written to and a new logfile will be opened up; this is the most likely reason that you stop seeing updates after running the "tail -f" command. 
299 49 Erik Blaufuss
300 178 John Freeman
Pause the running of the DAQ, putting DAQInterface into the "paused" state.  This will cause the current open output Root file, in /data/lbnedaq/data, to be closed and given a name reflecting the current run and subrun numbers (the format as of April 10, 2015 is @lbne_r<run number>_sr<subrun number>_<creation time>.root@):
301 22 John Freeman
<pre>
302 21 John Freeman
lbnecmd pause daq
303 42 John Freeman
</pre>
304 41 John Freeman
305 167 John Freeman
Resume the running of the DAQ, returning it to the "running" state.  This will restart data taking to a new output file:
306 1 John Freeman
<pre>
307 48 John Freeman
lbnecmd resume daq
308 48 John Freeman
</pre>
309 48 John Freeman
310 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
311 48 John Freeman
<pre>
312 48 John Freeman
lbnecmd stop daq
313 49 Erik Blaufuss
</pre>
314 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
315 127 John Freeman
*NOTE* To select a new configuration or DAQ component set, you must issue the "terminate" command, which will kill all ArtDAQ processes and return DAQInterface to its "stopped" state:
316 1 John Freeman
317 67 Erik Blaufuss
<pre>
318 67 Erik Blaufuss
lbnecmd terminate daq
319 67 Erik Blaufuss
</pre>
320 1 John Freeman
321 172 John Freeman
h2. Examining the output
322 1 John Freeman
323 129 John Freeman
Once you've completed your run, there are typically two primary outputs: the Root files which contain the data which passed through the DAQ (saved, as of March 25, 2015, in /data/lbnedaq/data on the gateway node), and a set of text files containing information about the run. To access these text files, you'll want to go to the run records directory, which defaults to /data/lbnedaq/run_records/<run_number>. This directory contains the FHiCL documents used to control the ArtDAQ processes in the run, the DAQInterface configuration file used (described later in this wiki), and a metadata file, which, among other things, describes where to find a record of the DAQ's output. An example of this file, for run 778, can be found if we look in /data/lbnedaq/run_records/778 at "metadata_r778.txt":
324 119 John Freeman
325 72 John Freeman
<pre>
326 72 John Freeman
Config name: demo
327 72 John Freeman
Component #0: component01
328 1 John Freeman
Component #1: component02
329 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
330 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
331 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
332 1 John Freeman
333 114 John Freeman
334 114 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
335 1 John Freeman
336 1 John Freeman
boardreader logfiles: 
337 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37365.log
338 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37366.log
339 1 John Freeman
340 1 John Freeman
eventbuilder logfiles: 
341 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37364.log
342 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37363.log
343 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37368.log
344 1 John Freeman
345 1 John Freeman
aggregator logfiles: 
346 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37369.log
347 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37367.log
348 1 John Freeman
349 1 John Freeman
</pre>
350 167 John Freeman
The most significant things saved in this file for the end user of the DAQ system are the configuration chosen and the components chosen for the run (at the top of the file), and the wildcard for the pmt (ArtDAQ Process Management Tool) logfiles, which contain the output of the DAQ system, under "pmt logfile(s)" -- so, in this case, executing <code>ls -ltr /data/lbnedaq/daqlogs/pmt/pmt-25771*.log</code> would list the files containing the output of the DAQ in run 778. Concerning this last point, just be aware of the possibility that earlier DAQ sessions may have produced logfiles which also satisfy the wildcard, as the "25771" in the wildcard example provided refer to the process ID of the pmt process, which isn't necessarily unique for a given run. 
351 1 John Freeman
352 119 John Freeman
353 129 John Freeman
{{collapse(Comprehensive details on the contents of the run records directory...)
354 129 John Freeman
355 129 John Freeman
** The full contents of the metadata file, beyond what's described above, include: 
356 129 John Freeman
-The git commit hashes of the lbne-artdaq and lbnerc packages used in the run, as well as the commit hash of the configuration directory used by the configuration manager
357 129 John Freeman
-The individual artdaq process logfiles
358 129 John Freeman
359 129 John Freeman
** A copy of the DAQInterface configuration file with a name of the format <code>config_r<run number>.txt</code> is saved. A description of what this file is comes later in the wiki. 
360 129 John Freeman
361 129 John Freeman
** Please note that the FHiCL documents saved in the run records directory will contain the actual FHiCL sent to the artdaq processes for the run, and that this will be slightly different than the contents of the FHiCL documents found in the configuration manager's directory. This is because DAQInterface performs some bookkeeping on FHiCL variables which account for things such as the number of processes of a given type (note that it makes no changes which would affect the physics). The saved FHiCL document name is standardized to <processtype>_<host>_<port>_r<run number>.fcl, so, e.g, "EventBuilder_lbnedaq2_5735_r778.fcl" refers to the FhiCL used to control the EventBuilderMain process on lbnedaq2 at port 5735 during run 778. 
362 129 John Freeman
363 129 John Freeman
** Please also note that the entire subdirectory for the configuration is also saved alongside the FHiCL documents; this is because some FHiCL documents are included via "#include" into the main FHiCL documents for a given process, and this was the way to save them as well as the main FHiCL documents. 
364 129 John Freeman
365 129 John Freeman
}}
366 129 John Freeman
367 129 John Freeman
{{collapse(How to examine your output Root files...)
368 185 John Freeman
Various art modules may create various types of output. In particular, it's standard for one of the two AggregatorMains running in an artdaq-based DAQ to use art's RootOutput module, which will save the assembled raw event in an art-readable *.root file. The location of this output can be found in the FHiCL code used to control RootOutput; as of March 30, 2015, the standard location is /data/lbnedaq/data on the gateway node. The other AggregatorMain typically will run other modules designed to create plots, diagnostic printouts, etc.; the nature of the output here is too varied to neatly summarize, but checking the FHiCL code used to control these art modules should reveal their output location.
369 76 John Freeman
370 185 John Freeman
To take a quick look at the art-readable *.root file, with a version of lbne-artdaq newer than 11/25/14, you can do the following:
371 76 John Freeman
372 76 John Freeman
<pre>
373 76 John Freeman
cd <lbne-artdaq basedir>
374 76 John Freeman
source setupLBNEARTDAQ
375 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
376 76 John Freeman
</pre>
377 76 John Freeman
378 186 John Freeman
where here, <lbne-artdaq basedir> is the parent directory of the lbne-artdaq package (make sure the package is of a version equal to or higher than the one used to produce the *.root file - you can check the saved metadata*.txt and DAQInterface configuration files in the run_records/ directory for info on this), <rootfile> is the art-readable *.root file produced in a given run, and <max events> is the max events whose info you wish to look at. For a specific example of the output, say we look at the first event of run 731:
379 166 John Freeman
<pre>
380 166 John Freeman
rawEventDump -s /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root -n 1
381 166 John Freeman
</pre>
382 1 John Freeman
383 166 John Freeman
Then the output will look something like the following:
384 166 John Freeman
385 81 John Freeman
<pre>
386 166 John Freeman
%MSG-i MF_INIT_OK:  art 08-Apr-2015 13:29:00 CDT JobSetup 
387 81 John Freeman
Messagelogger initialization complete.
388 81 John Freeman
%MSG
389 166 John Freeman
%MSG-i PathConfiguration:  art 08-Apr-2015 13:29:00 CDT JobSetup 
390 1 John Freeman
Multiple end paths have been combined into one end path,
391 1 John Freeman
"end_path" since order is irrelevant.
392 1 John Freeman
393 1 John Freeman
%MSG
394 166 John Freeman
08-Apr-2015 13:29:00 CDT  Initiating request to open file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
395 166 John Freeman
08-Apr-2015 13:29:00 CDT  Successfully opened file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
396 81 John Freeman
--------------------------------------------------------------
397 1 John Freeman
Package             |Version             |Timestamp           
398 166 John Freeman
artdaq-core         |v1_04_10            |11-Mar-2015 14:35:37 UTC
399 166 John Freeman
artdaq              |v1_12_08            |11-Mar-2015 14:37:50 UTC
400 166 John Freeman
lbne-raw-data       |v1_02_00            |11-Mar-2015 14:36:11 UTC
401 166 John Freeman
lbne-artdaq         |v1_01_02            |13-Mar-2015 20:31:07 UTC
402 76 John Freeman
--------------------------------------------------------------
403 166 John Freeman
Begin processing the 1st record. run: 731 subRun: 1 event: 1 at 08-Apr-2015 13:29:00 CDT
404 81 John Freeman
PROCESS NAME | MODULE LABEL.. | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE............ | PRODUCT FRIENDLY TYPE | SIZE
405 166 John Freeman
DAQ......... | daq........... | PHOTON............... | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...7
406 166 John Freeman
DAQ......... | daq........... | TPC.................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...8
407 81 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
408 1 John Freeman
409 166 John Freeman
Total products (present, not present): 8 (3, 5).
410 1 John Freeman
411 76 John Freeman
PROCESS NAME | MODULE LABEL | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE.................... | PRODUCT FRIENDLY TYPE.... | SIZE
412 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
413 1 John Freeman
414 76 John Freeman
Total products (present, not present): 1 (1, 0).
415 81 John Freeman
416 166 John Freeman
08-Apr-2015 13:29:00 CDT  Closed file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
417 1 John Freeman
418 76 John Freeman
TrigReport ---------- Event  Summary ------------
419 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
420 76 John Freeman
421 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
422 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
423 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
424 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
425 76 John Freeman
426 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
427 166 John Freeman
TimeReport CPU = 0.017439 Real = 0.007998
428 1 John Freeman
429 1 John Freeman
Art has completed and will exit with status 0.
430 166 John Freeman
431 129 John Freeman
</pre>
432 166 John Freeman
The first thing you see here is the version and build time of the lbne-artdaq package and some of the main packages on which it depends. Then you see a listing of products in the Root file, here including seven fragments of type PHOTON (from the SSPs) and eight fragments of type TPC (from the RCEs).  Finally, a listing of passed/failed events; the output here is the result of running with "-n 1" as an option, so as we'd expect there's only one event.
433 131 John Freeman
}}
434 1 John Freeman
435 145 John Freeman
h1. The DAQInterface configuration file
436 1 John Freeman
437 167 John Freeman
DAQInterface uses some key information stored in a local configuration file, NOT to be confused with the run configuration described elsewhere on this wiki. Examples of this information are the hosts and ports (i.e., communication sockets) for artdaq processes, location of lbne-artdaq software, debug (log) level, etc). These can be changed while the DAQ is in its "stopped" state. The default DAQInterface configuration file is docs/config.txt (relative to /data/lbnedaq/daqarea/lbnerc); if you wish to change parameters, it's considered best practice not to edit this default file but rather to copy it to a file of the form "<code>docs/config_<your username>.txt</code>", and edit that file, passing it to the DAQInterface executable as described in the section on launching applications. It's expected that for normal operations, most parameters should not need to changed too often, and alterations will be primarily of developer or expert interest. If you ARE a developer/expert or are simply curious, take a look at the default DAQInterface configuration file; it should look something like the following:
438 100 John Freeman
<pre>
439 91 John Freeman
440 1 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
441 100 John Freeman
442 1 John Freeman
PMT host: lbnedaq3
443 49 Erik Blaufuss
PMT port: 5400
444 49 Erik Blaufuss
445 49 Erik Blaufuss
pause before initialization: 5
446 49 Erik Blaufuss
447 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
448 49 Erik Blaufuss
debug level: 1
449 49 Erik Blaufuss
450 91 John Freeman
log directory:   /data/lbnedaq/daqlogs
451 49 Erik Blaufuss
452 116 John Freeman
record directory: /data/lbnedaq/run_records
453 116 John Freeman
454 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
455 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
456 101 John Freeman
# set "disable configuration check" to "true"
457 101 John Freeman
458 101 John Freeman
disable configuration check: false
459 91 John Freeman
460 167 John Freeman
TDU XMLRPC port: 50008
461 48 John Freeman
462 91 John Freeman
EventBuilder host: lbnedaq2
463 91 John Freeman
EventBuilder port: 5235
464 91 John Freeman
465 48 John Freeman
EventBuilder host: lbnedaq2
466 91 John Freeman
EventBuilder port: 5236
467 91 John Freeman
468 48 John Freeman
Aggregator host: lbnedaq2
469 91 John Freeman
Aggregator port: 5265
470 1 John Freeman
471 1 John Freeman
Aggregator host: lbnedaq2
472 1 John Freeman
Aggregator port: 5266
473 1 John Freeman
474 130 John Freeman
</pre>
475 1 John Freeman
476 130 John Freeman
The parameters you're most likely to change will be the following:
477 1 John Freeman
478 130 John Freeman
* *lbne-artdaq* : the directory in which the desired build of lbne-artdaq to use is located; you would change this if you'd modified and built a personal copy of lbne-artdaq for hardware troubleshooting purposes, for example.
479 130 John Freeman
480 130 John Freeman
* *debug level* : allows the user to set the verbosity level of the output to the screen; setting it to higher values creates greater verbosity, and as a practical matter, the range of settings is currently 0-3. Loosely speaking, "0" means minimal output (not much beyond simply announcing a transition is complete), "1" includes announcements of progress during transitions, "2" includes these announcements plus the values of certain variables as well as lbne-artdaq output, and "3" is primarily of developer interest. 
481 130 John Freeman
482 130 John Freeman
* *disable configuration check* : a boolean which can be set to "true" or "false"; normally this should be set to "false", which means that on the start transition, DAQInterface will intentionally fail and put itself into the "stopped" state if it discovers that edits have been made to the configuration directory since the last commit in that directory. If very frequent edits to the configuration directory are made during hardware debugging, however, switching this feature on to "true" can make life considerably easier. 
483 130 John Freeman
484 130 John Freeman
* *TDU XMLRPC port* : the value of the port through which DAQInterface will communicate with an XML-RPC server linked to the TDU. Needed for DAQInterface to send a sync pulse to the TDU at the beginning of the "start" and "resume" transitions. If this is set to 0 or a negative value, no sync pulse is attempted. For more on the TDU and its code, see Tom Dealtry's Wiki "here":https://cdcvs.fnal.gov/redmine/projects/lbne-daq/wiki/Starting_and_using_TDUControl
485 130 John Freeman
486 1 John Freeman
{{collapse(Other parameters are as follows…)
487 92 John Freeman
488 116 John Freeman
* *PMT host* : the host on which artdaq's process management tool script (pmt.rb, used by DAQInterface to launch and kill the artdaq processes) will run
489 93 John Freeman
* *PMT port* : pmt.rb's port
490 93 John Freeman
491 101 John Freeman
* *pause before initialization* : the time in seconds between when the artdaq processes have been created and when they're initialized via FHiCL documents; empirically a pause of 5 seconds seems to be sufficient (less than this an errors can occur; see below in the "Troubleshooting" section for more
492 1 John Freeman
493 101 John Freeman
* *log directory* : the directory relative to which lbne-artdaq's pmt/*.log output (a record of what it sent to stdout) will be placed, as well as the individual artdaq process logs, found in boardreader/, eventbuilder/, and aggregator/
494 101 John Freeman
495 49 Erik Blaufuss
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
496 130 John Freeman
497 49 Erik Blaufuss
After these individual parameters, one defines the EventBuilderMain and AggregatorMain artdaq processes. Specifically, a process is defined in two lines, where each line should contain "EventBuilder" or "Aggregator", and then define the host and port on which the EventBuilderMain or AggregatorMain will run (to run an artdaq process on the same host as you're on, use "localhost"). Please note that the order of processes matters, and that they should be listed front-end to back-end, i.e., EventBuilders should appear before Aggregators.
498 57 John Freeman
}}
499 57 John Freeman
500 187 John Freeman
h1. Editing or adding RunControl configurations
501 132 John Freeman
502 68 John Freeman
{{collapse(Expand for info here…)
503 68 John Freeman
504 91 John Freeman
Adding a new configuration selectable from RunControl involves two steps: creating a directory with the desired name of the configuration which contains the desired FHiCL documents, and then committing that directory to the git repository. 
505 57 John Freeman
506 57 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
507 57 John Freeman
<pre>
508 57 John Freeman
/data/lbnedaq/config/<named_configuration>
509 57 John Freeman
</pre>
510 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
511 59 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
512 59 John Freeman
* <named_component>_hw_cfg.fcl, used to initialize the BoardReaderMain process running the fragment generator associated with detector component "named_component". Note that there can be any number of such files associated with a configuration, as long as a given component is registered to RunControl (see below, "Adding new DAQ Components to RunControl")
513 59 John Freeman
514 167 John Freeman
There are existing examples of configurations currently within /data/lbnedaq/config which can be studied (and even copied) for further guidance; a good starting point is the "demo" configuration due to its relative simplicity. Note that the FHiCL documents in these directories contain some variables which are set to "PLACEHOLDER", e.g.
515 59 John Freeman
<pre>
516 68 John Freeman
 event_builder_count: PLACEHOLDER
517 1 John Freeman
</pre>
518 68 John Freeman
Note that this is not legal FHiCL, but that DAQInterface will substitute in the appropriate value before using the FHiCL document to initialize an artdaq process; here, for example, it would replace "PLACEHOLDER" with the actual number of EventBuilderMain processes being run.
519 68 John Freeman
520 68 John Freeman
Once you've added a new configuration to /data/lbnedaq/config, you'll need to perform a git commit. Essentially,  /data/lbnedaq/config is not merely a collection of directories naming configurations, but also a git repository. In fact, if you run
521 68 John Freeman
<pre>
522 68 John Freeman
git log
523 68 John Freeman
</pre>
524 68 John Freeman
you'll see a history of the commits made to the repository. In order to commit the directory, a couple of steps need to be taken:
525 68 John Freeman
* From /data/lbnedaq/config/, run <pre>git add <named_configuration></pre>. This will "stage" the directory to be committed. Running <pre>git status</pre> should show you something like the following:
526 68 John Freeman
<pre>
527 68 John Freeman
# On branch master
528 68 John Freeman
# Changes to be committed:
529 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
530 68 John Freeman
#
531 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
532 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
533 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
534 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
535 68 John Freeman
#
536 68 John Freeman
</pre>
537 1 John Freeman
* Next, run <pre>git commit -m "<commit message>"</pre>. The commit message should be your three initials followed by a colon, the name of the configuration followed by a colon, and then a brief description of the new configuration, including its name, e.g.:
538 68 John Freeman
<pre>
539 68 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
540 68 John Freeman
</pre>
541 68 John Freeman
Be aware of rules governing strings delimited by double quotes in bash -- i.e., don't try double quoting a word or phrase inside of your commit description. 
542 68 John Freeman
</pre>
543 68 John Freeman
Now, make sure that the commit took place correctly by running
544 68 John Freeman
<pre>
545 68 John Freeman
git diff HEAD
546 1 John Freeman
</pre>
547 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
548 68 John Freeman
<pre>
549 69 John Freeman
git log
550 57 John Freeman
</pre>
551 79 John Freeman
you should be able to see your commit at the top.
552 79 John Freeman
553 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
554 79 John Freeman
<pre>
555 79 John Freeman
git push origin
556 79 John Freeman
</pre>
557 79 John Freeman
558 79 John Freeman
and now, if you run 
559 79 John Freeman
560 79 John Freeman
<pre>
561 1 John Freeman
git diff origin/master
562 132 John Freeman
</pre>
563 132 John Freeman
564 79 John Freeman
you should again see no output. Pushing to the central repository is important as this is essentially the backup area for configurations; if a user accidentally overwrites something in /data/lbnedaq/config, as long as commits have been pushed to the central repository there will still be a saved record of configurations before the overwrites took place. In fact, as of this writing (12/3/14), if either (A) edits have been made to the /data/lbnedaq/config directory since its most recent commit, or (B) that commit hasn't been pushed to the central repository, DAQInterface will refuse to execute the initialize transition.
565 56 Erik Blaufuss
}}
566 49 Erik Blaufuss
567 133 John Freeman
h1. Adding new DAQ Components to RunControl
568 49 Erik Blaufuss
569 49 Erik Blaufuss
{{collapse(Expand for info here…)
570 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
571 18 John Freeman
<pre>
572 55 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
573 55 Erik Blaufuss
</pre>
574 49 Erik Blaufuss
Each entry (name: host port) defines:
575 49 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
576 18 John Freeman
* host - hostname where BoardReader process will be started
577 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
578 49 Erik Blaufuss
579 49 Erik Blaufuss
For example:
580 49 Erik Blaufuss
<pre>
581 49 Erik Blaufuss
component01: lbnedaq2 5205
582 49 Erik Blaufuss
component02: lbnedaq2 5206
583 133 John Freeman
</pre>
584 133 John Freeman
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
585 133 John Freeman
586 27 John Freeman
*Note* that you will need to kill and re-launch RunControl if you add a component
587 49 Erik Blaufuss
}}
588 28 John Freeman
589 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
590 27 John Freeman
591 49 Erik Blaufuss
h2.  Common RunControl issues
592 1 John Freeman
593 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
594 49 Erik Blaufuss
595 49 Erik Blaufuss
<pre>
596 50 Erik Blaufuss
lbnecmd help
597 50 Erik Blaufuss
</pre>
598 1 John Freeman
will list all available commands for RunControl with some details for help.  
599 45 John Freeman
 
600 49 Erik Blaufuss
h3.  No real configurations are listed by RunControl
601 45 John Freeman
602 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
603 49 Erik Blaufuss
<pre>
604 49 Erik Blaufuss
Available configs (Name : description)
605 45 John Freeman
606 49 Erik Blaufuss
dummy : Dummy description
607 1 John Freeman
</pre>
608 168 John Freeman
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running; how to do this, described earlier in the wiki, is simply to execute "lbnecmd check", and launching the configuration manager, also described earlier, can be done via "launch_daq_applications.sh -c"
609 147 John Freeman
610 169 John Freeman
h3. "lbnecmd check" returns "@Unknown exception '<ProtocolError for localhost:50008/RPC2: -1 >'@"
611 170 John Freeman
612 171 John Freeman
This sometimes happens when the TDU XML-RPC server has died. You can confirm this has happened by running "check_daq_applications.sh";  to relaunch it, run "launch_daq_applications.sh -t".
613 169 John Freeman
614 147 John Freeman
h2.  Common DAQInterface issues
615 148 John Freeman
616 148 John Freeman
As a preliminary: if something goes wrong when running the DAQ, there are two valuable sources of information:
617 185 John Freeman
# The pmt logfile(s), containing the output of the artdaq processes (including the output of the art modules run within them -- so, for example, an exception throw from within a module would appear here). Where to find these logfiles is described in the section "Examining your output", earlier in this wiki. 
618 146 John Freeman
# The RunControl logfile, /home/lbnedaq/.lbnerc.log . This contains both the information sent from DAQInterface to RunControl, as well as diagnostic logging (such as the traceback of exception throws within DAQInterface)
619 146 John Freeman
620 173 John Freeman
In general, when something goes wrong during the running of the DAQ -- e.g., an artdaq process dies, or a sync pulse is attempted when the TDU XML-RPC server isn't alive -- DAQInterface will impose upon itself the "recovery" transition, where it returns itself to the "stopped" state regardless of whatever state it may have currently been in. When this occurs, you'll see something like the following:
621 173 John Freeman
<pre>
622 173 John Freeman
DAQInterface: "Recover" transition underway
623 173 John Freeman
JCF, 6/12/14 -- for now at least, "Recover" simply kills the artdaq processes
624 173 John Freeman
625 173 John Freeman
Recover transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
626 173 John Freeman
</pre>
627 173 John Freeman
628 175 John Freeman
If a recovery transition occurs, often you can begin using the DAQ again (starting with "lbnecmd init daq") without any issues. However, some issues may be persistent, or require manual intervention. A subset of those issues are described below. If any new ones come up, please contact John Freeman at jcfree@fnal.gov. 
629 173 John Freeman
630 184 John Freeman
h3. *On the initialize transition ("lbnecmd init daq") you see "Unclean working configuration directory /data/lbnedaq/config/ found"*
631 184 John Freeman
632 184 John Freeman
This means that /data/lbnedaq/config has been worked on without commits being made. If you're not using the generic DAQInterface configuration file "config.txt", but rather, have your own copy, you can set "disable configuration check: true" to sidestep this error. This is NOT recommended during standard physics running, but is OK if you're in commissioning. Or, you can either commit the changes (if they were yours) or contact John Freeman, jcfree@fnal.gov, describing the situation. 
633 184 John Freeman
634 184 John Freeman
h3. *On the initialize transition, you see "<code>pmt.rb -p <port number> was already running on <hostname></code>"*
635 146 John Freeman
636 164 John Freeman
An instance of artdaq's Process Management Tool program, tasked with creating the artdaq processes, is already running on the host and port you've requested for it in the DAQInterface configuration file passed to the DAQInterface application. This can happen if, for example, the DAQInterface program from a previous session was killed off before the usual "lbnecmd terminate daq" transition was issued, a transition which prompts DAQInterface to kill off the pmt.rb process it has control over. Generally, DAQInterface will clean this up and free the port in the process of returning itself to the "stopped" state, but in case it doesn't, there's a script called "kill_artdaq_processes.sh" which can be used in the following manner:
637 146 John Freeman
<pre>
638 146 John Freeman
kill_artdaq_processes.sh <pmt host> <pmt port>
639 149 John Freeman
</pre>
640 146 John Freeman
641 146 John Freeman
This script will both kill off the pmt.rb which is clogging the port, as well as the artdaq processes over which it has control.
642 146 John Freeman
643 180 John Freeman
h3. *On the initialize transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
644 1 John Freeman
645 1 John Freeman
If a "Recover" is triggered and you can see via "lbnecmd check" that DAQInterface is in the "stopped" state, try initializing again. If that doesn't work, you can try increasing the value of the "pause before initialization" variable in the DAQInterface configuration file. Empirically, it appears there needs to be a pause of at least 5 seconds before the FHiCL documents can be successfully sent via XML-RPC to the processes; increasing this value may make it less likely that the "Connection refused" error occurs.
646 180 John Freeman
647 180 John Freeman
h3. *On the start transition ("lbnecmd start daq"), you see "@TDU RESULT: socket.error caught: [Errno 111] Connection refused    Is the XMLRPC server up?@"*
648 180 John Freeman
649 180 John Freeman
This error will trigger the Recover transition and return you to the stopped state. What it means is that there was an issue connecting to the TDU XML-RPC server (most likely, it wasn't running). Run "lbnecmd check" to see whether it's available; if not, launch it in the usual fashion (i.e., "launch_daq_applications.sh -t"), and then proceed with the standard DAQ transition sequence ("lbnecmd init daq", etc.)
650 146 John Freeman
651 146 John Freeman
h3. *Regardless of how high the debug level is set to, you don't see any output to screen when you issue transitions to DAQInterface*
652 146 John Freeman
653 182 John Freeman
Chances are that DAQInterface was started in another terminal, and consequently, it's in that terminal where output will appear. If DAQInterface was started via the "launch_daq_applications.sh" script, then as of May-5-2015, all output is directed to /data/lbnedaq/daqlogs/daqinterface/DI.log, so running "tail -f  /data/lbnedaq/daqlogs/daqinterface/DI.log" from another terminal will guarantee you can see DAQInterface output in real time. Please note this file is appended to, not overwritten, so only the end of the file will be of interest. 
654 1 John Freeman
655 1 John Freeman
{{collapse(Of developer interest)
656 1 John Freeman
h3.  *Error handling*
657 1 John Freeman
658 1 John Freeman
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
659 1 John Freeman
# An artdaq process returns an error state after a transition request, or an exception is thrown by the XML-RPC library during the request
660 1 John Freeman
# During periodic checks, one or more artdaq processes expected to exist are not found
661 51 John Freeman
662 84 John Freeman
In either case, an error is reported via 0MQ to RunControl, and the "Recover" transition is automatically triggered. This transition is a fairly blunt instrument: it will kill any remaining artdaq processes and return DAQInterface to its original state of "stopped" (i.e., one in which it requires the "init" transition before anything else is done). 
663 77 John Freeman
664 77 John Freeman
h3. *Your change to the DAQInterface configuration file or the daqinterface.py code doesn't seem to do anything*
665 1 John Freeman
666 146 John Freeman
Make sure you kill the existing daqinterface process and restart it
667 1 John Freeman
668 1 John Freeman
}}
669 183 John Freeman
670 183 John Freeman
h2. Common lbne-artdaq issues
671 183 John Freeman
672 183 John Freeman
h3. The message "Failed to connect to shared memory segment" appears in the logfile
673 183 John Freeman
674 183 John Freeman
The full message is "<code>Failed to connect to shared memory segment, errno = 22.  Please check if a stale shared memory segment needs to be cleaned up. (ipcs, ipcrm -m <segId>)</code>". Go to the system on which the process that issued the message is running (e.g., if it was an AggregatorMain process on lbnedaq2, go there) and run <code>ipcs</code>. You should see something like the following:
675 183 John Freeman
<pre>
676 183 John Freeman
------ Shared Memory Segments --------
677 183 John Freeman
key        shmid      owner      perms      bytes      nattch     status      
678 183 John Freeman
0x40471518 4161536    lbnedaq    666        16777216   0          
679 183 John Freeman
</pre>
680 183 John Freeman
This is the offending memory segment. To remove it, run the following (where here, we'll assume it's the one with shared memory ID 4161536, above-- of course you'll most likely see a different ID): <code>ipcrm -m  4161536</code>. Now, if you run <code>ipcs</code> again, the segment should not be listed; furthermore, the error should not appear again if you run again with the DAQ.