Project

General

Profile

Running DAQ Interface » History » Version 208

John Freeman, 02/03/2016 10:51 AM

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 189 John Freeman
Everything in this wiki was up-to-date as of October 11, 2015.
26 189 John Freeman
27 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.). 
28 49 Erik Blaufuss
29 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:
30 1 John Freeman
31 1 John Freeman
<pre>
32 1 John Freeman
cd /data/lbnedaq/daqarea
33 1 John Freeman
source fireup
34 189 John Freeman
</pre>
35 1 John Freeman
36 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. 
37 1 John Freeman
38 193 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 your work is non-urgent.  A reminder to this effect is printed whenever you log into lbne35t-gateway01.fnal.gov. 
39 1 John Freeman
40 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. 
41 188 John Freeman
42 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.
43 188 John Freeman
44 123 John Freeman
h1. Killing, launching, and getting the status of the DAQ applications
45 123 John Freeman
46 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:
47 123 John Freeman
** These applications all need to be running in order for the DAQ to work
48 188 John Freeman
** DAQInterface needs to be launched _after_ RunControl
49 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)
50 1 John Freeman
51 167 John Freeman
h2. Getting the status
52 167 John Freeman
53 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:
54 1 John Freeman
55 1 John Freeman
<pre>
56 165 John Freeman
check_daq_applications.sh
57 165 John Freeman
</pre>
58 176 John Freeman
which will produce output which looks like this:
59 1 John Freeman
<pre>
60 176 John Freeman
61 188 John Freeman
lbnecontrol: **Not Found**
62 188 John Freeman
CfgMgr: Available
63 176 John Freeman
DAQInterface: Available
64 176 John Freeman
TDUControl: **Not Found**
65 176 John Freeman
66 176 John Freeman
Most recent DAQ logfile written (current US Central Time is Apr 10 09:56):
67 176 John Freeman
Apr 8 17:25 /data/lbnedaq/daqlogs/pmt/pmt-32342.1-20150408171225.log
68 155 John Freeman
</pre>
69 1 John Freeman
70 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. 
71 155 John Freeman
72 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:
73 1 John Freeman
<pre>
74 1 John Freeman
lbnecmd check
75 1 John Freeman
</pre>
76 138 John Freeman
77 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:
78 124 John Freeman
<pre>
79 124 John Freeman
lbnecontrol: Available
80 124 John Freeman
CfgMgr: **Not Found**
81 1 John Freeman
DAQInterface: Available
82 124 John Freeman
TDUControl: **Not Found**
83 1 John Freeman
...
84 1 John Freeman
</pre>
85 91 John Freeman
86 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>".
87 49 Erik Blaufuss
88 196 John Freeman
h2. Cleanup: killing DAQInterface, the configuration manager, and the TDU XMLRPC server
89 1 John Freeman
90 196 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. It's capable of killing all the major applications except for RunControl, which is meant to always be running. In order to kill the other three applications, one would run:
91 152 John Freeman
92 152 John Freeman
<pre>
93 196 John Freeman
kill_daq_applications.sh -c -d -t
94 152 John Freeman
</pre>
95 152 John Freeman
96 196 John Freeman
where each option corresponds to the killing of a particular application: "-c" for the configuration manager, "-d" for DAQInterface, and "-t" for the TDU XML-RPC server. If only a subset of these three 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. 
97 152 John Freeman
98 200 John Freeman
Note that as of Dec-22-2015, killing DAQInterface will also kill the auto_file_close.sh script, but not kill the MessageViewer application.
99 200 John Freeman
100 206 John Freeman
Killing RunControl should only be done at an expert's request, and has its own special syntax, described in the old (2014) instructions for killing the applications. Click on "Show", below, to learn more.
101 152 John Freeman
102 152 John Freeman
{{collapse()
103 152 John Freeman
104 124 John Freeman
Killing RunControl has its own special syntax, and is simply:
105 1 John Freeman
106 109 Thomas Dealtry
<pre>
107 124 John Freeman
lbnecmd kill
108 1 John Freeman
</pre>
109 105 John Freeman
110 208 John Freeman
In the event that some unusual edge case results in this not working, the standard Linux command  <code>kill <pid></code>, where "<pid>" is the process ID of the application, can always be used, both for RunControl and the other DAQ applications. To find the process IDs of all possible DAQ applications, you can run:
111 105 John Freeman
112 105 John Freeman
<pre>
113 124 John Freeman
ps aux | grep -v grep | grep -v emacs | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
114 105 John Freeman
</pre>
115 1 John Freeman
116 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.
117 152 John Freeman
}}
118 105 John Freeman
119 124 John Freeman
h2. Launching RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
120 105 John Freeman
121 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:
122 154 John Freeman
<pre>
123 154 John Freeman
launch_daq_applications.sh -c -t -r -d <daqinterface configuration file>
124 154 John Freeman
</pre>
125 154 John Freeman
126 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. 
127 154 John Freeman
128 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. 
129 154 John Freeman
130 190 John Freeman
Note also that when you launch DAQInterface, a window with the header "MessageFacility MsgViewer" will pop up; it's in this window that messages about the running DAQ (color coded by severity level) will appear. More on this in a bit. 
131 190 John Freeman
132 199 John Freeman
Another program that launches along with DAQInterface is called "auto_file_close.sh"; this is a script which will issue automatic stop-start transitions to the DAQ when diskwriting runs are performed, such that on stop the current output file is closed and the run is ended, and on start the run number increments and a new file is opened. The frequency with which this occurs can be set in the DAQInterface configuration file (see below for more on this file); as of Dec-22-2015 the current default is for the stop-start to be issued either after ten minutes since the start of the run or after a file has reached 5 gigabytes. 
133 199 John Freeman
134 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:
135 154 John Freeman
136 201 Erik Blaufuss
*Note*:  Run Control is generally not stopped and started by _launch_daq_applications.sh_ any longer.  The main Run control server should be running all the time to support Slow Control reported information.  If you suspect  issues with Run Control, see the _TroubleShooting and FAQ_ section below for help.
137 201 Erik Blaufuss
138 154 John Freeman
{{collapse()
139 154 John Freeman
140 181 John Freeman
_Old instructions for launching RunControl_
141 49 Erik Blaufuss
142 124 John Freeman
<pre>
143 49 Erik Blaufuss
rm -f /tmp/lbnecontrol.pid  # (This should only be necessary if last RunControl session wasn't killed via "lbnecmd kill")
144 1 John Freeman
lbnecmd launch
145 1 John Freeman
</pre>
146 61 John Freeman
147 181 John Freeman
_Old instructions for launching DAQInterface_
148 151 John Freeman
149 151 John Freeman
<pre>
150 151 John Freeman
daqinterface -f <daqinterface file> &
151 151 John Freeman
</pre>
152 1 John Freeman
153 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. 
154 1 John Freeman
155 154 John Freeman
Other "expert" arguments:
156 151 John Freeman
<pre>
157 1 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
158 1 John Freeman
</pre>
159 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. 
160 141 John Freeman
161 154 John Freeman
162 154 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
163 1 John Freeman
<pre>
164 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
165 1 John Freeman
</pre>
166 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)
167 141 John Freeman
168 154 John Freeman
169 181 John Freeman
_Old instructions for launching the configuration manager_
170 1 John Freeman
171 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
172 109 Thomas Dealtry
173 181 John Freeman
_Old instructions for launching the TDU XMLRPC server_
174 109 Thomas Dealtry
175 109 Thomas Dealtry
<pre>
176 124 John Freeman
tdu -T 192.168.100.201 -P 10001 -H localhost -r 50008 &
177 1 John Freeman
</pre>
178 1 John Freeman
179 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.
180 125 John Freeman
181 154 John Freeman
See [[Starting and using TDUControl]] for more details.
182 1 John Freeman
183 154 John Freeman
}}
184 62 John Freeman
185 162 John Freeman
h1. Performing a Run
186 1 John Freeman
187 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:
188 1 John Freeman
189 142 John Freeman
---
190 143 John Freeman
191 188 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "paused" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
192 143 John Freeman
193 142 John Freeman
---
194 142 John Freeman
195 125 John Freeman
h2. Checking the state of the DAQ
196 127 John Freeman
197 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:
198 1 John Freeman
<pre>
199 125 John Freeman
lbnecontrol: Available
200 125 John Freeman
CfgMgr: Available
201 125 John Freeman
DAQInterface: Available
202 125 John Freeman
TDUControl: Available
203 125 John Freeman
204 125 John Freeman
Run number: 797
205 125 John Freeman
Run configuration: ganglia_test
206 125 John Freeman
Run type: Test
207 125 John Freeman
daqint@localhost:5570 (synchronous): running
208 125 John Freeman
</pre>
209 125 John Freeman
210 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. 
211 108 John Freeman
212 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:
213 117 John Freeman
<pre>
214 108 John Freeman
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
215 1 John Freeman
</pre>
216 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.
217 1 John Freeman
218 94 John Freeman
h2.  Selecting a run configuration and DAQ components
219 49 Erik Blaufuss
220 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.
221 1 John Freeman
222 49 Erik Blaufuss
h3. List and select a configuration:
223 1 John Freeman
224 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
225 49 Erik Blaufuss
<pre>
226 1 John Freeman
lbnecmd listconfigs
227 1 John Freeman
</pre>
228 143 John Freeman
This lists all available configs, as well as the current selected config (Note, default config is "No Config"):
229 1 John Freeman
<pre>
230 1 John Freeman
Available configs (Name : description)
231 1 John Freeman
232 189 John Freeman
rces_and_ssps : Run up to 8 SSPs and 4 RCEs, with ganglia, online monitoring, and root file output enabled
233 189 John Freeman
234 189 John Freeman
demo_rc_reporter : A version of the demo which reports metrics to RunControl
235 189 John Freeman
236 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
237 30 John Freeman
...
238 1 John Freeman
239 49 Erik Blaufuss
Current selected config: No Config
240 1 John Freeman
</pre>
241 49 Erik Blaufuss
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:
242 1 John Freeman
<pre> 
243 1 John Freeman
lbnecmd setconfig demo
244 1 John Freeman
</pre>
245 189 John Freeman
This will return "OK" if successful; "lbnecmd listconfigs" will then show this as the current config via its last line of output: <code>Current selected config: demo</code>.  If the specified configuration is not known, an error is returned. Instructions on how to add or edit a configuration (an expert-only action) are given later in this document.
246 1 John Freeman
247 189 John Freeman
Note: when taking data with the machine, you'll most likely be using the "rces_and_ssps" configuration; this allows you to connect to the SSPs, RCEs and Penn trigger board, runs the online monitoring module, and saves the output data in *.root files. 
248 189 John Freeman
249 49 Erik Blaufuss
h3. List and select DAQ components.
250 1 John Freeman
251 189 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
252 189 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- so, for example, if you're using the "demo" configuration, you couldn't request ssp01 as one of the components, since the demo configuration only allows for components which create simulated (i.e., fake) data. 
253 1 John Freeman
254 49 Erik Blaufuss
To see the list of available DAQ components:
255 1 John Freeman
<pre>
256 49 Erik Blaufuss
lbnecmd listdaqcomps
257 62 John Freeman
</pre>
258 1 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
259 112 John Freeman
<pre>
260 112 John Freeman
Available:
261 112 John Freeman
component01 (lbnedaq2:5205)
262 112 John Freeman
component02 (lbnedaq2:5206)
263 112 John Freeman
264 112 John Freeman
ssp08 (lbnedaq1:5214)
265 112 John Freeman
266 112 John Freeman
Selected:
267 112 John Freeman
component01 (lbnedaq2:5205)
268 112 John Freeman
component02 (lbnedaq2:5206)
269 1 John Freeman
270 1 John Freeman
ssp08 (lbnedaq1:5214)
271 62 John Freeman
</pre>
272 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:
273 1 John Freeman
<pre>
274 1 John Freeman
lbnecmd setdaqcomps component0{1,2}
275 118 John Freeman
</pre>
276 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.
277 143 John Freeman
278 143 John Freeman
How to make a new component available to RunControl is described later in this document. 
279 29 John Freeman
280 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
281 1 John Freeman
282 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:
283 1 John Freeman
<pre>
284 49 Erik Blaufuss
lbnecmd check
285 1 John Freeman
</pre>
286 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.
287 1 John Freeman
288 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:
289 1 John Freeman
<pre>
290 1 John Freeman
lbnecmd init daq
291 1 John Freeman
</pre>
292 1 John Freeman
293 190 John Freeman
You'll see the MessageFacility MsgViewer window fill with a few messages; it'll look something like this:
294 190 John Freeman
295 190 John Freeman
!Msgviewer_init.png!
296 190 John Freeman
297 190 John Freeman
You'll be able to filter out messages by level of severity; so, for example, if you only cared about Error messages you could click on "Error" in the upper-right hand corner of the window. To reinstate the display of Error, Warning and Info messages, you could click on "Info". In general, allowing for these three types of message is probably a good default. Note that developer decisions about what messages constitute Error vs. Warning vs. Info are still evolving as of Oct 10, 2015, and will likely be influenced by the first couple of weeks of running. 
298 190 John Freeman
299 190 John Freeman
Now, in order to begin taking data, take DAQInterface from the "ready" to the "running" state:
300 179 John Freeman
<pre>
301 179 John Freeman
lbnecmd start daq
302 179 John Freeman
</pre>
303 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:
304 1 John Freeman
<pre>
305 1 John Freeman
DAQ config
306 1 John Freeman
**********
307 179 John Freeman
Run Type: Test
308 190 John Freeman
Selected config: demo
309 179 John Freeman
Selected DAQ components:
310 190 John Freeman
   component01 (lbnedaq1:5205)
