Project

General

Profile

Running DAQ Interface » History » Version 123

John Freeman, 03/25/2015 12:22 PM

1 123 John Freeman
* UNDER REVISION AS OF 12:00 PM CDT, MARCH 25 -- PLEASE CONTACT JOHN FREEMAN, jcfree@fnal.gov, FOR MORE INFO
2 122 John Freeman
3 122 John Freeman
4 58 John Freeman
{{toc}}
5 58 John Freeman
6 96 John Freeman
!DAQ_communication_diagram4.png!
7 96 John Freeman
8 49 Erik Blaufuss
h1. Getting help
9 1 John Freeman
10 78 John Freeman
If, after reading this document (in particular, the "Troubleshooting and FAQ" section) you run into issues, or have questions, please contact:
11 49 Erik Blaufuss
* DAQInterface
12 49 Erik Blaufuss
** John Freeman - jcfree@fnal.gov
13 62 John Freeman
* RunControl
14 49 Erik Blaufuss
** Erik Blaufuss - blaufuss@icecube.umd.edu
15 66 John Freeman
* Configuration Manager
16 1 John Freeman
** Jon Paley - jpaley@anl.gov
17 123 John Freeman
* TDU XML-RPC server
18 123 John Freeman
** Tom Dealtry - thomas.dealtry@physics.ox.ac.uk
19 1 John Freeman
20 102 Erik Blaufuss
h1. Logbook
21 102 Erik Blaufuss
22 102 Erik Blaufuss
Please document all changes, software updates, and operational activities to the ELog:
23 102 Erik Blaufuss
24 102 Erik Blaufuss
http://dbweb3.fnal.gov:8080/ECL/lbne_35t
25 120 John Freeman
26 1 John Freeman
h1. Brief preliminaries
27 1 John Freeman
28 123 John Freeman
This guide assumes you have access to 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, etc.). 
29 49 Erik Blaufuss
30 123 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. To get started, login and first setup the environment:
31 1 John Freeman
32 1 John Freeman
<pre>
33 1 John Freeman
ssh lbnedaq@lbne35t-gateway01.fnal.gov
34 1 John Freeman
cd /data/lbnedaq/daqarea
35 1 John Freeman
source fireup
36 1 John Freeman
</pre>
37 1 John Freeman
38 123 John Freeman
This will take you into the /data/lbnedaq/daqarea/lbnerc directory, out of which the DAQ is controlled. 
39 123 John Freeman
40 123 John Freeman
Finally, when you see a <pre>…</pre> in example output, that is to be interpreted as a placeholder for output which is considered irrelevant to the point being explained.
41 123 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 123 John Freeman
** DAQInterface needs to be launched _after_ RunControl, and unlike the other applications, if a DAQInterface process is already found to be running on login, it shouldn't be used, but rather, killed and restarted (unless someone is actively using the DAQ already, of course)
47 123 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 123 John Freeman
49 123 John Freeman
In order to determine which DAQ applications are already running, use the following command:
50 1 John Freeman
51 1 John Freeman
<pre>
52 49 Erik Blaufuss
lbnecmd check
53 1 John Freeman
</pre>
54 1 John Freeman
55 61 John Freeman
This will display the current state of DAQInterface and RunControl. The example below shows that both RunControl and DAQInterface are running, but the DAQ run is in the stopped state:
56 49 Erik Blaufuss
<pre>
57 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
58 49 Erik Blaufuss
lbnecontrol: running
59 49 Erik Blaufuss
daqint@localhost:5770 (synchronous): stopped
60 49 Erik Blaufuss
</pre>
61 1 John Freeman
62 73 John Freeman
If RunControl is running, and at some point DAQInterface was running but has since been killed:
63 73 John Freeman
<pre>
64 73 John Freeman
lbnecontrol: running
65 73 John Freeman
daqint@localhost:5770 (synchronous): missing
66 73 John Freeman
</pre>
67 91 John Freeman
(In this case, just restart DAQInterface -- how to do this is described shortly).
68 73 John Freeman
69 49 Erik Blaufuss
If RunControl is not running, you'll see something like:
70 1 John Freeman
<pre>
71 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
72 49 Erik Blaufuss
check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?
73 1 John Freeman
</pre>
74 1 John Freeman
75 61 John Freeman
To check whether the configuration manager is running, you can simply use Linux commands:
76 61 John Freeman
77 61 John Freeman
<pre>
78 61 John Freeman
ps aux | grep -v grep | grep CfgMgrApp
79 61 John Freeman
</pre>
80 61 John Freeman
81 109 Thomas Dealtry
This will either return info on CfgMgrApp (the actual name of the configuration manager process), or print nothing if it's not running. Similarly, you can check whether the TDU XMLRPC server is running using:
82 71 John Freeman
83 71 John Freeman
<pre>
84 109 Thomas Dealtry
ps aux | grep -v grep | grep tdu
85 1 John Freeman
</pre>
86 1 John Freeman
87 109 Thomas Dealtry
In fact, it's possible to use Linux commands to check the status of all four programs:
88 109 Thomas Dealtry
89 109 Thomas Dealtry
<pre>
90 109 Thomas Dealtry
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
91 109 Thomas Dealtry
</pre>
92 109 Thomas Dealtry
93 110 John Freeman
If you wish to kill any of these processes (described in the next section), the PID (process ID) to use is supplied as the second field in each row returned by the "ps aux" command.
94 105 John Freeman
95 109 Thomas Dealtry
h3. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
96 105 John Freeman
97 105 John Freeman
To begin using the DAQ, you'll want to kill off any existing RunControl and/or DAQInterface processes. With the process IDs obtained from the command described in the previous section, you can kill any pre-existing such processes. Keep in mind, of course, that if these processes are running, it might mean that someone else is using the DAQ, or that someone else who's done using it forgot to clean up. 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. To kill them, again keeping in mind that the second field returned from "ps aux" is the process id (PID), use:
98 105 John Freeman
<pre>
99 105 John Freeman
kill <PID>
100 105 John Freeman
</pre>
101 110 John Freeman
If DAQInterface was in any state other than "stopped" at the time it was killed, it's quite possible that it's left "orphaned" artdaq processes. If this is the case, you'll want to clean these up before trying to run the DAQ again, as they'll block the ports if they remain alive as "zombie" processes. Check the DAQInterface configuration file (defaults to lbnerc/docs/config.txt unless an alternate was supplied via the "-f" option to DAQInterface) to see which node the PMT (Process Management Tool) was running on, and check for it with
102 105 John Freeman
<pre>
103 105 John Freeman
ps aux | grep -v grep | grep pmt.rb
104 105 John Freeman
</pre>
105 105 John Freeman
Use this to get the process ID to kill it. Of course, also be aware that if artdaq processes were in communication with hardware when the orphaning occurred, killing them off might result in issues for the hardware, but the specifics of any hardware issues that may arise go beyond the scope of this document.
106 105 John Freeman
107 1 John Freeman
h3. Starting RunControl
108 49 Erik Blaufuss
109 49 Erik Blaufuss
To start RunControl (after loading environment as above):
110 60 John Freeman
<pre>
111 104 John Freeman
rm -f /tmp/lbnecontrol.pid  # (This should only be necessary if RunControl software wasn't stopped cleanly)
112 49 Erik Blaufuss
lbnecmd launch
113 49 Erik Blaufuss
</pre>
114 1 John Freeman
115 1 John Freeman
h3. Starting DAQInterface
116 1 John Freeman
117 61 John Freeman
To start DAQInterface (after loading environment as above), the basic command is:
118 1 John Freeman
<pre>
119 82 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
120 1 John Freeman
</pre>
121 82 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. 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 "Configuring DAQInterface" for more. 
122 82 John Freeman
123 82 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
124 1 John Freeman
<pre>
125 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
126 1 John Freeman
</pre>
127 91 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)
128 82 John Freeman
129 1 John Freeman
h3. Starting the configuration manager
130 1 John Freeman
131 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
132 109 Thomas Dealtry
133 109 Thomas Dealtry
h3. Starting the TDU XMLRPC server
134 109 Thomas Dealtry
135 109 Thomas Dealtry
<pre>
136 109 Thomas Dealtry
tdu -T 192.168.100.201 -P 10001 -H localhost -r 50008
137 109 Thomas Dealtry
</pre>
138 109 Thomas Dealtry
139 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.
140 109 Thomas Dealtry
141 109 Thomas Dealtry
See [[Starting and using TDUControl]] for more details.
142 62 John Freeman
143 61 John Freeman
h1. Configuring and starting Runs
144 1 John Freeman
145 107 John Freeman
Now, you can take the DAQ system through the standard transitions to start a DAQ run.  At all stages, you can use the "lbnecmd check" command to see what state DAQInterface is in; 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:
146 49 Erik Blaufuss
<pre>
147 49 Erik Blaufuss
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
148 1 John Freeman
</pre>
149 108 John Freeman
Note that if a high "debug level" has been set (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. Described in more detail later, the chain of states (in quotes) and transitions (in italics) in the DAQ system can be represented as follows:
150 1 John Freeman
151 108 John Freeman
---
152 108 John Freeman
153 117 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "ready" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
154 108 John Freeman
155 108 John Freeman
---
156 1 John Freeman
157 94 John Freeman
h2.  Selecting a run configuration and DAQ components
158 49 Erik Blaufuss
159 1 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQComponents must be selected.  This is done via RunControl.
160 1 John Freeman
161 49 Erik Blaufuss
h3. List and select a configuration:
162 1 John Freeman
163 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
164 49 Erik Blaufuss
<pre>
165 49 Erik Blaufuss
lbnecmd listconfigs
166 1 John Freeman
</pre>
167 49 Erik Blaufuss
Will return a list of configs:
168 49 Erik Blaufuss
<pre>
169 49 Erik Blaufuss
Available configs (Name : description)
170 1 John Freeman
171 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
172 111 John Freeman
6xssp_ext : Sorry, no description found.
173 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
174 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
175 30 John Freeman
...
176 1 John Freeman
177 49 Erik Blaufuss
Current selected config: No Config
178 49 Erik Blaufuss
</pre>
179 111 John Freeman
This lists all available configs, as well as the current selected config (Note, default config is "No Config").  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:
180 49 Erik Blaufuss
<pre> 
181 49 Erik Blaufuss
lbnecmd setconfig demo
182 1 John Freeman
</pre>
183 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.
184 1 John Freeman
185 49 Erik Blaufuss
h3. List and select DAQ components.
186 1 John Freeman
187 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
188 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.
189 38 John Freeman
190 1 John Freeman
To see the list of available DAQ components:
191 49 Erik Blaufuss
<pre>
192 1 John Freeman
lbnecmd listdaqcomps
193 49 Erik Blaufuss
</pre>
194 62 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
195 1 John Freeman
<pre>
196 112 John Freeman
Available:
197 112 John Freeman
component01 (lbnedaq2:5205)
198 112 John Freeman
component02 (lbnedaq2:5206)
199 112 John Freeman
200 112 John Freeman
ssp08 (lbnedaq1:5214)
201 112 John Freeman
202 112 John Freeman
Selected:
203 112 John Freeman
component01 (lbnedaq2:5205)
204 112 John Freeman
component02 (lbnedaq2:5206)
205 112 John Freeman
206 112 John Freeman
ssp08 (lbnedaq1:5214)
207 62 John Freeman
</pre>
208 113 John Freeman
The components are shown by name, along with the requested host/port to run the BoardReaderMain process on. You can then select a list of DAQ components to use in the run:
209 1 John Freeman
<pre>
210 118 John Freeman
lbnecmd setdaqcomps component0{1,2}
211 49 Erik Blaufuss
</pre>
212 118 John Freeman
(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 compnents are not known, an error is returned.
213 49 Erik Blaufuss
To change the list of available components, see below.
214 29 John Freeman
215 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
216 1 John Freeman
217 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:
218 1 John Freeman
<pre>
219 49 Erik Blaufuss
lbnecmd check
220 1 John Freeman
</pre>
221 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.
222 1 John Freeman
223 92 John Freeman
First, take DAQInterface from the "stopped" to the "ready" state; this will create the artdaq processes on the hosts you selected (DAQ components), and initialize them with the FHiCL documents:
224 1 John Freeman
<pre>
225 1 John Freeman
lbnecmd init daq
226 1 John Freeman
</pre>
227 1 John Freeman
228 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
229 29 John Freeman
<pre>
230 1 John Freeman
lbnecmd start daq
231 29 John Freeman
</pre>
232 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
233 49 Erik Blaufuss
<pre>
234 49 Erik Blaufuss
lbnecmd check
235 49 Erik Blaufuss
lbnecontrol: running
236 49 Erik Blaufuss
Run number: 207
237 49 Erik Blaufuss
Run configuration: demo
238 1 John Freeman
239 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
240 49 Erik Blaufuss
</pre>
241 49 Erik Blaufuss
242 49 Erik Blaufuss
Pause the running of the DAQ, putting DAQInterface into the "paused" state.  This will cause the current open output file to be closed and given a name reflecting the current run number:
243 22 John Freeman
<pre>
244 21 John Freeman
lbnecmd pause daq
245 42 John Freeman
</pre>
246 41 John Freeman
247 1 John Freeman
Resume the running of the DAQ, putting returning to the "running" state.  This will restart data taking to a new output file:
248 48 John Freeman
<pre>
249 48 John Freeman
lbnecmd resume daq
250 48 John Freeman
</pre>
251 48 John Freeman
252 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
253 48 John Freeman
<pre>
254 48 John Freeman
lbnecmd stop daq
255 49 Erik Blaufuss
</pre>
256 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
257 62 John Freeman
*NOTE* To select a new configuration or DAQ component set, you must kill all ArtDAQ processes and return DAQInterface to its "stopped" state with the "terminate" command:
258 1 John Freeman
259 1 John Freeman
<pre>
260 1 John Freeman
lbnecmd terminate daq
261 1 John Freeman
</pre>
262 67 Erik Blaufuss
263 67 Erik Blaufuss
If you want to stop all RunControl processes (known as "lbnecontrol"):
264 67 Erik Blaufuss
<pre>
265 67 Erik Blaufuss
lbnecmd kill
266 67 Erik Blaufuss
</pre>
267 67 Erik Blaufuss
After this, you will need to relaunch RunControl as above.
268 1 John Freeman
269 49 Erik Blaufuss
h2. After your DAQ run.
270 1 John Freeman
271 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
272 48 John Freeman
273 76 John Freeman
h3. The DAQ log
274 76 John Freeman
275 114 John Freeman
A record of the DAQ's output will be saved in the subdirectory pmt/ relative to where you specified the output logfiles; thus given the "log directory" setting in the example DAQInterface configuration file below, you'd find the output in /data/lbnedaq/daqlogs/pmt/.
276 76 John Freeman
277 76 John Freeman
h3. The run record
278 76 John Freeman
279 91 John Freeman
Also, a record of the FHiCL documents sent to the artdaq processes, the configuration file used to control DAQInterface, and some further information will have been saved; as of this writing (12/3/14) the directory in which this can be found defaults to /data/lbnedaq/run_records/<run number>. 
280 92 John Freeman
** PLEASE NOTE that there may be slight differences between the saved FHiCL documents and the FHiCL documents specified in the DAQInterface configuration file (those that control the EventBuilderMain processes) and the run configuration (those that control the BoardReaderMain and AggregatorMain processes). The saved FHiCL document name is standardized to <processtype>_<host>_<port>_r<run number>.fcl, so, e.g, "EventBuilder_lbnedaq2_5235_r286.fcl" would be the saved name of /data/lbnedaq/fcl/EventBuilder_demo1.fcl, listed in the example DAQInterface configuration file above, assuming datataking was performed in run 286. 
281 1 John Freeman
** More importantly, the FHiCL document actually sent to the artdaq process may be slightly different than the FHiCL document provided for DAQInterface; 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). It is this post-bookkeeping FHiCL document which actually gets sent to the processes which gets saved to the output directory. 
282 115 John Freeman
** The "further information" mentioned above is stored in a file of the form "metadata_r<run number>.txt"; it includes the configuration chosen for the run, the components used, as well as the commit hashes for the lbne-artdaq, lbnerc, and configuration directory used. Also provided are the process management tool (PMT) and individual artdaq process logs; please note that as of this writing (3/19/15), while the algorithm used to determine these logs hasn't yet been incorrect, there are in-principle edge cases in which the wrong log could be provided, so be aware -- and in particular, check the line "Started run <runnumber>" in the PMT logfile for confirmation that you have what you want. 
283 115 John Freeman
284 119 John Freeman
As an example, in /data/lbnedaq/run_records/778 (the directory for run 778), the metadata file looks like the following:
285 72 John Freeman
<pre>
286 72 John Freeman
Config name: demo
287 72 John Freeman
Component #0: component01
288 1 John Freeman
Component #1: component02
289 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
290 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
291 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
292 114 John Freeman
293 114 John Freeman
294 119 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
295 114 John Freeman
296 1 John Freeman
boardreader logfiles: 
297 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37365.log
298 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37366.log
299 114 John Freeman
300 114 John Freeman
eventbuilder logfiles: 
301 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37364.log
302 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37363.log
303 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37368.log
304 114 John Freeman
305 114 John Freeman
aggregator logfiles: 
306 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37369.log
307 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37367.log
308 119 John Freeman
309 1 John Freeman
</pre>
310 76 John Freeman
311 81 John Freeman
h3. Output of the Art modules
312 76 John Freeman
313 81 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. The other AggregatorMain typically will run other RootOutput 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.
314 76 John Freeman
315 76 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:
316 76 John Freeman
317 76 John Freeman
<pre>
318 76 John Freeman
cd <lbne-artdaq basedir>
319 76 John Freeman
source setupLBNEARTDAQ
320 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
321 76 John Freeman
</pre>
322 76 John Freeman
323 76 John Freeman
where here, <lbne-artdaq basedir> is the parent directory of the lbne-artdaq package, <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. The output of this command will look something like the following:
324 76 John Freeman
325 76 John Freeman
<pre>
326 81 John Freeman
%MSG-i MF_INIT_OK:  art 01-Dec-2014 16:13:59 CST JobSetup 
327 76 John Freeman
Messagelogger initialization complete.
328 76 John Freeman
%MSG
329 81 John Freeman
%MSG-i PathConfiguration:  art 01-Dec-2014 16:14:00 CST JobSetup 
330 76 John Freeman
Multiple end paths have been combined into one end path,
331 76 John Freeman
"end_path" since order is irrelevant.
332 76 John Freeman
333 76 John Freeman
%MSG
334 81 John Freeman
01-Dec-2014 16:14:00 CST  Initiating request to open file /tmp/lbne35t_r000270_sr01_20141201T221127.root
335 81 John Freeman
01-Dec-2014 16:14:00 CST  Successfully opened file /tmp/lbne35t_r000270_sr01_20141201T221127.root
336 1 John Freeman
--------------------------------------------------------------
337 76 John Freeman
Package             |Version             |Timestamp           
338 81 John Freeman
artdaq-core         |v1_04_06            |01-Dec-2014 21:59:51 UTC
339 81 John Freeman
artdaq              |v1_12_04            |01-Dec-2014 22:01:57 UTC
340 81 John Freeman
lbne-artdaq         |v0_00_08            |01-Dec-2014 22:00:18 UTC
341 81 John Freeman
lbne-artdaq         |v0_07_00            |01-Dec-2014 22:02:57 UTC
342 76 John Freeman
--------------------------------------------------------------
343 81 John Freeman
Begin processing the 1st record. run: 270 subRun: 1 event: 1 at 01-Dec-2014 16:14:00 CST
344 76 John Freeman
PROCESS NAME | MODULE LABEL.. | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE............ | PRODUCT FRIENDLY TYPE | SIZE
345 81 John Freeman
DAQ......... | daq........... | TOY1................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...2
346 1 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
347 76 John Freeman
348 81 John Freeman
Total products (present, not present): 8 (2, 6).
349 76 John Freeman
350 1 John Freeman
PROCESS NAME | MODULE LABEL | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE.................... | PRODUCT FRIENDLY TYPE.... | SIZE
351 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
352 76 John Freeman
353 76 John Freeman
Total products (present, not present): 1 (1, 0).
354 76 John Freeman
355 81 John Freeman
01-Dec-2014 16:14:00 CST  Closed file /tmp/lbne35t_r000270_sr01_20141201T221127.root
356 76 John Freeman
357 76 John Freeman
TrigReport ---------- Event  Summary ------------
358 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
359 76 John Freeman
360 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
361 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
362 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
363 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
364 76 John Freeman
365 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
366 1 John Freeman
TimeReport CPU = 0.003361 Real = 0.003000
367 1 John Freeman
368 76 John Freeman
Art has completed and will exit with status 0.
369 76 John Freeman
</pre>
370 76 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 two fragments of type TOY1, produced by the ToySimulator fragment generator. Finally, a listing of passed 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.
371 81 John Freeman
372 84 John Freeman
h1. Configuring DAQInterface: the DAQInterface configuration file
373 91 John Freeman
374 92 John Freeman
DAQInterface has 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  location and ports for artdaq processes, location of lbne-artdaq software, debug (log) level, etc). These can be changed before the DAQInterface process is started. It's expected that for normal operations, these 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, found in docs/config.txt (relative to /data/lbnedaq/daqarea/lbnerc); it should look something like the following:
375 1 John Freeman
<pre>
376 1 John Freeman
377 100 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
378 91 John Freeman
379 1 John Freeman
PMT host: lbnedaq3
380 100 John Freeman
PMT port: 5400
381 1 John Freeman
382 49 Erik Blaufuss
pause before initialization: 5
383 49 Erik Blaufuss
384 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
385 49 Erik Blaufuss
debug level: 1
386 49 Erik Blaufuss
387 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
388 49 Erik Blaufuss
389 91 John Freeman
record directory: /data/lbnedaq/run_records
390 49 Erik Blaufuss
391 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
392 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
393 116 John Freeman
# set "disable configuration check" to "true"
394 116 John Freeman
395 101 John Freeman
disable configuration check: false
396 101 John Freeman
397 101 John Freeman
TDU XMLRPC port: 0
398 91 John Freeman
399 91 John Freeman
EventBuilder host: lbnedaq2
400 48 John Freeman
EventBuilder port: 5235
401 91 John Freeman
402 91 John Freeman
EventBuilder host: lbnedaq2
403 91 John Freeman
EventBuilder port: 5236
404 48 John Freeman
405 91 John Freeman
Aggregator host: lbnedaq2
406 91 John Freeman
Aggregator port: 5265
407 48 John Freeman
408 91 John Freeman
Aggregator host: lbnedaq2
409 1 John Freeman
Aggregator port: 5266
410 1 John Freeman
411 1 John Freeman
</pre>
412 1 John Freeman
413 92 John Freeman
The meaning of these parameters is as follows:
414 92 John Freeman
415 92 John Freeman
* *lbne-artdaq* : the directory in which the desired build of lbne-artdaq to use is located
416 92 John Freeman
417 1 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
418 100 John Freeman
* *PMT port* : pmt.rb's port
419 92 John Freeman
420 92 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
421 1 John Freeman
422 92 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. 
423 92 John Freeman
424 116 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/
425 93 John Freeman
426 93 John Freeman
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
427 101 John Freeman
428 1 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. 
429 101 John Freeman
430 101 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
431 49 Erik Blaufuss
432 116 John Freeman
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.
433 49 Erik Blaufuss
434 57 John Freeman
h1. Adding new configurations to RunControl
435 57 John Freeman
436 68 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. 
437 68 John Freeman
438 91 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
439 57 John Freeman
<pre>
440 57 John Freeman
/data/lbnedaq/config/<named_configuration>
441 57 John Freeman
</pre>
442 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
443 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
444 57 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")
445 59 John Freeman
446 59 John Freeman
There are existing examples of configurations currently within /data/lbnedaq/config which can be studied (and even copied) for further guidance; however, please disregard the "tmp1" and "tmp2" configurations. Note that the FHiCL documents in these directories contain some variables which are set to "PLACEHOLDER", e.g.
447 59 John Freeman
<pre>
448 1 John Freeman
 event_builder_count: PLACEHOLDER
