Add int64in/out record support

Author: AlexanderWells-diamond

CHANGELOG.rst

@@ -12,6 +12,7 @@ Unreleased_
 
 Added:
 
+- `Add int64In/Out record support <../../pull/161>`_
 - `Enable setting alarm status of Out records <../../pull/157>`_
 - `Adding the non_interactive_ioc function <../../pull/156>`_
 

docs/reference/api.rst

@@ -155,7 +155,7 @@ and stderr streams, is sent directly to the terminal.
     but note that only the following records types have direct support from this
     module:
 
-        ai, ao, bi, bo, longin, longout, mbbi, mbbo, stringin, stringout, waveform
+        ai, ao, bi, bo, int64in, int64out, longin, longout, mbbi, mbbo, stringin, stringout, waveform
 
     The following methods create records of the corresponding type.  For all records
     the `initial_value` parameter can be used to specify an initial value for the
@@ -285,6 +285,15 @@ All functions return a wrapped `ProcessDeviceSupportIn` or
     Create ``bi`` and ``bo`` records with the specified names for false (zero)
     and true (one).
 
+..  function::
+        int64In(name, LOPR=None, HOPR=None, EGU=None, **fields)
+        int64Out(name, DRVL=None, DRVH=None, EGU=None, **fields)
+
+    Create ``int64In`` and ``int64Out`` records with specified limits and units.
+    The lower and upper display limits for the record can be specified.  For
+    ``int64Out`` records the ``LOPR`` and ``HOPR`` fields will be set by default
+    to the values of the ``DRVL`` and ``DRVH`` fields respectively.
+
 ..  function::
         longIn(name, LOPR=None, HOPR=None, EGU=None, **fields)
         longOut(name, DRVL=None, DRVH=None, EGU=None, **fields)
@@ -532,15 +541,17 @@ Create IN records (used for publishing data *from* the IOC, the naming of the
 direction is confusing) using the following `softioc.builder` methods:
 
     :func:`~softioc.builder.aIn`, :func:`~softioc.builder.boolIn`,
-    :func:`~softioc.builder.longIn`, :func:`~softioc.builder.stringIn`,
-    :func:`~softioc.builder.mbbIn`, :func:`~softioc.builder.WaveformIn`.
+    :func:`~softioc.builder.int64In` :func:`~softioc.builder.longIn`,
+    :func:`~softioc.builder.stringIn`, :func:`~softioc.builder.mbbIn`,
+    :func:`~softioc.builder.WaveformIn`.
 
 Create OUT records for receiving control information into the IOC using the
 following methods:
 
     :func:`~softioc.builder.aOut`, :func:`~softioc.builder.boolOut`,
-    :func:`~softioc.builder.longOut`, :func:`~softioc.builder.stringOut`,
-    :func:`~softioc.builder.mbbOut`, :func:`~softioc.builder.WaveformOut`.
+    :func:`~softioc.builder.int64Out`, :func:`~softioc.builder.longOut`,
+    :func:`~softioc.builder.stringOut`, :func:`~softioc.builder.mbbOut`,
+    :func:`~softioc.builder.WaveformOut`.
 
 For all records the `initial_value` keyword argument can be used to specify the
 records value on startup.
@@ -554,7 +565,7 @@ class which provides the methods documented below.
 ..  class:: ProcessDeviceSupportIn
 
     This class is used to implement Python device support for the record types
-    ``ai``, ``bi``, ``longin``, ``mbbi`` and IN ``waveform`` records.
+    ``ai``, ``bi``, ``int64in``, ``longin``, ``mbbi`` and IN ``waveform`` records.
 
     ..  method:: set(value, severity=NO_ALARM, alarm=NO_ALARM, timestamp=None)
 

softioc/builder.py

@@ -78,6 +78,17 @@ def longOut(name, DRVL=None, DRVH=None, EGU=None, **fields):
     _set_scalar_out_defaults(fields, DRVL, DRVH)
     return PythonDevice.longout(name, EGU = EGU, **fields)
 