311 190 John Freeman
   component02 (lbnedaq1:5206)
312 190 John Freeman
Start DAQ with these settings? [y]|n: 
313 179 John Freeman
</pre>
314 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. 
315 186 John Freeman
316 191 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". 
317 178 John Freeman
318 191 John Freeman
Pause the running of the DAQ, putting DAQInterface into the "paused" state.  This will cause the current open output Root file to be closed and given a name reflecting the current run and subrun numbers (the format as of October 10, 2015 is @lbne_r<run number>_sr<subrun number>_<creation time>.root@; the file appears in /storage/data on lbnedaq6):
319 21 John Freeman
<pre>
320 42 John Freeman
lbnecmd pause daq
321 41 John Freeman
</pre>
322 167 John Freeman
323 1 John Freeman
Resume the running of the DAQ, returning it to the "running" state.  This will restart data taking to a new output file:
324 48 John Freeman
<pre>
325 48 John Freeman
lbnecmd resume daq
326 48 John Freeman
</pre>
327 48 John Freeman
328 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
329 48 John Freeman
<pre>
330 49 Erik Blaufuss
lbnecmd stop daq
331 49 Erik Blaufuss
</pre>
332 127 John Freeman
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
333 1 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:
334 67 Erik Blaufuss
335 67 Erik Blaufuss
<pre>
336 67 Erik Blaufuss
lbnecmd terminate daq
337 1 John Freeman
</pre>
338 172 John Freeman
339 1 John Freeman
h2. Examining the output
340 129 John Freeman
341 191 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 October 10, 2015, in /storage/data on lbnedaq6), 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":
342 72 John Freeman
343 72 John Freeman
<pre>
344 72 John Freeman
Config name: demo
345 1 John Freeman
Component #0: component01
346 119 John Freeman
Component #1: component02
347 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
348 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
349 1 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
350 114 John Freeman
351 114 John Freeman
352 1 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
353 1 John Freeman
354 1 John Freeman
boardreader logfiles: 
355 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37365.log
356 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37366.log
357 1 John Freeman
358 1 John Freeman
eventbuilder logfiles: 
359 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37364.log
360 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37363.log
361 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37368.log
362 1 John Freeman
363 1 John Freeman
aggregator logfiles: 
364 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37369.log
365 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37367.log
366 1 John Freeman
367 167 John Freeman
</pre>
368 1 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. 
369 119 John Freeman
370 129 John Freeman
371 129 John Freeman
{{collapse(Comprehensive details on the contents of the run records directory...)
372 129 John Freeman
373 129 John Freeman
** The full contents of the metadata file, beyond what's described above, include: 
374 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
375 129 John Freeman
-The individual artdaq process logfiles
376 129 John Freeman
377 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. 
378 129 John Freeman
379 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. 
380 129 John Freeman
381 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. 
382 129 John Freeman
383 192 John Freeman
** If one or more RCEs were used in the run, defaults.xml, used to initialize RCEs, is saved as well. 
384 192 John Freeman
385 129 John Freeman
}}
386 185 John Freeman
387 1 John Freeman
{{collapse(How to examine your output Root files...)
388 192 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 October 10, 2015, the standard output location is /storage/data on lbnedaq6. 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.
389 185 John Freeman
390 192 John Freeman
To take a quick look at the art-readable *.root file, with a version of lbne-artdaq newer than November 25, 2014, you can do the following:
391 76 John Freeman
392 76 John Freeman
<pre>
393 76 John Freeman
cd <lbne-artdaq basedir>
394 76 John Freeman
source setupLBNEARTDAQ
395 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
396 76 John Freeman
</pre>
397 186 John Freeman
398 166 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:
399 166 John Freeman
<pre>
400 166 John Freeman
rawEventDump -s /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root -n 1
401 1 John Freeman
</pre>
402 166 John Freeman
403 166 John Freeman
Then the output will look something like the following:
404 81 John Freeman
405 166 John Freeman
<pre>
406 81 John Freeman
%MSG-i MF_INIT_OK:  art 08-Apr-2015 13:29:00 CDT JobSetup 
407 81 John Freeman
Messagelogger initialization complete.
408 166 John Freeman
%MSG
409 1 John Freeman
%MSG-i PathConfiguration:  art 08-Apr-2015 13:29:00 CDT JobSetup 
410 1 John Freeman
Multiple end paths have been combined into one end path,
411 1 John Freeman
"end_path" since order is irrelevant.
412 1 John Freeman
413 166 John Freeman
%MSG
414 166 John Freeman
08-Apr-2015 13:29:00 CDT  Initiating request to open file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
415 81 John Freeman
08-Apr-2015 13:29:00 CDT  Successfully opened file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
416 1 John Freeman
--------------------------------------------------------------
417 166 John Freeman
Package             |Version             |Timestamp           
418 166 John Freeman
artdaq-core         |v1_04_10            |11-Mar-2015 14:35:37 UTC
419 166 John Freeman
artdaq              |v1_12_08            |11-Mar-2015 14:37:50 UTC
420 166 John Freeman
lbne-raw-data       |v1_02_00            |11-Mar-2015 14:36:11 UTC
421 76 John Freeman
lbne-artdaq         |v1_01_02            |13-Mar-2015 20:31:07 UTC
422 166 John Freeman
--------------------------------------------------------------
423 81 John Freeman
Begin processing the 1st record. run: 731 subRun: 1 event: 1 at 08-Apr-2015 13:29:00 CDT
424 166 John Freeman
PROCESS NAME | MODULE LABEL.. | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE............ | PRODUCT FRIENDLY TYPE | SIZE
425 166 John Freeman
DAQ......... | daq........... | PHOTON............... | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...7
426 81 John Freeman
DAQ......... | daq........... | TPC.................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...8
427 1 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
428 166 John Freeman
429 1 John Freeman
Total products (present, not present): 8 (3, 5).
430 76 John Freeman
431 76 John Freeman
PROCESS NAME | MODULE LABEL | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE.................... | PRODUCT FRIENDLY TYPE.... | SIZE
432 1 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
433 76 John Freeman
434 81 John Freeman
Total products (present, not present): 1 (1, 0).
435 166 John Freeman
436 1 John Freeman
08-Apr-2015 13:29:00 CDT  Closed file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
437 76 John Freeman
438 76 John Freeman
TrigReport ---------- Event  Summary ------------
439 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
440 76 John Freeman
441 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
442 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
443 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
444 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
445 76 John Freeman
446 166 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
447 1 John Freeman
TimeReport CPU = 0.017439 Real = 0.007998
448 1 John Freeman
449 166 John Freeman
Art has completed and will exit with status 0.
450 129 John Freeman
451 166 John Freeman
</pre>
452 131 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.
453 145 John Freeman
}}
454 1 John Freeman
455 1 John Freeman
h1. The DAQInterface configuration file
456 1 John Freeman
457 192 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. 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, {{collapse(read on…)
458 192 John Freeman
459 192 John Freeman
460 192 John Freeman
 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; please note you can leave RunControl running but will want to kill DAQInterface and restart it with the edited DAQInterface configuration file. 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. Take a look at the default DAQInterface configuration file; it should look something like the following:
461 91 John Freeman
<pre>
462 1 John Freeman
463 192 John Freeman
lbne-artdaq: /data/lbnedaq/lbne-artdaq-standard/build_lbne-artdaq
464 1 John Freeman
465 49 Erik Blaufuss
PMT host: lbnedaq3
466 49 Erik Blaufuss
PMT port: 5400
467 49 Erik Blaufuss
468 49 Erik Blaufuss
pause before initialization: 5
469 49 Erik Blaufuss
470 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
471 49 Erik Blaufuss
debug level: 1
472 91 John Freeman
473 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
474 116 John Freeman
475 116 John Freeman
record directory: /data/lbnedaq/run_records
476 116 John Freeman
477 101 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
478 101 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
479 1 John Freeman
# set "disable configuration check" to "true"
480 1 John Freeman
481 1 John Freeman
disable configuration check: false
482 48 John Freeman
483 192 John Freeman
# If TDU XMLRPC port is set to 0 or less, no sync pulse will be sent
484 192 John Freeman
# by the TDU at the start transition
485 192 John Freeman
486 91 John Freeman
TDU XMLRPC port: 50008
487 1 John Freeman
488 192 John Freeman
EventBuilder host: lbnedaq6
489 1 John Freeman
EventBuilder port: 5235
490 48 John Freeman
491 192 John Freeman
EventBuilder host: lbnedaq6
492 1 John Freeman
EventBuilder port: 5236
493 1 John Freeman
494 192 John Freeman
Aggregator host: lbnedaq6
495 130 John Freeman
Aggregator port: 5265
496 1 John Freeman
497 192 John Freeman
Aggregator host: lbnedaq6
498 130 John Freeman
Aggregator port: 5266
499 1 John Freeman
500 198 John Freeman
max file size (MB): 5000
501 198 John Freeman
max file time (min): 10
502 198 John Freeman
503 1 John Freeman
</pre>
504 1 John Freeman
505 192 John Freeman
Presented roughly in order of likelihood of how often you'd change them, the parameters are the following:
506 130 John Freeman
507 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.
508 1 John Freeman
509 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. 
510 198 John Freeman
511 198 John Freeman
* *max file size (MB) / max file time (min)* : when a diskwriting run is performed, these values set the maximum file size in megabytes and the maximum time of data collection in minutes before an automatic stop-start is issued by the auto_file_close.sh script, effectively stopping the run, closing the current file, starting a new run, and opening a new file. Note that it's whichever of these variables that gets hit first that triggers the stop-start, and that if either of these variables is set to 0, that disables use of the variable (so if they're both set to 0, no automatic stop-starts ever get issued). 
512 130 John Freeman
513 192 John Freeman
* *The hosts and ports of 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. Note also you can define any number of EventBuilderMains, but that you must have two and only two AggregatorMains, and they must be on the same host. 
514 130 John Freeman
515 192 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 and errors can occur; see below in the "Troubleshooting" section for more)
516 92 John Freeman
517 192 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. 
518 192 John Freeman
519 192 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
520 192 John Freeman
521 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
522 101 John Freeman
* *PMT port* : pmt.rb's port
523 101 John Freeman
524 192 John Freeman
* *log directory* : (NEVER CHANGE THIS UNLESS YOU'RE SURE YOU KNOW WHAT YOU'RE DOING) 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/
525 130 John Freeman
526 192 John Freeman
* *record directory* : (NEVER CHANGE THIS UNLESS YOU'RE SURE YOU KNOW WHAT YOU'RE DOING) the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
527 57 John Freeman
528 57 John Freeman
}}
529 187 John Freeman
530 132 John Freeman
h1. Editing or adding RunControl configurations
531 68 John Freeman
532 68 John Freeman
{{collapse(Expand for info here…)
533 91 John Freeman
534 57 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. 
535 57 John Freeman
536 57 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
537 57 John Freeman
<pre>
538 57 John Freeman
/data/lbnedaq/config/<named_configuration>
539 57 John Freeman
</pre>
540 59 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
541 59 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
542 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")
543 167 John Freeman
544 59 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.
545 68 John Freeman
<pre>
546 1 John Freeman
 event_builder_count: PLACEHOLDER
547 68 John Freeman
</pre>
548 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.
549 68 John Freeman
550 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
551 68 John Freeman
<pre>
552 68 John Freeman
git log
553 68 John Freeman
</pre>
554 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:
555 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:
556 68 John Freeman
<pre>
557 68 John Freeman
# On branch master
558 68 John Freeman
# Changes to be committed:
559 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
560 68 John Freeman
#
561 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
562 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
563 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
564 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
565 68 John Freeman
#
566 1 John Freeman
</pre>
567 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.:
568 68 John Freeman
<pre>
569 68 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
570 68 John Freeman
</pre>
571 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. 
572 68 John Freeman
</pre>
573 68 John Freeman
Now, make sure that the commit took place correctly by running
574 68 John Freeman
<pre>
575 1 John Freeman
git diff HEAD
576 68 John Freeman
</pre>
577 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
578 69 John Freeman
<pre>
579 57 John Freeman
git log
580 79 John Freeman
</pre>
581 79 John Freeman
you should be able to see your commit at the top.
582 79 John Freeman
583 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
584 79 John Freeman
<pre>
585 79 John Freeman
git push origin
586 79 John Freeman
</pre>
587 79 John Freeman
588 79 John Freeman
and now, if you run 
589 79 John Freeman
590 1 John Freeman
<pre>
591 132 John Freeman
git diff origin/master
592 132 John Freeman
</pre>
593 79 John Freeman
594 56 Erik Blaufuss
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.
595 49 Erik Blaufuss
}}
596 133 John Freeman
597 49 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
598 49 Erik Blaufuss
599 49 Erik Blaufuss
{{collapse(Expand for info here…)
600 18 John Freeman
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
601 55 Erik Blaufuss
<pre>
602 55 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
603 49 Erik Blaufuss
</pre>
604 49 Erik Blaufuss
Each entry (name: host port) defines:
605 18 John Freeman
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
606 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
607 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
608 49 Erik Blaufuss
609 49 Erik Blaufuss
For example:
610 49 Erik Blaufuss
<pre>
611 49 Erik Blaufuss
component01: lbnedaq2 5205
612 133 John Freeman
component02: lbnedaq2 5206
613 133 John Freeman
</pre>
614 133 John Freeman
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
615 27 John Freeman
616 49 Erik Blaufuss
*Note* that you will need to kill and re-launch RunControl if you add a component
617 28 John Freeman
}}
618 49 Erik Blaufuss
619 27 John Freeman
h1.  Troubleshooting and FAQ
620 49 Erik Blaufuss
621 1 John Freeman
h2.  Common RunControl issues
622 49 Erik Blaufuss
623 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
624 49 Erik Blaufuss
625 50 Erik Blaufuss
<pre>
626 50 Erik Blaufuss
lbnecmd help
627 1 John Freeman
</pre>
628 203 Erik Blaufuss
will list all available commands for RunControl with some details for help.
629 203 Erik Blaufuss
  
