require-ess/tools/expandDBD.tcl

-#!/usr/bin/env tclsh
-
-package require Tclx
-
-set global_context [scancontext create]
-
-set epicsversion 3.14
-set quiet 0
-set recordtypes 0
-set seachpath {}
-set filesDone {}
-
-while {[llength $argv]} {
-    switch -glob -- [lindex $argv 0] {
-        "-[0-9]*" { set epicsversion [string range [lindex $argv 0] 1 end]}
-        "-q"      { set quiet 1 }
-        "-r"      { set recordtypes 1; set quiet 1 }
-        "-I"      { lappend seachpath [lindex $argv 1]; set argv [lreplace $argv 0 1]; continue }
-        "-I*"     { lappend seachpath [string range [lindex $argv 0] 2 end] }
-        "--"      { set argv [lreplace $argv 0 0]; break }
-        "-*"      { puts stderr "Warning: Unknown option [lindex $argv 0] ignored" }
-        default   { break }
-    }
-    set argv [lreplace $argv 0 0]
-}
-
-proc opendbd {name} {
-    global seachpath
-    foreach dir $seachpath {
-        if ![catch {
-            set file [open [file join $dir $name]]
-        }] {
-            return $file
-        }
-    }
-    return -code error "file $name not found"
-}
-
-scanmatch $global_context {^[ \t]*(#|%|$)} {
-    continue
-}
-
-if {$recordtypes} {
-    scanmatch $global_context {include[ \t]+"?((.*)Record.dbd)"?} {
-    if ![catch {
-        close [opendbd $matchInfo(submatch0)]
-    }] {
-        puts $matchInfo(submatch1)
-    }
-    continue
-}
-
-} else {
-
-    scanmatch $global_context {(registrar|variable|function)[ \t]*\([ \t]*"?([a-zA-Z0-9_]+)"?[ \t]*\)} {
-        global epicsversion
-        if {$epicsversion > 3.13} {puts $matchInfo(submatch0)($matchInfo(submatch1))}
-    }
-    scanmatch $global_context {variable[ \t]*\([ \t]*"?([a-zA-Z0-9_]+)"?[ \t]*,[ \t]*"?([a-zA-Z0-9_]+)"?[ \t]*\)} {
-        global epicsversion
-        if {$epicsversion > 3.13} {puts variable($matchInfo(submatch0),$matchInfo(submatch1))}
-    }
-
-    scanmatch $global_context {
-        puts $matchInfo(line)
-    }
-}
-
-scanmatch $global_context {include[ \t]+"?([^"]*)"?} {
-    global seachpath
-    global FileName
-    global quiet
-    if [catch {
-        includeFile $global_context $matchInfo(submatch0)
-    } msg] {
-        if {!$quiet} {
-            puts stderr "ERROR: $msg in path \"$seachpath\" called from $FileName($matchInfo(handle)) line $matchInfo(linenum)"
-            exit 1
-        }
-    }
-    continue
-}
-
-proc includeFile {context filename} {
-    global global_context FileName filesDone matchInfo quiet
-    set basename [file tail $filename]
-    if {[lsearch $filesDone $basename ] != -1} {
-        if {!$quiet} {
-            puts stderr "Info: skipping duplicate file $basename included from $FileName($matchInfo(handle))"
-        }
-        return
-    }
-    if {$filename != "dbCommon.dbd"} { lappend filesDone [file tail $filename] }
-    set file [opendbd $filename]
-    set FileName($file) $filename
-    #puts "#include $filename from $FileName($matchInfo(handle))"
-    scanfile $context $file
-    close $file
-}
-
-foreach filename $argv {
-    global filesDone quiet
-    set basename [file tail $filename]
-    if {[lsearch $filesDone $basename] != -1} {
-        if {!$quiet} {
-            puts stderr "Info: skipping duplicate file $basename from command line"
-        }
-        continue
-    }
-    if {$basename != "dbCommon.dbd"} { lappend filesDone $basename }
-    set file [open $filename]
-    set FileName($file) $filename
-    scanfile $global_context $file
-    close $file
-}

require-ess/tools/iocsh

