sphinx documentation skeleton

See merge request cds/advligorts!128

Have the cmake install process install a frame wiper and daq ini file archiver.

See merge request cds/advligorts!131

Request that services start after remote-fs.target is reached.

See merge request cds/advligorts!130

These are utility scripts used when running the daqd.

checkdaqconfig - freezes the config, archiving it by time & contents
daq_wiper - this deletes old frames to keep disks from filling on a frame writer

Done for:
 * daqd
 * nds
 * local_dc
 * edc

This is the python3 script used at LHO for frame wipping.  Moving it from userapps to the advligorts repository.

This script is responsible for running every hour and freeing up space on the disk system for new frames.

Sphinx is a documentation generator using reStructuredText:

https://www.sphinx-doc.org/en/master/index.html
https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html

This builds out the initial skeleton of the documentation.  Changes
can be tested by running make in the documentation tree:

 $ cd doc2
 $ make html

The generated pages are available at

 doc2/_build/html/index.html

This also include gitlab CI to build the documentation at publish it
at the gitlab documentation pages:

 https://cds.docs.ligo.org/advligorts/

- Added daq_prefix option for Parameter block.  This allows proper
  creation of GDSTP screen DAQ info for systems that do not connect
  to the standard DAQ-DC0.

- Fix for 1PPS sync.

- Removed GeFanuc RFM code from controllerIOP.c as no longer supported.
- Update to ADC startup when using external clock w/o 1PPS sync.

signal on last channel of first ADC for time synchonization.

Adding more epics diagnostics to the daqd

See merge request cds/advligorts!127

PRDCR_UNIQUE_DCU_REPORTED_PER_S -> the number of dcus that reported at least once in the last second
PRDCR_TOTAL_DCU_REPORTED_PER_S -> the count of dcus that reported in the last second.  In good conditions this should be 16*PRDCR_UNIQUE_DCU_REPORTED_PER_S

PRDCR_TOTAL_DATA_RATE_KB_PER_S -> the total data rate over the last second in kb (excludes < 1kb of headers a second)
PRDCR_TP_DATA_RATE_KB_PER_S -> the data rate of test point data over the last second in kb
PRDCR_MODEL_DATA_RATE_KB_PER_S -> the data rate of the regular model data over the last second in kb

PRDCR_OPEN_TP_COUNT -> the count of test points opened sampled once per second

checkdaqconfig.py: Added unit tests.  Accepts hardcoded paths in master templates.

See merge request cds/advligorts!126

added some unit tests for checkdaqconfig.py.  Now accepts hardcoded paths in master template, but will look in expected paths if the paths in the file are dummies (template variables for example).

Add script for archiving daq configs when using multiple DAQs.

See merge request cds/advligorts!125

Erik von Reis authored 4 years ago and Jonathan Hanks committed 4 years ago

adding script for archiving daq configs when using multiple DAQs.  Script uses a hash to dermine when to update archives.  Manages separte pointers for each DAQ.

Will not install modules with dcuid >= 256.

Closes #125

See merge request cds/advligorts!124

required to compile IOP to run at 128K and user apps to receive
data at this higher rate.

control models running with the higher rate IOP.  To make this change,
certain defines were moved from header files to the feCodeGen itself
to avoid introducing more ifdefs in the code.

Closes #128, the daqd exits if a gds broadcast list is specified with channels that do not exist.

Closes #128

See merge request cds/advligorts!123

fix path to run number state

See merge request cds/advligorts!120

built with no I/O chassis flag.

More work on #96.  Correctly set the trender stop flag when stopping the trender.

See merge request cds/advligorts!121

Changed heartbeat loop to eliminate race condition at end of second

See merge request cds/advligorts!122

Update the test to check if daqd stops on a timestamp jump to give a proper return value on success.

changed heartbeat loop to eliminate race condition where end-of-epoch test for epoch 15 might succeed immediately, triggering rapid heartbeats every 10 ms for the next 60+ ms.

The stopping_now_ flag should be set to true to signal trender threads to stop.

Also move some stack based variable sized arrays onto the heap in std::vectors to remove a place that the stack can be overflowed.

Added a test to ensure the daqd stops when there is a jump in the data, and updated the live test daqdrc to start the trender thread to highlight issues with stopping.

Make gds broadcasts work

See merge request cds/advligorts!119

Historically, there have been two main types of broadcasts in daqd, the DC data stream (the 10Gb udp broadcast) and the GDS frame transfer.  When DATA_CONCENTRATOR was defined only the DC data stream is used.  This mode has been removed from the daq architecture.  So the only remaining broadcast mode should be the GDS frame transfer.

The big difference between the two broadcast methods is the data source.  For the DC stream the source is the main circular buffer.  For the GDS the data source is a frame file that the framer_io function mmaps and pushes as a block of memory.

There were several modes of operation for the daqd, and DATA_CONCENTRATOR was picked when collapsing the daqd down to one binary.  So remove support for the DC data stream.
 * Removes support for broadcasting testpoints
 * Removes the udp broadcast logic for the DC stream
 * Removes a number of #if DATA_CONCENTOR macro guards
 * Removes a number of #if GDS_TESTPOINT macro guards

 The final flow of the broadcast data is now as follows:

 the parser sees the request for the net-writer with a broadcast address.
 This triggers a net writer to be created, a producer thread to start, a circular buffer to be created.  The producer copies data from the main circular buffer and unlocks the main circular buffer it puts into the new circular buffer with a nowait put operation (which is allowed to fail).  Nothing has ever emptied this, so a consumer thread is not launched (it didn't do anything anyways).

For some reason the systemd unit parsing does not pick up the
STATE_DIRECTORY environment variable, so we have to expand manually.