+def int64In(name, LOPR=None, HOPR=None, EGU=None, **fields):
+    _set_in_defaults(fields)
+    fields.setdefault('MDEL', -1)
+    return PythonDevice.int64in(
+        name, LOPR = LOPR, HOPR = HOPR, EGU = EGU, **fields)
+
+def int64Out(name, DRVL=None, DRVH=None, EGU=None, **fields):
+    _set_out_defaults(fields)
+    _set_scalar_out_defaults(fields, DRVL, DRVH)
+    return PythonDevice.int64out(name, EGU = EGU, **fields)
+
 
 # Field name prefixes for mbbi/mbbo records.
 _mbbPrefixes = [

softioc/device.dbd

@@ -1,5 +1,7 @@
 device(longin,    INST_IO, devPython_longin,    "Python")
 device(longout,   INST_IO, devPython_longout,   "Python")
+device(int64in,   INST_IO, devPython_int64in,   "Python")
+device(int64out,  INST_IO, devPython_int64out,  "Python")
 device(ai,        INST_IO, devPython_ai,        "Python")
 device(ao,        INST_IO, devPython_ao,        "Python")
 device(bi,        INST_IO, devPython_bi,        "Python")

softioc/device.py

@@ -316,6 +316,8 @@ def _Device_Out(*args, **kargs):
 
 longin = _Device_In('longin', c_int32, fields.DBF_LONG, EPICS_OK)
 longout = _Device_Out('longout', c_int32, fields.DBF_LONG, EPICS_OK)
+int64in = _Device_In('int64in', c_int64, fields.DBF_INT64, EPICS_OK)
+int64out = _Device_Out('int64out', c_int64, fields.DBF_INT64, EPICS_OK)
 bi = _Device_In('bi', c_uint16, fields.DBF_CHAR, NO_CONVERT)
 bo = _Device_Out('bo', c_uint16, fields.DBF_CHAR, NO_CONVERT)
 mbbi = _Device_In('mbbi', c_uint16, fields.DBF_SHORT, NO_CONVERT)

softioc/extension.c

@@ -32,7 +32,7 @@ static void set_dict_item_steal(
 
 /* Alas, EPICS has changed the numerical assignments of the DBF_ enums between
  * versions, so to avoid unpleasant surprises, we compute thes values here in C
- * and pass them back to the Python layer. */
+ * and pass them back to the Python layer. Order matches dbFldTypes.h. */
 static PyObject *get_DBF_values(PyObject *self, PyObject *args)
 {
     PyObject *dict = PyDict_New();
@@ -43,6 +43,8 @@ static PyObject *get_DBF_values(PyObject *self, PyObject *args)
     ADD_ENUM(dict, DBF_USHORT);
     ADD_ENUM(dict, DBF_LONG);
     ADD_ENUM(dict, DBF_ULONG);
+    ADD_ENUM(dict, DBF_INT64);
+    ADD_ENUM(dict, DBF_UINT64);
     ADD_ENUM(dict, DBF_FLOAT);
     ADD_ENUM(dict, DBF_DOUBLE);
     ADD_ENUM(dict, DBF_ENUM);

softioc/fields.py

@@ -2,10 +2,9 @@
 
 from __future__ import print_function
 
-import sys
 from ctypes import *
 from .imports import get_field_offsets, get_DBF_values
-import numpy
+
 
 from epicscorelibs.ca.dbr import *
 from epicscorelibs.ca.dbr import ca_timestamp, EPICS_epoch
@@ -32,6 +31,8 @@
     DBF_SHORT: c_int16,
     DBF_USHORT: c_uint16,
     DBF_LONG: c_int32,
+    DBF_INT64: c_int64,
+    DBF_UINT64: c_uint64,  # TODO: Check whether this has same issue as below note
     DBF_ULONG: c_int32,    # Should be uint32, but causes trouble later.
     DBF_FLOAT: c_float,
     DBF_DOUBLE: c_double,
@@ -50,6 +51,8 @@
     DBR_ENUM: DBF_ENUM,
     DBR_CHAR: DBF_CHAR,
     DBR_LONG: DBF_LONG,
+    # DBR_INT64: DBF_INT64,  # TODO: the DBR_ definitions come from epicscorelibs.ca.dbr, but they don't define the 64 versions
+    # DBR_UINT64: DBF_UINT64,
     DBR_DOUBLE: DBF_DOUBLE
 }
 

softioc/pythonSoftIoc.py

@@ -89,8 +89,9 @@ class PythonDevice(object):
     @classmethod
     def __init_class__(cls):
         for name in [
-                'ai', 'bi', 'longin',  'mbbi', 'stringin',
-                'ao', 'bo', 'longout', 'mbbo', 'stringout', 'waveform']:
+                'ai', 'bi', 'longin',  'mbbi', 'stringin', 'int64in',
+                'ao', 'bo', 'longout', 'mbbo', 'stringout', 'int64out',
+                'waveform']:
             builder = getattr(epicsdbbuilder.records, name)
             record = getattr(device, name)
             setattr(cls, name, cls.makeRecord(builder, record))

tests/conftest.py

@@ -9,8 +9,20 @@
 from typing import Any
 import pytest
 
+from softioc import builder
 from softioc.builder import ClearRecords
 
+in_records = [
+    builder.aIn,
+    builder.boolIn,
+    builder.longIn,
+    builder.int64In,
+    builder.mbbIn,
+    builder.stringIn,
+    builder.WaveformIn,
+    builder.longStringIn,
+]
+
 requires_cothread = pytest.mark.skipif(
     sys.platform.startswith("win"), reason="Cothread doesn't work on windows"
 )

tests/test_record_values.py

@@ -1,4 +1,3 @@
-import multiprocessing
 from typing import List
 import numpy
 import pytest
@@ -12,7 +11,8 @@
     log,
     select_and_recv,
     TIMEOUT,
-    get_multiprocessing_context
+    get_multiprocessing_context,
+    in_records,
 )
 
 from softioc import asyncio_dispatcher, builder, softioc