449 59 John Freeman
</pre>
450 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.
451 1 John Freeman
452 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
453 68 John Freeman
<pre>
454 68 John Freeman
git log
455 68 John Freeman
</pre>
456 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:
457 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:
458 68 John Freeman
<pre>
459 68 John Freeman
# On branch master
460 68 John Freeman
# Changes to be committed:
461 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
462 68 John Freeman
#
463 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
464 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
465 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
466 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
467 68 John Freeman
#
468 68 John Freeman
</pre>
469 68 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.:
470 68 John Freeman
<pre>
471 1 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
472 68 John Freeman
</pre>
473 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. 
474 68 John Freeman
</pre>
475 68 John Freeman
Now, make sure that the commit took place correctly by running
476 68 John Freeman
<pre>
477 68 John Freeman
git diff HEAD
478 68 John Freeman
</pre>
479 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
480 1 John Freeman
<pre>
481 68 John Freeman
git log
482 68 John Freeman
</pre>
483 69 John Freeman
you should be able to see your commit at the top.
484 57 John Freeman
485 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
486 79 John Freeman
<pre>
487 79 John Freeman
git push origin
488 79 John Freeman
</pre>
489 79 John Freeman
490 79 John Freeman
and now, if you run 
491 79 John Freeman
492 79 John Freeman
<pre>
493 79 John Freeman
git diff origin/master
494 79 John Freeman
</pre>
495 79 John Freeman
496 91 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. 
497 79 John Freeman
498 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
499 49 Erik Blaufuss
500 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
501 49 Erik Blaufuss
<pre>
502 49 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
503 18 John Freeman
</pre>
504 55 Erik Blaufuss
Each entry (name: host port) defines:
505 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
506 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
507 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
508 18 John Freeman
509 49 Erik Blaufuss
For example:
510 49 Erik Blaufuss
<pre>
511 49 Erik Blaufuss
component01: lbnedaq2 5205
512 49 Erik Blaufuss
component02: lbnedaq2 5206
513 49 Erik Blaufuss
</pre>
514 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
515 27 John Freeman
516 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
517 28 John Freeman
518 49 Erik Blaufuss
h2.  Common RunControl issues
519 27 John Freeman
520 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
521 1 John Freeman
522 49 Erik Blaufuss
<pre>
523 49 Erik Blaufuss
lbnecmd help
524 49 Erik Blaufuss
</pre>
525 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
526 50 Erik Blaufuss
 
