Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • e3/wrappers/e3-require
  • waynelewis/e3-require
  • krisztianloki/e3-require
  • timokorhonen/e3-require
  • juntongliu/e3-require
  • roryclarke/e3-require
  • alfiorizzo/e3-require
  • lucasmagalhaes/e3-require
  • lucas-module-testgroup/e3-require
  • grzegorzkowalski/e3-require
  • anderslindh1/e3-require
11 results
Show changes
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 1469 additions and 1251 deletions
require-ess/tools/driver.makefile
View file @ 4560be22
This diff is collapsed.
require-ess/tools/expandDBD.tcl deleted 100755 → 0
View file @ 73bbc073
#!/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 0 → 100755
View file @ 4560be22
#! /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.bash deleted 100644 → 0
View file @ 73bbc073
#!/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.bash 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.bash 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.bash
# 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.bash 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.bash executable."
echo "Please source the appropriate setE3Env.bash file for the version"
echo "of iocsh.bash you wish to use, or run iocsh.bash from a clean"
echo "environment so it can set the environment correctly."
echo "Expected path to iocsh.bash from environment = ${E3_REQUIRE_BIN}"
echo "Actual path to iocsh.bash = ${SC_TOP}"
die 2
fi
BASECODE="$(basecode_generator)"
check_mandatory_env_settings
# ${BASHPID} returns iocsh.bash PID
iocsh_bash_id=${BASHPID}
#
SC_VERSION+=-PID-${iocsh_bash_id}
#
# We define HOSTNAME + iocsh_bash_id
IOCSH_PS1=$(iocsh_ps1 "${iocsh_bash_id}")
REQUIRE_IOC=$(require_ioc "${iocsh_bash_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
require-ess/tools/iocsh_complete.bash
View file @ 4560be22
#!/usr/bin/env bash
_iocsh_bash_completion() {
_iocsh_completion() {
local cur prev opts mods
COMPREPLY=()
cur="${COMP_WORDS[COMP_CWORD]}"
......@@ -38,4 +38,4 @@ _iocsh_bash_completion() {
mapfile -t COMPREPLY < <(compgen -f -- "${cur}")
}
complete -o filenames -o nospace -o bashdefault -F _iocsh_bash_completion iocsh.bash
complete -o filenames -o nospace -o bashdefault -F _iocsh_completion iocsh
require-ess/tools/iocsh_epics.supp 0 → 100644
View file @ 4560be22
{
Perpetual thread that leaks during exit
Memcheck:Leak
match-leak-kinds: definite
fun:calloc
fun:newNode
...
fun:taskwdInsert
}
require-ess/tools/iocsh_functions.bash deleted 100644 → 0
View file @ 73bbc073
This diff is collapsed.
require-ess/tools/iocsh_utils.py 0 → 100755
View file @ 4560be22
"""Utilities for iocsh."""
import atexit
import os
import logging
import socket
import sys
from tempfile import NamedTemporaryFile
from pathlib import Path
from sys import platform
DEFAULT_ERRLOG_BUFFER_SIZE = 2048
@atexit.register
def graceful_shutdown() -> None:
print("\nExiting e3 IOC shell")
os.system("/bin/bash -c '[[ -t 1 ]] && stty sane'")
class TemporaryStartupScript:
"""Class to manage IOC shell commands.
Holds on to commands in a buffer which it writes to file.
"""
def __init__(self, iocname: str = None) -> None:
self.file = NamedTemporaryFile(delete=False)
self.command_buffer = []
self._saved = False
self.set_variable("REQUIRE_IOC", iocname or generate_prefix())
self.set_variable("IOCSH_TOP", Path.cwd())
self.set_variable(
"IOCSH_PS1", f"{iocname} > " if iocname else generate_prompt()
)
# The message size maximum must be slightly smaller than the buffer size
# (to account for the null terminator)
self.add_command(
f"errlogInit2 {DEFAULT_ERRLOG_BUFFER_SIZE} {DEFAULT_ERRLOG_BUFFER_SIZE-1}"
)
if platform.startswith("linux"):
shared_lib_suffix = "so"
elif platform == "darwin":
shared_lib_suffix = "dylib"
else:
raise NotImplementedError(f"Unsupported platform: {platform}")
# load require
self.add_command(
f"dlload {str(Path(os.environ['E3_REQUIRE_LIB']) / os.environ['EPICS_HOST_ARCH'] / f'librequire.{shared_lib_suffix}')}"
)
self.add_command(
f"dbLoadDatabase {str(Path(os.environ['E3_REQUIRE_DBD']) / 'require.dbd')}"
)
self.add_command("require_registerRecordDeviceDriver")
@property
def name(self) -> str:
return self.file.name
def __enter__(self) -> None:
return self
def __exit__(self, *args) -> None:
self.file.close()
def _get_content(self) -> str:
"""Return list of commands as multi-line string."""
return "\n".join(self.command_buffer) + "\n" # ensure newline at EOF
def save(self) -> None:
"""Store command 'buffer' to file."""
if self._saved:
raise RuntimeError("File has already been saved")
self.file.write(self._get_content().encode())
self.file.flush()
self._saved = True
def set_variable(self, var: str, val: str) -> None:
self.add_command(
f'epicsEnvSet {var} "{val}"'
) # add quotation marks to avoid symbols being interpreted
def load_snippet(self, name: str) -> None:
self.add_command(f"iocshLoad {name}")
def load_module(self, name: str) -> None:
self.add_command(f"require {name}")
def load_database(self, name: str) -> None:
self.add_command(f"dbLoadRecords {name}")
def add_command(self, command: str) -> None:
self.command_buffer.append(command)
def verify_environment_and_return_require_version() -> str:
"""Verify select known EPICS and e3 variables and return current require version."""
def check_mandatory_env_vars() -> None:
mandatory_vars = (
"EPICS_HOST_ARCH",
"EPICS_BASE",
"E3_REQUIRE_VERSION",
"E3_REQUIRE_NAME",
"E3_REQUIRE_BIN",
"E3_REQUIRE_LIB",
"E3_REQUIRE_DB",
"E3_REQUIRE_DBD",
)
for var in mandatory_vars:
_ = os.environ[var]
try:
check_mandatory_env_vars()
except KeyError as e:
logging.debug(f"Environment variable {e} is not set")
sys.exit("Please source an environment before you try to use the IOC shell")
# compare path of this script to sourced environment's executables
if not str(Path(__file__).resolve().parent) == os.environ["E3_REQUIRE_BIN"]:
logging.debug(
f"Sourced environment is '{os.environ['E3_REQUIRE_BIN']}' and this script is from '{Path(__file__).resolve().parent}'"
)
sys.exit(
"You have sourced a different environment than what this IOC shell is from"
)
return os.environ["E3_REQUIRE_VERSION"]
def extract_require_version() -> str:
"""Return loaded environment's version of require."""
try:
return os.environ["E3_REQUIRE_VERSION"]
except KeyError:
sys.exit("Please source an environment before you try to use the IOC shell")
def generate_prompt() -> str:
"""Return IOC shell prompt."""
fqdn = socket.gethostname()
hostname, *_ = fqdn.partition(".")
prompt = f"{hostname}-{os.getpid()}"
return f"{prompt} > "
def generate_prefix() -> str:
"""Return fallback PV prefix."""
try:
user = os.getlogin()
except OSError: # for wonky cases
user = "UNKNOWN"
return f"TEST:{user}-{os.getpid()}"
def generate_banner() -> str:
"""Return ascii art banner."""
ascii_art = """
,----. ,--. ,-----. ,-----. ,--. ,--.,--.
,---. '.-. | | |' .-. '' .--./ ,---. | ,---. ,---. | || |
| .-. : .' < | || | | || | ( .-' | .-. || .-. :| || |
\ --./'-' | | |' '-' '' '--'\ .-' `)| | | |\ --.| || |
`----'`----' `--' `-----' `-----' `----' `--' `--' `----'`--'`--'
"""
return ascii_art
require-ess/tools/promptE3Env.bash
View file @ 4560be22
......@@ -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"
require-ess/tools/build_number.sh → require-ess/tools/revision_number 100755 → 100644
View file @ 4560be22
#!/usr/bin/env bash
# Small script to fetch current build nuber for a given module. If you pass a numeric version
# but no build number, it fetches the latest build number installed from the target e3 env.
# but no revision number, it fetches the latest revision number installed from the target e3 env.
#
# Arguments:
# $1: require module path e.g. /epics/base-$BASE_VERSION/require/$REQUIRE_VERSION/siteMods
......
require.Makefile
View file @ 4560be22
#
# Copyright (c) 2004 - 2017 Paul Scherrer Institute
# Copyright (c) 2017 - Present European Spallation Source ERIC
#
......@@ -15,13 +14,8 @@
# 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 author : Dirk Zimoch
# ESS original author : Jeong Han Lee
# ESS current author : Simon Rose
# email : simon.rose@ess.eu
#
# Date : Mon Dec 6 20:57:10 CET 2021
# version : 3.4.1
# Author: Dirk Zimoch (PSI)
# Maintainer: Simon Rose (ESS) <simon.rose@ess.eu>
# This is the one time path in order to compile and install
......@@ -32,10 +26,8 @@ where_am_I := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
# It is easy to maintain RULES_E3 if we use the "repository" makefile
# instead of the installed makefile.
include $(where_am_I)/tools/driver.makefile
BUILDCLASSES += Linux
#
include $(where_am_I)/require-ess/tools/driver.makefile
APP := .
APPSRC := $(APP)/src
......@@ -43,72 +35,26 @@ APPDB := $(APP)/Db
SOURCES += $(APPSRC)/require.c
SOURCES += $(APPSRC)/version.c
SOURCES += $(APPSRC)/afterInit.c
SOURCES += $(APPSRC)/common.c
SOURCES += $(APPSRC)/module.c
DBDS += $(APPSRC)/require.dbd
SOURCES += $(APPSRC)/runScript.c
DBDS += $(APPSRC)/runScript.dbd
SOURCES += $(APPSRC)/expr.c
##
SOURCES += $(APPSRC)/dbLoadTemplate.y
DBDS += $(APPSRC)/dbLoadTemplate.dbd
# ESS doesn't have any T2_ppc604 and vxWorks target
# Friday, May 11 22:05:07 CEST 2018, jhlee
#
#SOURCES_T2 += strdup.c
#SOURCES_vxWorks += asprintf.c
#
#HEADERS += strdup.h
#HEADERS += asprintf.h
DBDS += $(APPSRC)/afterInit.dbd
HEADERS += $(APPSRC)/require.h
#HEADERS += require_env.h
# HEADERS += require_env.h
# We need to find the Linux link.h before the EPICS link.h
#
USR_INCLUDES_Linux=-idirafter $(EPICS_BASE)/include
USR_CFLAGS += -std=gnu99
# ESS require doesn't use T_A, because Linux should handle linux as "1"
# instead of its name. ESS require can handle them within the EPICS
# IOC shell internally.
#
#USR_CFLAGS += -DT_A='"${T_A}"'
# ESS doesn't support WIN32
# This should really go into some global WIN32 config file
# USR_CFLAGS_WIN32 += /D_WIN32_WINNT=0x501
# USR_CFLAGS += -DT_A='"${T_A}"'
TEMPLATES += $(APPDB)/moduleversion.template
#TEMPLATES += moduleversion.db
vpath dbLoadTemplate_lex.l ../$(APPSRC)
dbLoadTemplate.c: dbLoadTemplate_lex.c ../$(APPSRC)/dbLoadTemplate.h
## moduleversion should convert to db instead of template
## So, ESS uses it internally independent upon any IOC
## varialbes
EPICS_BASE_HOST_BIN = $(EPICS_BASE)/bin/$(EPICS_HOST_ARCH)
MSI = $(EPICS_BASE_HOST_BIN)/msi
USR_DBFLAGS += -I . -I ..
USR_DBFLAGS += -I$(EPICS_BASE)/db
TMPS = $(wildcard $(APPDB)/*.template)
db: $(TMPS)
$(TMPS):
@printf "Inflating database ... %44s >>> %40s \n" "$@" "$(basename $(@)).db"
@rm -f $(basename $(@)).db.d $(basename $(@)).db
@$(MSI) -D $(USR_DBFLAGS) -o $(basename $(@)).db $@ > $(basename $(@)).db.d
@$(MSI) $(USR_DBFLAGS) -o $(basename $(@)).db $@
.PHONY: db $(TMPS)
ruff.toml 0 → 100644
View file @ 4560be22
extend-select = ["D212"]
extend-ignore = ["D105", "D107", "D202", "D418", "E501"]
tests/build_system/__init__.py 0 → 100644
View file @ 4560be22
tests/build_system/test_build_options.py 0 → 100644
View file @ 4560be22
import os
import re
import pytest
@pytest.mark.parametrize(
"installed_archs, expected",
[("foo", []), ("foo-bar foo-baz baz baz-qux", ["baz", "baz-qux"])],
)
def test_arch_filter(wrapper, installed_archs, expected):
arch_regex = re.compile(r"Pass 2: T_A =\s*([^\s]+)")
wrapper.write_var_to_makefile(
wrapper.module_makefile,
"CROSS_COMPILER_TARGET_ARCHS",
installed_archs,
)
_, outs, _ = wrapper.run_make("debug", EXCLUDE_ARCHS="foo")
host_arch = os.getenv("EPICS_HOST_ARCH")
build_archs = [arch for arch in arch_regex.findall(outs) if arch != host_arch]
assert build_archs == expected
def test_load_custom_config_files(wrapper):
custom_config_file = wrapper.config_dir / "CONFIG_FOO"
custom_config_file.write_text("$(error foobarbaz)")
wrapper.add_file(custom_config_file)
wrapper.write_var_to_makefile(
wrapper.module_makefile, "CONFIGS", str(custom_config_file), modifier="+"
)
rc, _, errs = wrapper.run_make("build")
assert rc == 2
assert "foobarbaz" in errs
tests/build_system/test_convenience_features.py 0 → 100644
View file @ 4560be22
def test_append_missing_revision_number(wrapper):
version = "1.2.3"
wrapper.write_var_to_makefile(
wrapper.config_dir / "CONFIG_MODULE.local", "E3_MODULE_VERSION", version
)
rc, outs, _ = wrapper.run_make("vars")
assert rc == 0
assert f"E3_MODULE_VERSION = {version}+0" in outs.splitlines()
def test_warning_msg_if_building_from_sitemods(wrapper):
rc, _, errs = wrapper.run_make(
"build_path_check", E3_MODULES_PATH=wrapper.wrapper_dir / ".."
)
assert rc == 0
assert (
"It is ill-advised to build a module from the module install location." in errs
)
tests/build_system/test_db_expansion.py 0 → 100644
View file @ 4560be22
def test_automated_subs_tmps_db_expansion(wrapper):
wrapper.write_var_to_makefile(
wrapper.module_makefile, "TMPS", "templates/a.template", modifier="+"
)
wrapper.write_var_to_makefile(
wrapper.module_makefile, "SUBS", "b.substitutions", modifier="+"
)
wrapper.write_var_to_makefile(
wrapper.module_makefile, "USR_DBFLAGS", "-I templates", modifier="+"
)
template_dir = wrapper.module_dir / "templates"
template_dir.mkdir()
template_file = template_dir / "a.template"
template_file_contents = "record (ai, $(P)) {}"
template_file.write_text(template_file_contents)
substitution_file = wrapper.module_dir / "b.substitutions"
substitution_file.write_text(
"""file "a.template"
{
pattern { P }
{ "$(PREF)" }
}
"""
)
common_dir = wrapper.module_dir / f"O.{wrapper.base_version}_Common"
rc, *_ = wrapper.run_make("db_internal")
assert rc == 0
expanded_template_file = common_dir / "a.db"
assert expanded_template_file.read_text() == template_file_contents
expanded_substitution_file = common_dir / "b.db"
assert expanded_substitution_file.read_text() == template_file_contents.replace(
"$(P)", "$(PREF)"
)
def test_automated_subs_tmps_db_expansion_priority(wrapper):
wrapper.write_var_to_makefile(
wrapper.module_makefile, "TMPS", "a.template", modifier="+"
)
wrapper.write_var_to_makefile(
wrapper.module_makefile, "SUBS", "a.substitutions", modifier="+"
)
wrapper.write_var_to_makefile(
wrapper.module_makefile, "USR_DBFLAGS", "-I.", modifier="+"
)
template_file = wrapper.module_dir / "a.template"
template_file_contents = "record (ai, $(FOO)) {}"
template_file.write_text(template_file_contents)
substitution_file = wrapper.module_dir / "a.substitutions"
substitution_file.write_text(
"""file "a.template"
{
pattern { FOO }
{ "$(BAR)" }
}
"""
)
common_dir = wrapper.module_dir / f"O.{wrapper.base_version}_Common"
rc, *_ = wrapper.run_make("db_internal")
assert rc == 0
expanded_template_file = common_dir / "a.db"
assert "BAR" in expanded_template_file.read_text()
assert "FOO" not in expanded_template_file.read_text()
tests/build_system/test_dependencies.py 0 → 100644
View file @ 4560be22
This diff is collapsed.
tests/build_system/test_deprecation_warnings.py 0 → 100644
View file @ 4560be22
def test_error_if_using_local_mode_with_loc_suffix(wrapper_factory):
wrapper = wrapper_factory.create(E3_MODULE_SRC_PATH="test-loc")
rc, _, errs = wrapper.run_make("build")
assert rc == 2
assert 'Local source mode "-loc" has been deprecated' in errs
def test_error_if_loading_from_outside_of_sitemods(wrapper):
makefile_contents = wrapper.makefile.read_text()
wrapper.makefile.write_text(
makefile_contents.replace(
"include $(REQUIRE_CONFIG)/RULES_SITEMODS",
"include $(REQUIRE_CONFIG)/RULES_E3",
)
)
rc, _, errs = wrapper.run_make("build")
assert rc == 2
assert "RULES_E3 should only be loaded from RULES_SITEMODS" in errs
tests/build_system/test_make_build.py 0 → 100644
View file @ 4560be22
This diff is collapsed.
tests/build_system/test_make_cellcmds.py 0 → 100644
View file @ 4560be22
This diff is collapsed.