Project

General

Profile

Running DAQ Interface » History » Version 124

John Freeman, 03/25/2015 12:41 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 124 John Freeman
This will display the current state of DAQInterface and RunControl. For example:
56 49 Erik Blaufuss
<pre>
57 1 John Freeman
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
58 124 John Freeman
lbnecontrol: Available
59 124 John Freeman
CfgMgr: **Not Found**
60 124 John Freeman
DAQInterface: Available
61 124 John Freeman
TDUControl: **Not Found**
62 124 John Freeman
...
63 1 John Freeman
</pre>
64 91 John Freeman
65 124 John Freeman
Here, you see that RunControl and DAQInterface already exist, but the configuration manager and the TDU's XML-RPC server do not. In this case, you would not only want to launch the configuration manager and the server, but you would also want to kill and relaunch DAQInterface (again, assuming no-one else was actively using it). How to kill and launch applications will now be described...
66 49 Erik Blaufuss
67 124 John Freeman
68 49 Erik Blaufuss
<pre>
69 124 John Freeman
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
70 1 John Freeman
</pre>
71 1 John Freeman
72 124 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.
73 61 John Freeman
74 124 John Freeman
h2. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
75 1 John Freeman
76 124 John Freeman
Killing RunControl has its own special syntax, and is simply:
77 1 John Freeman
78 109 Thomas Dealtry
<pre>
79 124 John Freeman
lbnecmd kill
80 1 John Freeman
</pre>
81 105 John Freeman
82 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:
83 105 John Freeman
84 105 John Freeman
<pre>
85 124 John Freeman
ps aux | grep -v grep | grep -v emacs | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
86 105 John Freeman
</pre>
87 110 John Freeman
88 124 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, 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. 
89 105 John Freeman
90 124 John Freeman
h2. Launching RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
91 105 John Freeman
92 124 John Freeman
h3. Launching RunControl
93 49 Erik Blaufuss
94 49 Erik Blaufuss
<pre>
95 124 John Freeman
rm -f /tmp/lbnecontrol.pid  # (This should only be necessary if last RunControl session wasn't killed via "lbnecmd kill")
96 49 Erik Blaufuss
lbnecmd launch
97 1 John Freeman
</pre>
98 1 John Freeman
99 124 John Freeman
h3. Launching DAQInterface
100 61 John Freeman
101 1 John Freeman
<pre>
102 82 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
103 1 John Freeman
</pre>
104 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. 
105 82 John Freeman
106 82 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
107 1 John Freeman
<pre>
108 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
109 1 John Freeman
</pre>
110 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)
111 82 John Freeman
112 124 John Freeman
h3. Launching the configuration manager
113 1 John Freeman
114 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
115 109 Thomas Dealtry
116 124 John Freeman
h3. Launching the TDU XMLRPC server
117 109 Thomas Dealtry
118 109 Thomas Dealtry
<pre>
119 124 John Freeman
tdu -T 192.168.100.201 -P 10001 -H localhost -r 50008 &
120 109 Thomas Dealtry
</pre>
121 109 Thomas Dealtry
122 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.
123 109 Thomas Dealtry
124 109 Thomas Dealtry
See [[Starting and using TDUControl]] for more details.
125 62 John Freeman
126 61 John Freeman
h1. Configuring and starting Runs
127 1 John Freeman
128 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:
129 49 Erik Blaufuss
<pre>
130 49 Erik Blaufuss
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
131 1 John Freeman
</pre>
132 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:
133 1 John Freeman
134 108 John Freeman
---
135 108 John Freeman
136 117 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "ready" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
137 108 John Freeman
138 108 John Freeman
---
139 1 John Freeman
140 94 John Freeman
h2.  Selecting a run configuration and DAQ components
141 49 Erik Blaufuss
142 1 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQComponents must be selected.  This is done via RunControl.
143 1 John Freeman
144 49 Erik Blaufuss
h3. List and select a configuration:
145 1 John Freeman
146 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
147 49 Erik Blaufuss
<pre>
148 49 Erik Blaufuss
lbnecmd listconfigs
149 1 John Freeman
</pre>
150 49 Erik Blaufuss
Will return a list of configs:
151 49 Erik Blaufuss
<pre>
152 49 Erik Blaufuss
Available configs (Name : description)
153 1 John Freeman
154 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
155 111 John Freeman
6xssp_ext : Sorry, no description found.
156 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
157 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
158 30 John Freeman
...
159 1 John Freeman
160 49 Erik Blaufuss
Current selected config: No Config
161 49 Erik Blaufuss
</pre>
162 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:
163 49 Erik Blaufuss
<pre> 
164 49 Erik Blaufuss
lbnecmd setconfig demo
165 1 John Freeman
</pre>
166 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.
167 1 John Freeman
168 49 Erik Blaufuss
h3. List and select DAQ components.
169 1 John Freeman
170 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
171 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.
172 38 John Freeman
173 1 John Freeman
To see the list of available DAQ components:
174 49 Erik Blaufuss
<pre>
175 1 John Freeman
lbnecmd listdaqcomps
176 49 Erik Blaufuss
</pre>
177 62 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
178 1 John Freeman
<pre>
179 112 John Freeman
Available:
180 112 John Freeman
component01 (lbnedaq2:5205)
181 112 John Freeman
component02 (lbnedaq2:5206)
182 112 John Freeman
183 112 John Freeman
ssp08 (lbnedaq1:5214)
184 112 John Freeman
185 112 John Freeman
Selected:
186 112 John Freeman
component01 (lbnedaq2:5205)
187 112 John Freeman
component02 (lbnedaq2:5206)
188 112 John Freeman
189 112 John Freeman
ssp08 (lbnedaq1:5214)
190 62 John Freeman
</pre>
191 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:
192 1 John Freeman
<pre>
193 118 John Freeman
lbnecmd setdaqcomps component0{1,2}
194 49 Erik Blaufuss
</pre>
195 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.
196 49 Erik Blaufuss
To change the list of available components, see below.
197 29 John Freeman
198 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
199 1 John Freeman
200 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:
201 1 John Freeman
<pre>
202 49 Erik Blaufuss
lbnecmd check
203 1 John Freeman
</pre>
204 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.
205 1 John Freeman
206 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:
207 1 John Freeman
<pre>
208 1 John Freeman
lbnecmd init daq
209 1 John Freeman
</pre>
210 1 John Freeman
211 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
212 29 John Freeman
<pre>
213 1 John Freeman
lbnecmd start daq
214 29 John Freeman
</pre>
215 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
216 49 Erik Blaufuss
<pre>
217 49 Erik Blaufuss
lbnecmd check
218 49 Erik Blaufuss
lbnecontrol: running
219 49 Erik Blaufuss
Run number: 207
220 49 Erik Blaufuss
Run configuration: demo
221 1 John Freeman
222 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
223 49 Erik Blaufuss
</pre>
224 49 Erik Blaufuss
225 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:
226 22 John Freeman
<pre>
227 21 John Freeman
lbnecmd pause daq
228 42 John Freeman
</pre>
229 41 John Freeman
230 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:
231 48 John Freeman
<pre>
232 48 John Freeman
lbnecmd resume daq
233 48 John Freeman
</pre>
234 48 John Freeman
235 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
236 48 John Freeman
<pre>
237 48 John Freeman
lbnecmd stop daq
238 49 Erik Blaufuss
</pre>
239 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
240 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:
241 1 John Freeman
242 1 John Freeman
<pre>
243 1 John Freeman
lbnecmd terminate daq
244 1 John Freeman
</pre>
245 67 Erik Blaufuss
246 67 Erik Blaufuss
If you want to stop all RunControl processes (known as "lbnecontrol"):
247 67 Erik Blaufuss
<pre>
248 67 Erik Blaufuss
lbnecmd kill
249 67 Erik Blaufuss
</pre>
250 67 Erik Blaufuss
After this, you will need to relaunch RunControl as above.
251 1 John Freeman
252 49 Erik Blaufuss
h2. After your DAQ run.
253 1 John Freeman
254 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
255 48 John Freeman
256 76 John Freeman
h3. The DAQ log
257 76 John Freeman
258 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/.
259 76 John Freeman
260 76 John Freeman
h3. The run record
261 76 John Freeman
262 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>. 
263 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. 
264 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. 
265 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. 
266 115 John Freeman
267 119 John Freeman
As an example, in /data/lbnedaq/run_records/778 (the directory for run 778), the metadata file looks like the following:
268 72 John Freeman
<pre>
269 72 John Freeman
Config name: demo
270 72 John Freeman
Component #0: component01
271 1 John Freeman
Component #1: component02
272 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
273 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
274 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
275 114 John Freeman
276 114 John Freeman
277 119 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
278 114 John Freeman
279 1 John Freeman
boardreader logfiles: 
280 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37365.log
281 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37366.log
282 114 John Freeman
283 114 John Freeman
eventbuilder logfiles: 
284 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37364.log
285 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37363.log
286 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37368.log
287 114 John Freeman
288 114 John Freeman
aggregator logfiles: 
289 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37369.log
290 119 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37367.log
291 119 John Freeman
292 1 John Freeman
</pre>
293 76 John Freeman
294 81 John Freeman
h3. Output of the Art modules
295 76 John Freeman
296 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.
297 76 John Freeman
298 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:
299 76 John Freeman
300 76 John Freeman
<pre>
301 76 John Freeman
cd <lbne-artdaq basedir>
302 76 John Freeman
source setupLBNEARTDAQ
303 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
304 76 John Freeman
</pre>
305 76 John Freeman
306 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:
307 76 John Freeman
308 76 John Freeman
<pre>
309 81 John Freeman
%MSG-i MF_INIT_OK:  art 01-Dec-2014 16:13:59 CST JobSetup 
310 76 John Freeman
Messagelogger initialization complete.
311 76 John Freeman
%MSG
312 81 John Freeman
%MSG-i PathConfiguration:  art 01-Dec-2014 16:14:00 CST JobSetup 
313 76 John Freeman
Multiple end paths have been combined into one end path,
314 76 John Freeman
"end_path" since order is irrelevant.
315 76 John Freeman
316 76 John Freeman
%MSG
317 81 John Freeman
01-Dec-2014 16:14:00 CST  Initiating request to open file /tmp/lbne35t_r000270_sr01_20141201T221127.root
318 81 John Freeman
01-Dec-2014 16:14:00 CST  Successfully opened file /tmp/lbne35t_r000270_sr01_20141201T221127.root
319 1 John Freeman
--------------------------------------------------------------
320 76 John Freeman
Package             |Version             |Timestamp           
321 81 John Freeman
artdaq-core         |v1_04_06            |01-Dec-2014 21:59:51 UTC
322 81 John Freeman
artdaq              |v1_12_04            |01-Dec-2014 22:01:57 UTC
323 81 John Freeman
lbne-artdaq         |v0_00_08            |01-Dec-2014 22:00:18 UTC
324 81 John Freeman
lbne-artdaq         |v0_07_00            |01-Dec-2014 22:02:57 UTC
325 76 John Freeman
--------------------------------------------------------------
326 81 John Freeman
Begin processing the 1st record. run: 270 subRun: 1 event: 1 at 01-Dec-2014 16:14:00 CST
327 76 John Freeman
PROCESS NAME | MODULE LABEL.. | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE............ | PRODUCT FRIENDLY TYPE | SIZE
328 81 John Freeman
DAQ......... | daq........... | TOY1................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...2
329 1 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
330 76 John Freeman
331 81 John Freeman
Total products (present, not present): 8 (2, 6).
332 76 John Freeman
333 1 John Freeman
PROCESS NAME | MODULE LABEL | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE.................... | PRODUCT FRIENDLY TYPE.... | SIZE
334 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
335 76 John Freeman
336 76 John Freeman
Total products (present, not present): 1 (1, 0).
337 76 John Freeman
338 81 John Freeman
01-Dec-2014 16:14:00 CST  Closed file /tmp/lbne35t_r000270_sr01_20141201T221127.root
339 76 John Freeman
340 76 John Freeman
TrigReport ---------- Event  Summary ------------
341 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
342 76 John Freeman
343 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
344 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
345 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
346 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
347 76 John Freeman
348 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
349 1 John Freeman
TimeReport CPU = 0.003361 Real = 0.003000
350 1 John Freeman
351 76 John Freeman
Art has completed and will exit with status 0.
352 76 John Freeman
</pre>
353 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.
354 81 John Freeman
355 84 John Freeman
h1. Configuring DAQInterface: the DAQInterface configuration file
356 91 John Freeman
357 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:
358 1 John Freeman
<pre>
359 1 John Freeman
360 100 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
361 91 John Freeman
362 1 John Freeman
PMT host: lbnedaq3
363 100 John Freeman
PMT port: 5400
364 1 John Freeman
365 49 Erik Blaufuss
pause before initialization: 5
366 49 Erik Blaufuss
367 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
368 49 Erik Blaufuss
debug level: 1
369 49 Erik Blaufuss
370 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
371 49 Erik Blaufuss
372 91 John Freeman
record directory: /data/lbnedaq/run_records
373 49 Erik Blaufuss
374 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
375 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
376 116 John Freeman
# set "disable configuration check" to "true"
377 116 John Freeman
378 101 John Freeman
disable configuration check: false
379 101 John Freeman
380 101 John Freeman
TDU XMLRPC port: 0
381 91 John Freeman
382 91 John Freeman
EventBuilder host: lbnedaq2
383 48 John Freeman
EventBuilder port: 5235
384 91 John Freeman
385 91 John Freeman
EventBuilder host: lbnedaq2
386 91 John Freeman
EventBuilder port: 5236
387 48 John Freeman
388 91 John Freeman
Aggregator host: lbnedaq2
389 91 John Freeman
Aggregator port: 5265
390 48 John Freeman
391 91 John Freeman
Aggregator host: lbnedaq2
392 1 John Freeman
Aggregator port: 5266
393 1 John Freeman
394 1 John Freeman
</pre>
395 1 John Freeman
396 92 John Freeman
The meaning of these parameters is as follows:
397 92 John Freeman
398 92 John Freeman
* *lbne-artdaq* : the directory in which the desired build of lbne-artdaq to use is located
399 92 John Freeman
400 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
401 100 John Freeman
* *PMT port* : pmt.rb's port
402 92 John Freeman
403 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
404 1 John Freeman
405 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. 
406 92 John Freeman
407 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/
408 93 John Freeman
409 93 John Freeman
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
410 101 John Freeman
411 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. 
412 101 John Freeman
413 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
414 49 Erik Blaufuss
415 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.
416 49 Erik Blaufuss
417 57 John Freeman
h1. Adding new configurations to RunControl
418 57 John Freeman
419 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. 
420 68 John Freeman
421 91 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
422 57 John Freeman
<pre>
423 57 John Freeman
/data/lbnedaq/config/<named_configuration>
424 57 John Freeman
</pre>
425 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
426 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
427 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")
428 59 John Freeman
429 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.
430 59 John Freeman
<pre>
431 1 John Freeman
 event_builder_count: PLACEHOLDER
