From 1e36675be57d3d9012fd862cea46afa2928d19cf Mon Sep 17 00:00:00 2001
From: Michael Davidsaver <mdavidsaver@gmail.com>
Date: Fri, 24 Mar 2023 08:31:57 -0700
Subject: [PATCH] qsrv: import softMain.cpp from Base circa 7.0.7

---
 qsrv/makeInstallDir.pl |  28 +++++
 qsrv/softIocPVXExit.db |  15 +++
 qsrv/softMain.cpp      | 277 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 320 insertions(+)
 create mode 100644 qsrv/makeInstallDir.pl
 create mode 100644 qsrv/softIocPVXExit.db
 create mode 100644 qsrv/softMain.cpp

diff --git a/qsrv/makeInstallDir.pl b/qsrv/makeInstallDir.pl
new file mode 100644
index 0000000..32f5dfe
--- /dev/null
+++ b/qsrv/makeInstallDir.pl
@@ -0,0 +1,28 @@
+#!/usr/bin/env perl
+#*************************************************************************
+# Copyright (c) 2010 UChicago Argonne LLC, as Operator of Argonne
+#     National Laboratory.
+# SPDX-License-Identifier: EPICS
+# EPICS BASE is distributed subject to a Software License Agreement found
+# in file LICENSE that is included with this distribution.
+#*************************************************************************
+
+use strict;
+
+die "$0: Argument missing, INSTALL_LOCATION\n" if @ARGV == 0;
+die "$0: Too many arguments, expecting one\n" unless @ARGV == 1;
+
+my $path = shift;
+
+$path =~ s/\\/\\\\/gx;
+$path =~ s/^'//;
+$path =~ s/'$//;
+
+print "/* THIS IS A GENERATED FILE. DO NOT EDIT! */\n",
+      "\n",
+      "#ifndef INC_epicsInstallDir_H\n",
+      "#define INC_epicsInstallDir_H\n",
+      "\n",
+      "#define EPICS_BASE \"$path\"\n",
+      "\n",
+      "#endif /* INC_epicsInstallDir_H */\n";
diff --git a/qsrv/softIocPVXExit.db b/qsrv/softIocPVXExit.db
new file mode 100644
index 0000000..c530f77
--- /dev/null
+++ b/qsrv/softIocPVXExit.db
@@ -0,0 +1,15 @@
+# softIocExit.db
+
+record(sub,"$(IOC):exit") {
+    field(DESC,"Exit subroutine")
+    field(SCAN,"Passive")
+    field(SNAM,"exit")
+}
+
+record(stringin,"$(IOC):BaseVersion") {
+    field(DESC,"EPICS Base Version")
+    field(DTYP,"getenv")
+    field(INP,"@EPICS_VERSION_FULL")
+    field(PINI,"YES")
+    field(DISP,1)
+}
diff --git a/qsrv/softMain.cpp b/qsrv/softMain.cpp
new file mode 100644
index 0000000..11eb761
--- /dev/null
+++ b/qsrv/softMain.cpp
@@ -0,0 +1,277 @@
+/*************************************************************************\
+* Copyright (c) 2008 UChicago Argonne LLC, as Operator of Argonne
+*     National Laboratory.
+* Copyright (c) 2003 The Regents of the University of California, as
+*     Operator of Los Alamos National Laboratory.
+* SPDX-License-Identifier: EPICS
+* EPICS BASE is distributed subject to the Software License Agreement
+* found in the file LICENSE that is included with this distribution.
+\*************************************************************************/
+
+/* Author: Andrew Johnson   Date: 2003-04-08 */
+
+#include <iostream>
+#include <string>
+#include <list>
+#include <stdexcept>
+
+#include <epicsGetopt.h>
+#include "registryFunction.h"
+#include "epicsThread.h"
+#include "epicsExit.h"
+#include "epicsStdio.h"
+#include "epicsString.h"
+#include "dbStaticLib.h"
+#include "subRecord.h"
+#include "dbAccess.h"
+#include "asDbLib.h"
+#include "iocInit.h"
+#include "iocsh.h"
+#include "osiFileName.h"
+#include "epicsInstallDir.h"
+
+extern "C" int softIoc_registerRecordDeviceDriver(struct dbBase *pdbbase);
+
+#ifndef EPICS_BASE
+// so IDEs knows EPICS_BASE is a string constant
+#  define EPICS_BASE "/"
+#  error -DEPICS_BASE required
+#endif
+
+#define DBD_BASE "dbd" OSI_PATH_SEPARATOR "softIoc.dbd"
+#define EXIT_BASE "db" OSI_PATH_SEPARATOR "softIocExit.db"
+#define DBD_FILE_REL ".." OSI_PATH_SEPARATOR ".." OSI_PATH_SEPARATOR DBD_BASE
+#define EXIT_FILE_REL ".." OSI_PATH_SEPARATOR ".." OSI_PATH_SEPARATOR EXIT_BASE
+#define DBD_FILE EPICS_BASE OSI_PATH_SEPARATOR DBD_BASE
+#define EXIT_FILE EPICS_BASE OSI_PATH_SEPARATOR EXIT_BASE
+
+namespace {
+
+bool verbose = false;
+
+static void exitSubroutine(subRecord *precord) {
+    epicsExitLater((precord->a == 0.0) ? EXIT_SUCCESS : EXIT_FAILURE);
+}
+
+void usage(const char *arg0, const std::string& base_dbd) {
+    std::cout<<"Usage: "<<arg0<<
+               " [-D softIoc.dbd] [-h] [-S] [-s] [-v] [-a ascf]\n"
+               "[-m macro=value,macro2=value2] [-d file.db]\n"
+               "[-x prefix] [st.cmd]\n"
+               "\n"
+               "    -D <dbd>  If used, must come first. Specify the path to the softIoc.dbdfile."
+               "        The compile-time install location is saved in the binary as a default.\n"
+               "\n"
+               "    -h  Print this mesage and exit.\n"
+               "\n"
+               "    -S  Prevents an interactive shell being started.\n"
+               "\n"
+               "    -s  Previously caused a shell to be started.  Now accepted and ignored.\n"
+               "\n"
+               "    -v  Verbose, display steps taken during startup.\n"
+               "\n"
+               "    -a <acf>  Access Security configuration file.  Macro substitution is\n"
+               "        performed.\n"
+               "\n"
+               "    -m <MAC>=<value>,... Set/replace macro definitions used by subsequent -d and\n"
+               "        -a.\n"
+               "\n"
+               "    -d <db>  Load records from file (dbLoadRecords).  Macro substitution is\n"
+               "        performed.\n"
+               "\n"
+               "    -x <prefix>  Load softIocExit.db.  Provides a record \"<prefix>:exit\".\n"
+               "        Put 0 to exit with success, or non-zero to exit with an error.\n"
+               "\n"
+               "Any number of -m and -d arguments can be interspersed; the macros are applied\n"
+               "to the following .db files.  Each later -m option causes earlier macros to be\n"
+               "discarded.\n"
+               "\n"
+               "A st.cmd file is optional.  If any databases were loaded the st.cmd file will\n"
+               "be run *after* iocInit.  To perform iocsh commands before iocInit, all database\n"
+               "loading must be performed by the script itself, or by the user from the\n"
+               "interactive IOC shell.\n"
+               "\n"
+               "Compiled-in path to softIoc.dbd is:\n"
+               "\t"<<base_dbd.c_str()<<"\n";
+}
+
+void errIf(int ret, const std::string& msg)
+{
+    if(ret)
+        throw std::runtime_error(msg);
+}
+
+bool lazy_dbd_loaded;
+
+void lazy_dbd(const std::string& dbd_file) {
+    if(lazy_dbd_loaded) return;
+    lazy_dbd_loaded = true;
+
+    if (verbose)
+        std::cout<<"dbLoadDatabase(\""<<dbd_file<<"\")\n";
+    errIf(dbLoadDatabase(dbd_file.c_str(), NULL, NULL),
+          std::string("Failed to load DBD file: ")+dbd_file);
+
+    if (verbose)
+        std::cout<<"softIoc_registerRecordDeviceDriver(pdbbase)\n";
+    errIf(softIoc_registerRecordDeviceDriver(pdbbase),
+          "Failed to initialize database");
+    registryFunctionAdd("exit", (REGISTRYFUNCTION) exitSubroutine);
+}
+
+} // namespace
+
+int main(int argc, char *argv[])
+{
+    try {
+        std::string dbd_file(DBD_FILE),
+                    exit_file(EXIT_FILE),
+                    macros, // scratch space for macros (may be given more than once)
+                    xmacro;
+        bool interactive = true;
+        bool loadedDb = false;
+        bool ranScript = false;
+
+        // attempt to compute relative paths
+        {
+            std::string prefix;
+            char *cprefix = epicsGetExecDir();
+            if(cprefix) {
+                try {
+                    prefix = cprefix;
+                    free(cprefix);
+                } catch(...) {
+                    free(cprefix);
+                    throw;
+                }
+            }
+
+            dbd_file = prefix + DBD_FILE_REL;
+            exit_file = prefix + EXIT_FILE_REL;
+        }
+
+        int opt;
+
+        while ((opt = getopt(argc, argv, "ha:D:d:m:Ssx:v")) != -1) {
+            switch (opt) {
+            case 'h':               /* Print usage */
+                usage(argv[0], dbd_file);
+                epicsExit(0);
+                return 0;
+            default:
+                usage(argv[0], dbd_file);
+                std::cerr<<"Unknown argument: -"<<char(opt)<<"\n";
+                epicsExit(2);
+                return 2;
+            case 'a':
+                lazy_dbd(dbd_file);
+                if (!macros.empty()) {
+                    if (verbose)
+                        std::cout<<"asSetSubstitutions(\""<<macros<<"\")\n";
+                    if(asSetSubstitutions(macros.c_str()))
+                        throw std::bad_alloc();
+                }
+                if (verbose)
+                    std::cout<<"asSetFilename(\""<<optarg<<"\")\n";
+                if(asSetFilename(optarg))
+                    throw std::bad_alloc();
+                break;
+            case 'D':
+                if(lazy_dbd_loaded) {
+                    throw std::runtime_error("-D specified too late.  softIoc.dbd already loaded.\n");
+                }
+                dbd_file = optarg;
+                break;
+            case 'd':
+                lazy_dbd(dbd_file);
+                if (verbose) {
+                    std::cout<<"dbLoadRecords(\""<<optarg<<"\"";
+                    if(!macros.empty())
+                        std::cout<<", \""<<macros<<"\"";
+                    std::cout<<")\n";
+                }
+                errIf(dbLoadRecords(optarg, macros.c_str()),
+                      std::string("Failed to load: ")+optarg);
+                loadedDb = true;
+                break;
+            case 'm':
+                macros = optarg;
+                break;
+            case 'S':
+                interactive = false;
+                break;
+            case 's':
+                break; // historical
+            case 'v':
+                verbose = true;
+                break;
+            case 'x':
+                lazy_dbd(dbd_file);
+                xmacro  = "IOC=";
+                xmacro += optarg;
+                if (verbose) {
+                    std::cout<<"dbLoadRecords(\""<<exit_file<<"\", \""<<xmacro<<"\")\n";
+                }
+                errIf(dbLoadRecords(exit_file.c_str(), xmacro.c_str()),
+                      std::string("Failed to load: ")+exit_file);
+                loadedDb = true;
+                break;
+            }
+        }
+
+        lazy_dbd(dbd_file);
+
+        if(optind<argc)  {
+            // run script
+            // ignore any extra positional args (historical)
+
+            if (verbose)
+                std::cout<<"# Begin "<<argv[optind]<<"\n";
+            errIf(iocsh(argv[optind]),
+                        std::string("Error in ")+argv[optind]);
+            if (verbose)
+                std::cout<<"# End "<<argv[optind]<<"\n";
+
+            epicsThreadSleep(0.2);
+            ranScript = true;    /* Assume the script has done any necessary initialization */
+        }
+
+        if (loadedDb) {
+            if (verbose)
+                std::cout<<"iocInit()\n";
+            iocInit();
+            epicsThreadSleep(0.2);
+        }
+
+        if(interactive) {
+            std::cout.flush();
+            std::cerr.flush();
+            if(iocsh(NULL)) {
+                epicsExit(1);
+                return 1;
+            }
+
+        } else {
+            if (loadedDb || ranScript) {
+                // non-interactive IOC.  spin forever
+                while(true) {
+                    epicsThreadSleep(1000.0);
+                }
+
+            } else {
+                usage(argv[0], dbd_file);
+                std::cerr<<"Nothing to do!\n";
+                epicsExit(1);
+                return 1;
+            }
+        }
+
+        epicsExit(0);
+        return 0;
+
+    }catch(std::exception& e){
+        std::cerr<<"Error: "<<e.what()<<"\n";
+        epicsExit(2);
+        return 2;
+    }
+}