-#!/bin/bash
-#
-#  Copyright (c) 2004 - 2017    Paul Scherrer Institute
-#  Copyright (c) 2017 - 2019    European Spallation Source ERIC
-#
-#  The program is free software: you can redistribute
-#  it and/or modify it under the terms of the GNU General Public License
-#  as published by the Free Software Foundation, either version 2 of the
-#  License, or any newer version.
-#
-#  This program is distributed in the hope that it will be useful, but WITHOUT
-#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
-#  more details.
-#
-#  You should have received a copy of the GNU General Public License along with
-#  this program. If not, see https://www.gnu.org/licenses/gpl-2.0.txt
-#
-#
-#  PSI original iocsh author : Dirk Zimoch
-#  ESS specific iocsh author : Jeong Han Lee
-#                     email  : han.lee@esss.se
-#
-#  Add IOCSH_TOP in order to access where the iocsh is executed
-#  Thursday, May 31 00:04:07 CEST 2018, jhlee
-#
-#  Add PVA support to call softIOCPVA if BASE >= 7.0.1.1
-#  Tuesday, October  2 14:26:49 CEST 2018, jhlee
-
-#  Tweak REQUIRE PVs to be an unique per a single IOC in OS
-#  Set Hostname up to 30 chars
-#  Thursday, October  4 17:00:53 CEST 2018, jhlee
-#
-#  0.3.5 : Set the proper limitation of REQUIRE PV name
-#  0.3.6 : In case, we know where $0 is, sourcing setE3Env.bash by itself
-#  0.3.7 : Introduce the local mode with -l
-#  0.3.8 : Use mktemp, and protect iocsh when there is no diskspace
-#  0.3.9 : LD_BIND_NOW=1 for resolving symbols at startup.
-#  0.4.0 : - Fixed registryJLinkAdd failed pva error from base 7.0.3
-#          - Enable an exit subroutine for sotfioc
-#            Wednesday, September 11 17:27:59 CEST 2019
-#  0.4.1 : - Use the one BASHPID for iocsh
-#  0.4.2 : - Use the secure path within tmp, but it may create "disk full" in the long
-#            term if each IOC cannot be closed properly
-#  0.4.3 : - Tune REQUIRE-* PV in order to replace - with . easily
-#
-
-SC_SCRIPT="$(readlink -e "$0")"
-SC_SCRIPTNAME=${0##*/}
-SC_TOP="${SC_SCRIPT%/*}"
-TMP_PATH="/tmp/systemd-private-e3-iocsh-$(whoami)"
-declare -r SC_SCRIPT SC_SCRIPTNAME SC_TOP TMP_PATH
-declare SC_VERSION="${E3_REQUIRE_VERSION}"
-declare BASECODE=""
-
-# shellcheck source=require-ess/tools/iocsh_functions.bash
-. "${SC_TOP}"/iocsh_functions.bash
-
-# To get the absolute path where iocsh is executed
-IOCSH_TOP=${PWD}
-
-# Check whether an expected e3 environment variable is defined.
-#
-if [[ -z "${EPICS_DRIVER_PATH}" ]]; then
-  set -a
-  # shellcheck source=require-ess/tools/setE3Env.bash
-  . "${SC_TOP}"/setE3Env.bash "no_msg"
-  set +a
-fi
-
-# Check that the e3 environment definition and the path for this script
-# are consistent
-if [ "${E3_REQUIRE_BIN}" != "${SC_TOP}" ]; then
-  echo "Error: Configured e3 environment does not match path for iocsh executable."
-  echo "Please source the appropriate setE3Env.bash file for the version of iocsh"
-  echo "you wish to use, or run iocsh from a clean environment so it can set the"
-  echo "environment correctly."
-  echo "Expected path to iocsh from environment = ${E3_REQUIRE_BIN}"
-  echo "Actual path to iocsh = ${SC_TOP}"
-  die 2
-fi
-
-BASECODE="$(basecode_generator)"
-
-check_mandatory_env_settings
-
-# ${BASHPID} returns iocsh PID
-iocsh_id=${BASHPID}
-#
-SC_VERSION+=-PID-${iocsh_id}
-
-#
-# We define HOSTNAME + iocsh_id
-IOCSH_PS1=$(iocsh_ps1 "${iocsh_id}")
-REQUIRE_IOC=$(require_ioc "${iocsh_id}")
-#
-# Default Initial Startup file for REQUIRE and minimal environment
-# Create TMP_PATH path in order to keep tmp files secure until
-# an IOC will be closed.
-
-mkdir -p "${TMP_PATH}"
-
-IOC_STARTUP=$(mktemp -p "${TMP_PATH}" -q --suffix=_iocsh_${SC_VERSION}) || die 1 "${SC_SCRIPTNAME} CANNOT create the startup file, please check the disk space"
-
-# EPICS_DRIVER_PATH defined in iocsh and startup.script_common
-# Remember, driver is equal to module, so EPICS_DRIVER_PATH is the module directory
-# In our jargon. It is the same as ${EPICS_MODULES}
-
-# shellcheck disable=SC2064
-trap "softIoc_end ${IOC_STARTUP}" EXIT HUP INT TERM
-
-{
-  printIocEnv
-  printf "# Set REQUIRE_IOC for its internal PVs\n"
-  printf "epicsEnvSet REQUIRE_IOC \"%s\"\n" "${REQUIRE_IOC}"
-  printf "#\n"
-  printf "# Enable an exit subroutine for sotfioc\n"
-  printf "dbLoadRecords \"%s/db/softIocExit.db\" \"IOC=%s\"\n" "${EPICS_BASE}" "${REQUIRE_IOC}"
-  printf "#\n"
-  printf "# Set E3_IOCSH_TOP for the absolute path where %s is executed.\n" "${SC_SCRIPTNAME}"
-  printf "epicsEnvSet E3_IOCSH_TOP \"%s\"\n" "${IOCSH_TOP}"
-  printf "#\n"
-
-  loadRequire
-
-  loadFiles "$@"
-
-  printf "# Set the IOC Prompt String One \n"
-  printf "epicsEnvSet IOCSH_PS1 \"%s\"\n" "$IOCSH_PS1"
-  printf "#\n"
-
-  if [ "$REALTIME" == "RT" ]; then
-    printf "# Real Time \"%s\"\n" "$REALTIME"
-  fi
-
-  if [ "$init" != NO ]; then
-    printf "# \n"
-    printf "iocInit\n"
-  fi
-
-} >"${IOC_STARTUP}"
-
-ulimit -c unlimited
-
-if [ "$REALTIME" == "RT" ]; then
-  export LD_BIND_NOW=1
-  printf "## \n"
-  printf "## Better support for Real-Time IOC Application.\n"
-  printf "## Now we set 'export LD_BIND_NOW=%s'\n" "$LD_BIND_NOW"
-  printf "## If one may meet the 'Operation not permitted' message, \n"
-  printf "## please run %s without the real-time option\n" "$SC_SCRIPTNAME"
-  printf "##\n"
-fi
-
-if [[ ${BASECODE} -ge 07000101 ]]; then
-  __PVA__="PVA"
-else
-  __PVA__=""
-fi
-
-#
-#
-# shellcheck disable=SC2086
-${__LOADER__}${EPICS_BASE}/bin/${EPICS_HOST_ARCH}/softIoc${__PVA__} -D ${EPICS_BASE}/dbd/softIoc${__PVA__}.dbd "${IOC_STARTUP}" 2>&1
+#! /usr/bin/env python3
+"""Entry point for the IOC shell."""
+
+import argparse
+import os
+import logging
+from pathlib import Path
+import subprocess
+import sys
+import re
+from typing import List
+
+from iocsh_utils import verify_environment_and_return_require_version
+from iocsh_utils import TemporaryStartupScript
+from iocsh_utils import generate_banner
+
+
+def iocsh(
+    file: Path,
+    module: List[str],
+    command: List[str],
+    database: List[Path],
+    cell_path: List[Path],
+    no_init: bool,
+    iocname: str,
+    gdb: str,
+    valgrind: str,
+    debug: bool,
+):
+    with TemporaryStartupScript(iocname) as tmp_startup_script:
+        require_version = verify_environment_and_return_require_version()
+        epics_base_dir = Path(os.environ["EPICS_BASE"])
+
+        print(generate_banner())
+        print(f"Starting e3 IOC shell version {require_version}")
+        logging.debug(f"PID for iocsh {os.getpid()}")
+        logging.debug(f"Script path is {Path(__file__).resolve()}")
+        logging.debug(f"Executed from {Path.cwd()}")
+        logging.debug(f"Temporary startup script at {tmp_startup_script.name}")
+
+        if cell_path:
+            cell_paths = ":".join(
+                [
+                    str(
+                        p.resolve() / epics_base_dir.name / f"require-{require_version}"
+                    )
+                    for p in reversed(cell_path)
+                ]
+            )
+            try:
+                new_path = f"{cell_paths}:{os.environ['EPICS_DRIVER_PATH']}"
+            except KeyError:
+                new_path = cell_paths
+            tmp_startup_script.set_variable("EPICS_DRIVER_PATH", new_path)
+
+        if debug:
+            tmp_startup_script.add_command("var requireDebug 1")
+
+        for entry in module:
+            tmp_startup_script.load_module(entry)
+
+        if file:
+            if not file.exists():
+                logging.debug(f"File {file} does not exist. Exiting.")
+                sys.exit(-1)
+            tmp_startup_script.set_variable("E3_CMD_TOP", str(file.parent.resolve()))
+            tmp_startup_script.load_snippet(file)
+
+        for entry in command:
+            tmp_startup_script.add_command(entry)
+
+        for entry in database:
+            tmp_startup_script.load_database(entry)
+
+        if not no_init:
+            # if file isn't passed we shouldn't try to read its' content
+            if (
+                not file
+                or re.search(r"^\s*iocInit\b", file.read_text(), flags=re.MULTILINE)
+                is None
+            ):
+                tmp_startup_script.add_command("iocInit")
+
+        tmp_startup_script.save()
+
+        cmd = [
+            str(epics_base_dir / "bin" / os.environ["EPICS_HOST_ARCH"] / "softIocPVA"),
+            "-D",
+            str(epics_base_dir / "dbd" / "softIocPVA.dbd"),
+            tmp_startup_script.name,
+        ]
+
+        if gdb is not None:
+            cmd = ["gdb"] + gdb.split(" ") + ["--args"] + cmd
+        elif valgrind:
+            supp_file = os.path.abspath(os.path.dirname(__file__)) + "/iocsh_epics.supp"
+            non_optional = ["--suppressions=" + supp_file]
+            cmd = ["valgrind"] + non_optional + valgrind.split(" ") + cmd
+
+        logging.debug(f"Running command `{' '.join(cmd)}`")
+        try:
+            subprocess.run(cmd, check=True)
+        except (KeyboardInterrupt, subprocess.CalledProcessError):
+            sys.exit(-1)
+
+
+def generate_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="IOC shell for e3",
+        description="ESS EPICS environment (e3) wrapper for softIocPVA",
+    )
+
+    # How this is set up has a funny but sort of good side-effect:
+    # if no environment is sourced the IOC shell will refuse to start in the first place
+    # even if you try to execute something like `iocsh -h`
+    parser.add_argument(
+        "-V",
+        "--version",
+        action="version",
+        version="%(prog)s version {_version}".format(
+            _version=verify_environment_and_return_require_version()
+        ),
+        help="print version and exit",
+    )
+
+    parser.add_argument(
+        "file", type=Path, nargs="?", default=None, help="path to startup script"
+    )
+    parser.add_argument(
+        "-r",
+        "--require",
+        dest="module",
+        action="append",
+        default=list(),
+        help="load module(s), optionally with version using the syntax `module,version`",
+    )
+    parser.add_argument(
+        "-c", "--command", action="append", default=list(), help="execute command(s)"
+    )
+    parser.add_argument(
+        "-d",
+        "--database",
+        action="append",
+        default=list(),
+        type=Path,
+        help="load database file(s) (`dbLoadRecords`)",
+    )
+    parser.add_argument(
+        "-l",
+        "--cell-path",
+        type=Path,
+        action="append",
+        default=list(),
+        metavar="PATH",
+        help="path(s) to cell(s)",
+    )
+
+    mutex_group_modifiers = parser.add_mutually_exclusive_group()
+    mutex_group_modifiers.add_argument(
+        "-dg",
+        "--gdb",
+        nargs="?",
+        const="",
+        metavar="ARGUMENT",
+        help='run with gdb, optionally with arguments. For no arguments use "-dg --"',
+    )
+    mutex_group_modifiers.add_argument(
+        "-dv",
+        "--valgrind",
+        nargs="?",
+        const="--leak-check=full",
+        metavar="ARGUMENT",
+        help="run with valgrind, optionally with arguments (default '%(const)s'). For no arguments use \"-dv --\"",
+    )
+    mutex_group_modifiers.add_argument(
+        "--debug",
+        action="store_true",
+    )
+
+    parser.add_argument("-i", "--no-init", action="store_true")
+
+    parser.add_argument("--iocname", help="IOC name (generates fallback if not set)")
+
+    return parser
+
+
+if __name__ == "__main__":
+    logging.basicConfig(format="%(levelname)s: %(message)s ", level=logging.DEBUG)
+    parser = generate_parser()
+    args = parser.parse_args()
+    iocsh(**vars(args))