@@ -54,23 +54,15 @@ def record_func_names(fixture_value):
         builder.WaveformOut,
         builder.longStringIn,
         builder.longStringOut,
+        builder.int64In,
+        builder.int64Out,
     ],
     ids=record_func_names,
 )
 def record_func(request):
     """The list of record creation functions"""
     return request.param
 
-# A list of all In records, used to filter out various tests
-in_records = [
-    builder.aIn,
-    builder.boolIn,
-    builder.longIn,
-    builder.mbbIn,
-    builder.stringIn,
-    builder.WaveformIn,
-    builder.longStringIn,
-]
 
 def record_values_names(fixture_value):
     """Provide a nice name for the tests in the record_values fixture"""
@@ -96,6 +88,8 @@ def record_values_names(fixture_value):
     ("aOut_nan", builder.aOut, nan, nan, float),
     ("longIn_int", builder.longIn, 5, 5, int),
     ("longOut_int", builder.longOut, 5, 5, int),
+    ("int64In_int", builder.int64In, 65, 65, int),
+    ("int64Out_int", builder.int64Out, 65, 65, int),
     ("boolIn_int", builder.boolIn, 1, 1, int),
     ("boolOut_int", builder.boolOut, 1, 1, int),
     ("boolIn_true", builder.boolIn, True, 1, int),
@@ -737,6 +731,8 @@ def test_value_post_init_caput(self):
     ("default_aIn", builder.aIn, None, 0.0, float),
     ("default_longOut", builder.longOut, None, 0, int),
     ("default_longIn", builder.longIn, None, 0, int),
+    ("default_int64Out", builder.int64Out, None, 0, int),
+    ("default_int64In", builder.int64In, None, 0, int),
     ("default_boolOut", builder.boolOut, None, 0, int),
     ("default_boolIn", builder.boolIn, None, 0, int),
     ("default_Action", builder.Action, None, 0, int),
@@ -761,6 +757,8 @@ class TestDefaultValue:
             (builder.aIn, 0.0, float),
             (builder.longOut, 0, int),
             (builder.longIn, 0, int),
+            (builder.int64Out, 0, int),
+            (builder.int64In, 0, int),
             (builder.boolOut, 0, int),
             (builder.boolIn, 0, int),
             (builder.Action, 0, int),