Restructuring the simulation binary data, including an xboinc version check.

Author: freddieknets

xboinc/generate_executable_source.py

@@ -1,6 +1,6 @@
 import xobjects as xo
 from .default_tracker import get_default_tracker
-from .sim_data import SimState, SimConfig
+from .simulation_data import SimState, SimConfig
 from .general import _pkg_root
 
 from pathlib import Path

xboinc/simulation_data/__init__.py

@@ -0,0 +1,7 @@
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2023.                 #
+# ######################################### #
+
+from .simulation_state import SimState
+from .simulation_data import build_input_file, SimConfig

xboinc/simulation_data/compatible versions.py

@@ -0,0 +1,13 @@
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2023.                 #
+# ######################################### #
+
+import xobjects as xo
+import xpart as xp
+
+# As long as nothing changed in any of the C codes, this xboinc version is compatible
+
+# If new versions have
+
+# When updating xboinc, it checks all the versions that

xboinc/sim_data.py renamed to xboinc/simulation_data/simulation_data.py

@@ -1,42 +1,44 @@
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2023.                 #
+# ######################################### #
+
 import numpy as np
 
 import xobjects as xo
 import xpart as xp
 import xtrack as xt
 
-from .default_tracker import get_default_tracker
+from ..default_tracker import get_default_tracker
+from .simulation_state import SimState
 
 _default_tracker, _default_config_hash = get_default_tracker()
 
 
-class SimState(xo.HybridClass):
-    _xofields = {
-        'particles': xp.Particles._XoStruct,
-        'i_turn': xo.Int64,
-        'size': xo.Int64,
-    }
-
-
 class SimConfig(xo.Struct):
-    tracker_data = _default_tracker._tracker_data_cache[_default_config_hash]
-    line_metadata = xo.Ref(tracker_data._element_ref_data.__class__)
-    num_turns = xo.Int64
-    num_elements = xo.Int64
+    tracker_data     = _default_tracker._tracker_data_cache[_default_config_hash]
+    line_metadata    = xo.Ref(tracker_data._element_ref_data.__class__)
+    num_turns        = xo.Int64
+    num_elements     = xo.Int64
     checkpoint_every = xo.Int64
-    sim_state = xo.Ref(SimState._XoStruct)
+    sim_state        = xo.Ref(SimState)
 
 
 def build_input_file(name, num_turns, line, particles, checkpoint_every=-1):
     # Assemble data structure
     simbuf = xo.ContextCpu().new_buffer()
     sim_config = SimConfig(_buffer=simbuf)
     default_tracker = _default_tracker
+    # TODO: need check if incompatible elements in line or so?
+    # TODO: need to version tracker -> xboinc executable versions
     line.build_tracker(_context=simbuf.context, _buffer=simbuf,
                         track_kernel=default_tracker.track_kernel)
-    sim_state = SimState(_buffer=simbuf, particles=particles, i_turn=0)
     if _default_config_hash not in line.tracker._tracker_data_cache:
         raise RuntimeError('Tracker data for default config not found')
     tracker_data = line.tracker._tracker_data_cache[_default_config_hash]
+    version, part = get_boinc_particles_from_particles(particles)
+    sim_state = build_simulation_state(version=version, _buffer=simbuf,
+                                     particles=part, i_turn=0)
     sim_config.line_metadata = tracker_data._element_ref_data
     sim_config.num_turns = num_turns
     sim_config.num_elements = len(line.element_names)
@@ -49,13 +51,3 @@ def build_input_file(name, num_turns, line, particles, checkpoint_every=-1):
     with open(name, 'wb') as fid:
         fid.write(simbuf.buffer.tobytes())
     return sim_config
-
-
-def read_output_file(filename):
-    with open(filename, 'rb') as fid:
-        state_bytes = fid.read()
-    buffer_out = xo.ContextCpu().new_buffer(capacity=len(state_bytes))
-    buffer_out.buffer[:] = np.frombuffer(state_bytes, dtype=np.int8)
-    sim_state_xobject = SimState._XoStruct._from_buffer(buffer=buffer_out, offset=0)
-    sim_state_out = SimState(_xobject=sim_state_xobject)
-    return sim_state_out

xboinc/simulation_data/simulation_state.py

@@ -0,0 +1,84 @@
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2023.                 #
+# ######################################### #
+
+import sys
+from pathlib import Path
+import numpy as np
+
+import xobjects as xo
+import xpart as xp
+
+from ..general import __version__
+
+
+# XXX.YYY.ZZZ to XXXYYYZZZ
+def _version_to_int(version):
+    vers = version.split('.')
+    return int(vers[0])*1000000 + int(vers[1])*1000 + int(vers[2])
+
+# XXXYYYZZZ to XXX.YYY.ZZZ
+def _int_to_version(verint):
+    XXX = int(verint / 1000000)
+    YYY = int((verint - XXX*1000000)/1000)
+    ZZZ = int(verint - XXX*1000000 - YYY*1000)
+    return f"{XXX}.{YYY}.{ZZZ}"
+
+
+# This class overloads the first field from the SimState,
+# in order to read the correct version from the binary
+class SimVersion(xo.HybridClass):
+    _xofields = {
+        'xboinc_version':   xo.Int64,    #  version XXX.YYY.ZZZ as int
+    }
+
+    def __init__(self, **kwargs):
+        if '_xobject' not in kwargs:
+            kwargs['xboinc'] = _version_to_int(version)
+        super().__init__(**kwargs)
+
+    def assert_version(self):
+        if _version_to_int(__version__) != self.xboinc_version:
+            error += f"Incompatible xboinc version! Output file needs "
+            error +  f"{_int_to_version(self.xboinc_version)}, "
+            error +  f"but current version is {__version__}.\n"
+            raise ValueError(error)
+
+
+class SimState(xo.HybridClass):
+    _xofields = {
+        'version':   SimVersion,    # This HAS to be the first field!
+        'i_turn':    xo.Int64,
+        'size':      xo.Int64,
+        'particles': xp.Particles,
+    }
+
+    def __init__(self, **kwargs):
+        if '_xobject' not in kwargs:
+            kwargs['version'] = SimVersion()
+        super().__init__(**kwargs)
+
+    @classmethod
+    def from_binary(filename, offset=0):
+        # Read binary
+        filename = Path(filename)
+        with filename.open('rb') as fid:
+            state_bytes = fid.read()
+        buffer_data = xo.ContextCpu().new_buffer(capacity=len(state_bytes))
+        buffer_data.buffer[:] = np.frombuffer(state_bytes, dtype=np.int8)
+        # Cast to SimVersion to verify versions of xsuite packages
+        version_offset = -1
+        for field in cls._XoStruct._fields:
+            if field.name == 'version':
+                version_offset = field.offset
+        if version_offset == -1:
+            raise ValueError("No xofield 'version' found in SimState!")
+        simver_xobject = SimVersion._XoStruct._from_buffer(buffer=buffer_data, offset=offset+version_offset)
+        simver = SimVersion(_xobject=simver_xobject)
+        simver.assert_version()
+        # Retrieve simulation state
+        simstate_xobject = cls._XoStruct._from_buffer(buffer=buffer_data, offset=offset)
+        simstate_out = cls(_xobject=simstate_xobject)
+        return simstate_out
+