432 59 John Freeman
</pre>
433 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.
434 1 John Freeman
435 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
436 68 John Freeman
<pre>
437 68 John Freeman
git log
438 68 John Freeman
</pre>
439 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:
440 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:
441 68 John Freeman
<pre>
442 68 John Freeman
# On branch master
443 68 John Freeman
# Changes to be committed:
444 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
445 68 John Freeman
#
446 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
447 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
448 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
449 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
450 68 John Freeman
#
451 68 John Freeman
</pre>
452 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.:
453 68 John Freeman
<pre>
454 1 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
455 68 John Freeman
</pre>
456 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. 
457 68 John Freeman
</pre>
458 68 John Freeman
Now, make sure that the commit took place correctly by running
459 68 John Freeman
<pre>
460 68 John Freeman
git diff HEAD
461 68 John Freeman
</pre>
462 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
463 1 John Freeman
<pre>
464 68 John Freeman
git log
465 68 John Freeman
</pre>
466 69 John Freeman
you should be able to see your commit at the top.
467 57 John Freeman
468 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
469 79 John Freeman
<pre>
470 79 John Freeman
git push origin
471 79 John Freeman
</pre>
472 79 John Freeman
473 79 John Freeman
and now, if you run 
474 79 John Freeman
475 79 John Freeman
<pre>
476 79 John Freeman
git diff origin/master
477 79 John Freeman
</pre>
478 79 John Freeman
479 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. 
480 79 John Freeman
481 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
482 49 Erik Blaufuss
483 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
484 49 Erik Blaufuss
<pre>
485 49 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
486 18 John Freeman
</pre>
487 55 Erik Blaufuss
Each entry (name: host port) defines:
488 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
489 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
490 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
491 18 John Freeman
492 49 Erik Blaufuss
For example:
493 49 Erik Blaufuss
<pre>
494 49 Erik Blaufuss
component01: lbnedaq2 5205
495 49 Erik Blaufuss
component02: lbnedaq2 5206
496 49 Erik Blaufuss
</pre>
497 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
498 27 John Freeman
499 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
500 28 John Freeman
501 49 Erik Blaufuss
h2.  Common RunControl issues
502 27 John Freeman
503 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
504 1 John Freeman
505 49 Erik Blaufuss
<pre>
506 49 Erik Blaufuss
lbnecmd help
507 49 Erik Blaufuss
</pre>
508 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
509 50 Erik Blaufuss
 