630 202 Erik Blaufuss
631 203 Erik Blaufuss
h3. It seems that "lbnecmd" is not responding properly
632 202 Erik Blaufuss
633 202 Erik Blaufuss
If the primary run control server process (called _lbnecontrol_) is not running, or has gotten into an unresponsive state (often characterized by RPC timeouts), you might have to start/restart the main run control process.
634 202 Erik Blaufuss
635 202 Erik Blaufuss
To check the health of Run Control, try:
636 202 Erik Blaufuss
<pre>
637 202 Erik Blaufuss
lbnecmd check
638 202 Erik Blaufuss
</pre>
639 202 Erik Blaufuss
Normal output will look like:
640 202 Erik Blaufuss
<pre>
641 202 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 daqarea]$ lbnecmd check
642 202 Erik Blaufuss
lbnecontrol: Available
643 202 Erik Blaufuss
CfgMgr: Available
644 202 Erik Blaufuss
DAQInterface: Available
645 202 Erik Blaufuss
TDUControl: Available
646 202 Erik Blaufuss
647 202 Erik Blaufuss
daqint@localhost:5570 (synchronous): stopped
648 202 Erik Blaufuss
</pre>
649 202 Erik Blaufuss
If you see errors such as:
650 202 Erik Blaufuss
<pre>
651 202 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check 
652 202 Erik Blaufuss
check failed: 'timed out'. Is lbnecontrol running? 
653 202 Erik Blaufuss
</pre>
654 202 Erik Blaufuss
or 
655 202 Erik Blaufuss
<pre>
656 202 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check 
657 202 Erik Blaufuss
check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?
658 202 Erik Blaufuss
</pre>
659 202 Erik Blaufuss
You'll need to restart/start the lbnecontrol server. First make sure it's stopped:
660 202 Erik Blaufuss
<pre>
661 202 Erik Blaufuss
> lbnecmd kill
662 202 Erik Blaufuss
</pre>
663 202 Erik Blaufuss
Then start it:
664 202 Erik Blaufuss
<pre>
665 202 Erik Blaufuss
> lbnecmd launch
666 202 Erik Blaufuss
</pre>
667 202 Erik Blaufuss
If you run into errors like:
668 202 Erik Blaufuss
<pre>
669 202 Erik Blaufuss
> lbnecmd launch
670 202 Erik Blaufuss
Control program is running or stale process file (/tmp/lbnecontrol.pid) exists!
671 202 Erik Blaufuss
</pre>
672 202 Erik Blaufuss
Make sure the lbnecontrol process is dead.
673 202 Erik Blaufuss
<pre>
674 202 Erik Blaufuss
> ps -ef |grep lbnecontrol |grep -v grep
675 202 Erik Blaufuss
</pre>
676 202 Erik Blaufuss
 If it's still there, you can kill it (kill <PID>), then remove the lock file and restart lbnecontrol:
677 202 Erik Blaufuss
<pre>
678 202 Erik Blaufuss
> rm /tmp//tmp/lbnecontrol.pid
679 202 Erik Blaufuss
> lbnecmd launch
680 202 Erik Blaufuss
</pre>
681 202 Erik Blaufuss
682 45 John Freeman
h3.  No real configurations are listed by RunControl
683 49 Erik Blaufuss
684 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
685 49 Erik Blaufuss
<pre>
686 45 John Freeman
Available configs (Name : description)
687 49 Erik Blaufuss
688 1 John Freeman
dummy : Dummy description
689 168 John Freeman
</pre>
690 147 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"
691 169 John Freeman
692 170 John Freeman
h3. "lbnecmd check" returns "@Unknown exception '<ProtocolError for localhost:50008/RPC2: -1 >'@"
693 171 John Freeman
694 169 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".
695 147 John Freeman
696 148 John Freeman
h2.  Common DAQInterface issues
697 148 John Freeman
698 185 John Freeman
As a preliminary: if something goes wrong when running the DAQ, there are two valuable sources of information:
699 146 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. 
700 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)
701 173 John Freeman
702 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:
703 173 John Freeman
<pre>
704 173 John Freeman
DAQInterface: "Recover" transition underway
705 173 John Freeman
JCF, 6/12/14 -- for now at least, "Recover" simply kills the artdaq processes
706 173 John Freeman
707 173 John Freeman
Recover transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
708 173 John Freeman
</pre>
709 175 John Freeman
710 173 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. 
711 184 John Freeman
712 197 John Freeman
h3. *Whenever you try to initialize, right after initialization DAQInterface immediately enters recovery mode*
713 197 John Freeman
714 197 John Freeman
Specifically, you'll see something like the following:
715 197 John Freeman
<pre>
716 197 John Freeman
Fri Nov 20 18:16:32 CST 2015: Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
717 197 John Freeman
718 197 John Freeman
Fri Nov 20 18:16:33 CST 2015: DAQInterface: "Recover" transition underway
719 197 John Freeman
JCF, 6/12/14 -- for now at least, "Recover" simply kills the artdaq processes
720 197 John Freeman
JCF, 10/21/15 -- have now added an attempted stop transition
721 197 John Freeman
722 197 John Freeman
Fri Nov 20 18:16:50 CST 2015: Recover transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
723 197 John Freeman
</pre>
724 197 John Freeman
725 197 John Freeman
This happens because on a previous run, DAQInterface threw an exception. As of Nov-20-2015, the most common cause of this is that it was unable to send a requested transition to an artdaq process because the process wasn't responding- a very common cause of this is a buildup of incomplete events in the eventbuilders. The only thing to do here is to kill and relaunch DAQInterface. 
726 197 John Freeman
727 184 John Freeman
h3. *On the initialize transition ("lbnecmd init daq") you see "Unclean working configuration directory /data/lbnedaq/config/ found"*
728 184 John Freeman
729 195 John Freeman
This means that the subdirectory of /data/lbnedaq/config corresponding to the active configuration has been edited 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. 
730 184 John Freeman
731 205 John Freeman
h3. *On the initialize transition, you see "<code>pmt.rb -p <port number> was already running on <hostname></code>"*
732 205 John Freeman
733 205 John Freeman
This is not a problem in and of itself, as DAQInterface will simply enter the recovery procedure and return you to the "stopped" state, where the next initialization will proceed normally. For the curious: what this message means is that 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. 
734 205 John Freeman
735 1 John Freeman
h3. *On the initialize transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
736 1 John Freeman
737 180 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.
738 180 John Freeman
739 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?@"*
740 180 John Freeman
741 146 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.)
742 146 John Freeman
743 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*
744 182 John Freeman
745 1 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. 
746 1 John Freeman
747 1 John Freeman
{{collapse(Of developer interest)
748 1 John Freeman
h3.  *Error handling*
749 1 John Freeman
750 1 John Freeman
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
751 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
752 51 John Freeman
# During periodic checks, one or more artdaq processes expected to exist are not found
753 84 John Freeman
754 77 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). 
755 77 John Freeman
756 1 John Freeman
h3. *Your change to the DAQInterface configuration file or the daqinterface.py code doesn't seem to do anything*
757 146 John Freeman
758 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
759 1 John Freeman
760 183 John Freeman
}}
761 183 John Freeman
762 183 John Freeman
h2. Common lbne-artdaq issues
763 183 John Freeman
764 183 John Freeman
h3. The message "Failed to connect to shared memory segment" appears in the logfile
765 183 John Freeman
766 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:
767 183 John Freeman
<pre>
768 183 John Freeman
------ Shared Memory Segments --------
769 183 John Freeman
key        shmid      owner      perms      bytes      nattch     status      
770 183 John Freeman
0x40471518 4161536    lbnedaq    666        16777216   0          
771 183 John Freeman
</pre>
772 1 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. 
773 194 John Freeman
774 194 John Freeman
h3. The message "An exception occurred when trying to send a message to 131.225.177.29:30000" appears in the logfile
775 1 John Freeman
776 199 John Freeman
Port 30000 is the port on which MessageFacility MessageViewer communicates; this above message appears if the MessageViewer window has been closed, and the DAQ is trying to send a message to MessageViewer. It's not a concern from a practical standpoint- it simply means that DAQInterface should be killed and restarted in order to pop up a new MessageViewer window.