require-ess/tools/iocsh_epics.supp

+{
+   Perpetual thread that leaks during exit
+   Memcheck:Leak
+   match-leak-kinds: definite
+   fun:calloc
+   fun:newNode
+   ...
+   fun:taskwdInsert
+}

require-ess/tools/iocsh_functions.bash

-#!/usr/bin/env bash
-# shellcheck disable=SC2034
-# -*- mode: sh -*-
-#
-#  Copyright (c) 2004 - 2017    Paul Scherrer Institute
-#  Copyright (c) 2017 - 2021    European Spallation Source ERIC
-#
-#  The program is free software: you can redistribute
-#  it and/or modify it under the terms of the GNU General Public License
-#  as published by the Free Software Foundation, either version 2 of the
-#  License, or any newer version.
-#
-#  This program is distributed in the hope that it will be useful, but WITHOUT
-#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
-#  more details.
-#
-#  You should have received a copy of the GNU General Public License along with
-#  this program. If not, see https://www.gnu.org/licenses/gpl-2.0.txt
-#
-#
-#  PSI original iocsh author : Dirk Zimoch
-#  ESS author                : Jeong Han Lee
-#  ESS maintainer            : Simon Rose
-#                     email  : simon.rose@ess.eu
-#                      date  : 2021-12-10
-#
-
-REALTIME=
-__LOADER__=
-
-# Usage :
-# e3_version="$(read_file_get_string  "${file_name}" "E3_VERSION:=")";
-function read_file_get_string {
-  local FILENAME=$1
-  local PREFIX=$2
-
-  sed -n "s/^$PREFIX\(.*\)/\1/p" "$FILENAME"
-}
-
-# Base Code is defined with 8 digits numbers
-# Two digits are enough to cover all others (I think)
-# 7.0.6.1   : 07000601
-#
-# First  Two : 00 (EPICS VERSION)
-# Second Two : 00 (EPICS_REVISION)
-# Third  Two : 00 (EPICS_MODIFICATION)
-# Fourth Two : 00 (EPICS_PATCH_LEVEL)
-
-function basecode_generator() { #@ Generator BASECODE
-  #@ USAGE: BASECODE=$(basecode_generator)
-
-  local epics_ver_maj epics_ver_mid epics_ver_min epics_ver_patch
-  epics_ver_maj="$(read_file_get_string "${EPICS_BASE}/configure/CONFIG_BASE_VERSION" "EPICS_VERSION = ")"
-  epics_ver_mid="$(read_file_get_string "${EPICS_BASE}/configure/CONFIG_BASE_VERSION" "EPICS_REVISION = ")"
-  epics_ver_min="$(read_file_get_string "${EPICS_BASE}/configure/CONFIG_BASE_VERSION" "EPICS_MODIFICATION = ")"
-  epics_ver_patch="$(read_file_get_string "${EPICS_BASE}/configure/CONFIG_BASE_VERSION" "EPICS_PATCH_LEVEL = ")"
-
-  local base_code=""
-
-  if [[ ${#epics_ver_maj} -lt 2 ]]; then
-    epics_ver_maj="00${epics_ver_maj}"
-    epics_ver_maj="${epics_ver_maj: -2}"
-  fi
-
-  if [[ ${#epics_ver_mid} -lt 2 ]]; then
-    epics_ver_mid="00${epics_ver_mid}"
-    epics_ver_mid="${epics_ver_mid: -2}"
-  fi
-
-  if [[ ${#epics_ver_min} -lt 2 ]]; then
-    epics_ver_min="00${epics_ver_min}"
-    epics_ver_min="${epics_ver_min: -2}"
-  fi
-
-  if [[ ${#epics_ver_patch} -lt 2 ]]; then
-    epics_ver_patch="00${epics_ver_patch}"
-    epics_ver_patch="${epics_ver_patch: -2}"
-  fi
-
-  base_code=${epics_ver_maj}${epics_ver_mid}${epics_ver_min}${epics_ver_patch}
-
-  echo "$base_code"
-
-}
-
-function version() {
-  printf "%s : %s%s\n" "European Spallation Source ERIC" "$SC_SCRIPTNAME" ${SC_VERSION:+" ($SC_VERSION)"} >&2
-
-  exit
-}
-
-# This function doesn't work
-function printParamShow() {
-  declare -a var_list=()
-  var_list+=(EPICS_CA_REPEATER_PORT)
-  var_list+=(EPICS_CA_SERVER_PORT)
-  var_list+=(EPICS_TIMEZONE)
-  var_list+=(EPICS_TS_NTP_INET)
-  var_list+=(EPICS_AR_PORT)
-
-  var_list+=(EPICS_VERSION_MAJOR)
-  var_list+=(EPICS_VERSION_MIDDLE)
-  var_list+=(EPICS_VERSION_MINOR)
-  var_list+=(EPICS_VERSION_PATCH)
-  var_list+=(EPICS_VERSION_FULL)
-
-  for var in "${var_list[@]}"; do
-    printf "# %s=\"%s\"\n" "$var" "${!var}"
-  done
-  printf "#\n"
-}
-
-function printIocEnv() {
-  declare -a var_list=()
-  var_list+=(HOSTDISPLAY)
-  var_list+=(WINDOWID)
-  var_list+=(PWD)
-  var_list+=(USER)
-  var_list+=(LOGNAME)
-  var_list+=(EPICS_HOST_ARCH)
-  var_list+=(EPICS_BASE)
-  # REQUIRE
-
-  var_list+=(E3_REQUIRE_NAME)
-  var_list+=(E3_REQUIRE_VERSION)
-  var_list+=(E3_REQUIRE_LOCATION)
-  var_list+=(E3_REQUIRE_BIN)
-  var_list+=(E3_REQUIRE_DB)
-  var_list+=(E3_REQUIRE_DBD)
-  var_list+=(E3_REQUIRE_INC)
-  var_list+=(E3_REQUIRE_LIB)
-
-  # EPICS and others
-  var_list+=(EPICS_DRIVER_PATH)
-  var_list+=(EPICS_CA_AUTO_ADDR_LIST)
-  var_list+=(EPICS_CA_ADDR_LIST)
-  var_list+=(EPICS_PVA_AUTO_ADDR_LIST)
-  var_list+=(EPICS_PVA_ADDR_LIST)
-  var_list+=(PATH)
-
-  printf "#\n"
-  printf "# Start at \"%s\"\n" "$(date +%Y-W%V-%b%d-%H%M-%S-%Z)"
-  printf "#\n"
-  printf "# Version information:\n"
-  printf "# %s : %s%s\n" "European Spallation Source ERIC" "$SC_SCRIPTNAME" ${SC_VERSION:+" ($SC_VERSION)"}
-  printf "#\n"
-
-  printf "# --->--> snip -->--> \n"
-  printf "# Please Use Version and other environment variables\n"
-  printf "# in order to report or debug this shell\n"
-  printf "#\n"
-  for var in "${var_list[@]}"; do
-    printf "# %s=\"%s\"\n" "$var" "${!var}"
-  done
-  printf "# --->--> snip -->--> \n"
-  printf "#\n"
-}
-
-# Ctrl+c : OK
-# exit   : OK
-# kill softioc process : OK
-# kill main process : Enter twice in terminal,
-#                     close softIoc, but STARTUP file is remained.
-#
-
-function softIoc_end() {
-  local startup_file=$1
-  rm -f "${startup_file}"
-  # only clean terminal when stdout is opened on a terminal
-  # avoid "stty: standard input: Inappropriate ioctl for device" otherwise
-  [[ -t 1 ]] && stty sane
-  exit
-}
-
-function die() { #@ Print error message and exit with error code
-  #@ USAGE: die [errno [message]]
-  error=${1:-1}
-  ## exits with 1 if error number not given
-  shift
-  [ -n "$*" ] &&
-    printf "%s%s: %s\n" "$SC_SCRIPTNAME" ${SC_VERSION:+" ($SC_VERSION)"} "$*" >&2
-  exit "$error"
-}
-
-function iocsh_ps1() {
-  local iocsh_ps1=""
-  local pid="$1"
-  # Keep only short hostname (without domain)
-  local host=${HOSTNAME%%.*}
-
-  iocsh_ps1+=${host:0:15}
-  iocsh_ps1+="-"
-  iocsh_ps1+=$pid
-  iocsh_ps1+=" > "
-
-  echo "${iocsh_ps1}"
-}
-
-# Please look at the limitation in require.c in  registerModule()
-# /*
-#    Require DB has the following four PVs:
-#    - $(REQUIRE_IOC):$(MODULE)_VER
-#    - $(REQUIRE_IOC):MOD_VER
-#    - $(REQUIRE_IOC):VERSIONS
-#    - $(REQUIRE_IOC):MODULES
-#    We reserved 30 chars for :$(MODULE)_VER, so MODULE has the maximum 24 chars.
-#    And we've reserved for 30 chars for $(REQUIRE_IOC).
-#    So, the whole PV and record name in moduleversion.template has 59 + 1.
-#  */
-
-function require_ioc() {
-  # e3-ioc-hash-hostname-pid fails when host has icslab-ser03 and IOCUSER-VIRTUALBOX
-  # so better to keep simple in case when hostname is long.
-  # And it has the limitation of PV length
-  #  #define PVNAME_STRINGSZ 61 in EPICS_BASE/include/dbDefs.h
-
-  local require_ioc=""
-
-  # Test if IOCNAME is defined
-  if [ -z "${IOCNAME}" ]; then
-    local pid="$1"
-    # Keep only short hostname (without domain)
-    local hostname=${HOSTNAME%%.*}
-    # Record name should not have . character, because it is used inside record
-
-    require_ioc="REQMOD"          # char 6  ( 6)
-    require_ioc+=":"              # char 1  ( 7)
-    require_ioc+=${hostname:0:15} # char 15 (22)
-    require_ioc+="-"              # char 1  (23)
-    require_ioc+=${pid}           # char 7  (30),  max pid in  64 bit  4194304 (7),
-  else
-    require_ioc=${IOCNAME:0:30}
-  fi
-
-  echo "${require_ioc}"
-}
-
-function loadRequire() {
-  local libPrefix=lib
-  local libPostfix=.so
-  local libName=${libPrefix}${E3_REQUIRE_NAME}${libPostfix}
-
-  local require_lib=${E3_REQUIRE_LIB}/${EPICS_HOST_ARCH}/${libName}
-  local require_dbd=${E3_REQUIRE_DBD}/${E3_REQUIRE_NAME}.dbd
-
-  printf "# \n"
-  printf "# Load %s module, which has the version %s\n" "${E3_REQUIRE_NAME}" "${E3_REQUIRE_VERSION}"
-  printf "# \n"
-  printf "dlload %s\n" "${require_lib}"
-  printf "dbLoadDatabase %s\n" "${require_dbd}"
-  printf "%s_registerRecordDeviceDriver\n\n" "${E3_REQUIRE_NAME%-*}"
-  printf "# \n"
-
-}
-
-function check_mandatory_env_settings() {
-  declare -a var_list=()
-  var_list+=(EPICS_HOST_ARCH)
-  var_list+=(EPICS_BASE)
-  var_list+=(E3_REQUIRE_NAME)
-  var_list+=(E3_REQUIRE_BIN)
-  var_list+=(E3_REQUIRE_LIB)
-  var_list+=(E3_REQUIRE_DB)
-  var_list+=(E3_REQUIRE_DBD)
-  var_list+=(E3_REQUIRE_VERSION)
-  for var in "${var_list[@]}"; do
-    if [[ -z "${!var}" ]]; then
-      die 1 " $var is not defined!. Please source ${E3_REQUIRE_BIN}/setE3Env.bash "
-    fi
-  done
-
-  if [[ -z "$IOCNAME" ]]; then
-    echo "Warning: environment variable IOCNAME is not set." >&2
-  else
-    echo "IOCNAME is set to $IOCNAME"
-  fi
-}
-
-function loadFiles() {
-  while [ "$#" -gt 0 ]; do
-
-    file=$1
-
-    case $file in
-      -rt | -RT | -realtime | --realtime)
-        REALTIME="RT"
-        __LOADER__="chrt --fifo 1 "
-        ;;
-      @*)
-        loadFiles "$(cat "${file#@}")"
-        ;;
-      *=*)
-        echo -n "$file" | awk -F '=' '{printf "epicsEnvSet %s '\''%s'\''\n" $1 $2}'
-        ;;
-      -c)
-        shift
-        case $1 in
-          seq*)
-            if [ "$init" != NO ]; then
-              echo "iocInit"
-              init=NO
-            fi
-            ;;
-          iocInit)
-            init=NO
-            ;;
-        esac
-        echo "$1"
-        ;;
-      -s)
-        shift
-        if [ "$init" != NO ]; then
-          echo "iocInit"
-          init=NO
-        fi
-        echo "seq $1"
-        ;;
-      -i | -noinit | --noinit)
-        init=NO
-        ;;
-      -r)
-        shift
-        echo "require $1"
-        ;;
-      -l)
-        shift
-        add_path="$1/$(basename "${EPICS_BASE}")/require-${E3_REQUIRE_VERSION}"
-        printf "epicsEnvSet EPICS_DRIVER_PATH %s:${EPICS_DRIVER_PATH}\n" "$add_path"
-        EPICS_DRIVER_PATH="$add_path:$EPICS_DRIVER_PATH"
-        ;;
-      -dg)
-        if [[ -n "${2%--dgarg=*}" ]]; then
-          __LOADER__="gdb --eval-command run --args "
-        else
-          shift
-          if [[ -z "${1#*=}" ]]; then
-            __LOADER__="gdb "
-          else
-            __LOADER__="gdb ${1#*=} "
-          fi
-        fi
-        ;;
-      -dv)
-        if [[ -n "${2%--dvarg=*}" ]]; then
-          __LOADER__="valgrind --leak-check=full "
-        else
-          shift
-          if [[ -z "${1#*=}" ]]; then
-            __LOADER__="valgrind "
-          else
-            __LOADER__="valgrind ${1#*=} "
-          fi
-        fi
-        ;;
-      -n)
-        __LOADER__="nice --10 "
-        shift
-        ;;
-      -*)
-        printf "Unknown option %s\n\n" "$1" >&2
-        help
-        ;;
-      *.so)
-        echo "dlload \"$file\""
-        ;;
-      *)
-        subst=""
-        while [ "$#" -gt 1 ]; do
-          case $2 in
-            *=*)
-              subst="$subst,$2"
-              shift
-              ;;
-            *)
-              break
-              ;;
-          esac
-        done
-        subst=${subst#,}
-        case $file in
-          *.db | *.template)
-            echo "dbLoadRecords '$file','$subst'"
-            ;;
-          *.subs | *.subst)
-            echo "dbLoadTemplate '$file','$subst'"
-            ;;
-          *.dbd)
-            # some dbd files must be loaded before main to take effect
-            echo "dbLoadDatabase '$file','$DBD','$subst'"
-            ;;
-          *)
-            set_e3_cmd_top "$file"
-            echo "iocshLoad '$file','$subst'"
-
-            # Search for any instance of iocInit at the start of the line.
-            # If found, do not add the iocInit to the startup script. Any
-            # other occurrence of iocInit (e.g. in comments) is not matched
-            # and the script will add an active iocInit.
-            if grep -q "^\s*iocInit\b" "$file"; then
-              init=NO
-            fi
-            ;;
-        esac
-        ;;
-
-    esac
-    shift
-  done
-
-} \
-  ;
-
-function set_e3_cmd_top() {
-  local file=$1
-  local file_path=""
-  local file_top=""
-  local file_name=""
-
-  if [ -f "$file" ]; then
-    file_path="$(readlink -e "$file")"
-    file_top="${file_path%/*}"
-    file_name=${file##*/}
-    printf "# Set E3_CMD_TOP for the absolute path where %s exists\n" "$file_name"
-    printf "epicsEnvSet E3_CMD_TOP \"%s\"\n" "$file_top"
-    printf "#\n"
-
-  fi
-}
-
-function help() {
-  {
-    printf "\n"
-    printf "USAGE: iocsh [startup files]\n"
-    printf "\n"
-    printf "Start the ESS iocsh and load startup scripts.\n\n"
-    printf "Options:\n\n"
-    printf "  -?, -h, --help   Show this page and exit.\n"
-    printf "  -v, --version    Show version and exit.\n"
-    printf "  -rt              Execute in realtime mode.\n"
-    printf "                   (Also -RT, -realtime, --realtime)\n"
-    printf "  -c 'cmd args'    Ioc shell command.\n"
-    printf "  -s 'prog m=v'    Sequencer program (and arguments), run with 'seq'.\n"
-    printf "                   This forces an 'iocInit' before running the program.\n"
-    printf "  -i               Do not add iocInit. This option does not override\n"
-    printf "                   a valid iocInit in the startup script.\n"
-    printf "                   (Also -noinit, --noinit)\n"
-    printf "  -r module[,ver]  Module (optionally with version) loaded via 'require'.\n"
-    printf "  -l 'cell path'   Run Ioc with a cell path.\n"
-    printf "  -dg [--dgarg='gdb-options']          Run with debugger gdb with user selected options or default option.\n"
-    printf "  -dv [--dvarg='valgrind-options']     Run with valgrind with user selected options or default option.\n"
-    printf "  -n               Run with 'nice --10' (requires sudo).\n"
-    printf "  @file            More arguments are read from file.\n\n"
-    printf "Supported filetypes:\n\n"
-    printf " *.db, *.dbt, *.template  loaded via 'dbLoadRecords'\n"
-    printf " *.subs, *.subst          loaded via 'dbLoadTemplate'\n"
-    printf " *.dbd                    loaded via 'dbLoadDatabase'\n"
-    printf " *.so                     loaded via 'dlload'\n"
-    printf "\n"
-    printf "All other files are executed as startup scripts by the EPICS shell.\n"
-    printf "After a file you can specify substitutions like m1=v1 m2=v1 for that file.\n\n"
-    printf "Examples:\n"
-    printf "  iocsh st.cmd\n"
-    printf "  iocsh my_database.template P=XY M=3\n"
-    printf "  iocsh -r my_module,version -c 'initModule()'\n"
-    printf "  iocsh -c 'var requireDebug 1' st.cmd\n"
-    printf "  iocsh -i st.cmd\n"
-    printf "  iocsh -dv --dvarg='--vgdb=full'\n"
-    printf "  iocsh -dv st.cmd\n\n"
-  } >&2
-  exit
-}
-
-for arg in "$@"; do
-  case $arg in
-    -h | "-?" | -help | --help)
-      help
-      ;;
-    -v | -ver | --ver | -version | --version)
-      version
-      ;;
-    *) ;;
-  esac
-done

require-ess/tools/promptE3Env.bash

@@ -8,8 +8,8 @@
 #
 
 DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"
-# shellcheck source=require-ess/tools/setE3Env.bash
-source "$DIR"/setE3Env.bash
+# shellcheck source=require-ess/tools/activate
+source "$DIR"/activate
 
 IFS='/' read -ra base <<<"$EPICS_BASE"
 PS1="(EPICS-${base[-1]})$PS1"

ruff.toml

+extend-select = ["D212"]
+extend-ignore = ["D105", "D107", "D202", "D418", "E501"]