510 1 John Freeman
h3.  No real configurations are listed by RunControl
511 45 John Freeman
512 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
513 45 John Freeman
<pre>
514 49 Erik Blaufuss
Available configs (Name : description)
515 49 Erik Blaufuss
516 49 Erik Blaufuss
dummy : Dummy description
517 45 John Freeman
</pre>
518 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)
519 1 John Freeman
520 49 Erik Blaufuss
h2.  Common DAQInterface issues
521 49 Erik Blaufuss
522 49 Erik Blaufuss
h3.  *Error handling*
523 49 Erik Blaufuss
524 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
525 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
526 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
527 49 Erik Blaufuss
528 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). 
529 49 Erik Blaufuss
530 84 John Freeman
h3. *Your change to the DAQInterface configuration file or the daqinterface.py code doesn't seem to do anything*
531 49 Erik Blaufuss
532 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
533 49 Erik Blaufuss
534 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
535 49 Erik Blaufuss
536 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.
537 54 John Freeman
538 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
539 1 John Freeman
540 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
541 1 John Freeman
<pre>
542 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)
543 1 John Freeman
</pre>
544 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 
545 1 John Freeman
<pre>
546 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
547 51 John Freeman
</pre>
548 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.
549 77 John Freeman
550 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*
551 1 John Freeman
552 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.