527 1 John Freeman
h3.  No real configurations are listed by RunControl
528 45 John Freeman
529 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
530 45 John Freeman
<pre>
531 49 Erik Blaufuss
Available configs (Name : description)
532 49 Erik Blaufuss
533 49 Erik Blaufuss
dummy : Dummy description
534 45 John Freeman
</pre>
535 49 Erik Blaufuss
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running (https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki/Wiki)
536 1 John Freeman
537 49 Erik Blaufuss
h2.  Common DAQInterface issues
538 49 Erik Blaufuss
539 49 Erik Blaufuss
h3.  *Error handling*
540 49 Erik Blaufuss
541 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
542 49 Erik Blaufuss
# An artdaq process returns an error state after a transition request, or an exception is thrown by the XML-RPC library during the request
543 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
544 49 Erik Blaufuss
545 49 Erik Blaufuss
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). 
546 49 Erik Blaufuss
547 84 John Freeman
h3. *Your change to the DAQInterface configuration file or the daqinterface.py code doesn't seem to do anything*
548 49 Erik Blaufuss
549 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
550 49 Erik Blaufuss
551 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
552 49 Erik Blaufuss
553 91 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.
554 54 John Freeman
555 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
556 1 John Freeman
557 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
558 1 John Freeman
<pre>
559 1 John Freeman
Waiting for all processes to be launched; if zombie pmt.rb is running on localhost please kill it and this program (PID 31820)
560 1 John Freeman
</pre>
561 1 John Freeman
keeps getting output to screen, it means there's a problem initializing. In this case, the current (11/12/14) course of action is to externally kill DAQInterface using the PID listed; also, it's possible that there may already be a pmt.rb executable running on the desired host, blocking the launch of a new one due to a port conflict, in which case you should log onto the host (assuming you're not already on it), and run 
562 1 John Freeman
<pre>
563 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
564 51 John Freeman
</pre>
565 84 John Freeman
to see if this is the case. If it's not and you can't think of what might be wrong (is the configuration manager running? have you double-checked the DAQInterface configuration file?), then try increasing the debug level in the DAQInterface configuration file for your next run-through, as this will likely shed light on the nature of the problem.
566 77 John Freeman
567 77 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*
568 1 John Freeman
569 79 John Freeman
Chances are that DAQInterface was started in another terminal, and consequently, it's in that terminal where output will appear. This issue can be circumvented by redirecting DAQInterface output into a file; how this can be accomplished is described elsewhere in this document.