Added versioning to executable generation.

Author: freddieknets

version.sh

@@ -65,10 +65,15 @@ case ${answer:0:1} in
     ;;
 esac
 
-# Check if at least bumping the minor version, because then we freeze the xsuite env
+# Two cases:
+#    patch: Only internal changes (interface to xboinc and server etc)
+#           No changes to the underlying C  ->  xsuite versions remain pinned
+#    minor: Changes to the underlying C  ->  new xsuite versions are pinned
+#           This is when we want to create a new executable for the server
 current_ver=(${current_ver//./ })
 current_ver=${current_ver[0]}.${current_ver[1]}
 minor_ver=(${expected_ver//./ })
+exec_ver=$(( 1000*${minor_ver[0]} + ${minor_ver[1]} ))
 minor_ver=${minor_ver[0]}.${minor_ver[1]}
 if [[ "$minor_ver" != "$current_ver" ]]
 then
@@ -87,10 +92,11 @@ then
     echo "Fatal error: poetry --dry-run expected $expected_ver, but result is $new_ver..."
     exit 1
 fi
-sed -i "s/\(__version__ =\).*/\1 '"${new_ver}"'/"         xboinc/general.py
-sed -i "s/\(assert __version__ ==\).*/\1 '"${new_ver}"'/" tests/test_version.py
+sed -i "s/\(int64_t xboinc_exec_version =\).*/\1 "${exec_ver}";/" xboinc/executable/main.c
+sed -i "s/\(__version__ =\).*/\1 '"${new_ver}"'/"                 xboinc/general.py
+sed -i "s/\(assert __version__ ==\).*/\1 '"${new_ver}"'/"         tests/test_version.py
 git reset
-git add pyproject.toml xboinc/general.py tests/test_version.py
+git add pyproject.toml xboinc/general.py tests/test_version.py xboinc/executable/main.c
 git commit -m "Updated version number to v"${new_ver}"."
 git push
 

xboinc/__init__.py

@@ -12,9 +12,8 @@
 from .register import register
 from .submit import SubmitJobs
 
-from .simulation_data import build_input_file
-
-from .generate_executable_source import generate_executable_source, generate_executable
+from .simulation_io import SimState, SimConfig
+from .executable import generate_executable_source, generate_executable
 
 
 # Check that the active environment has the correct pinned versions

xboinc/executable/__init__.py

@@ -0,0 +1,6 @@
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2023.                 #
+# ######################################### #
+
+from .generate_executable_source import generate_executable_source, generate_executable

xboinc/default_tracker.py renamed to xboinc/executable/default_tracker.py

@@ -1,7 +1,7 @@
 import xobjects as xo
 from .default_tracker import get_default_tracker
-from .simulation_data import SimState, SimConfig
-from .general import _pkg_root
+from .simulation_io import SimState, SimConfig
+from .general import _pkg_root, __version__
 
 from pathlib import Path
 import shutil
@@ -16,7 +16,6 @@
 
 def generate_executable_source(write_source_files=True,
                                        _context=None):
-
     assert _context is None
     assert write_source_files
 
@@ -52,21 +51,24 @@ def generate_executable_source(write_source_files=True,
 
 
 def generate_executable(keep_source=False):
-    
     main    = Path.cwd() / "main.c"
     config  = Path.cwd() / "sim_config.h"
     tracker = Path.cwd() / "xtrack_tracker.h"
     if not main.exists() or not config.exists() or not tracker.exists():
         source_files = generate_executable_source()
-    
+
     if shutil.which("gcc") is not None:
         compiler = "gcc"
     elif shutil.which("clang") is not None:
         compiler = "clang"
     else:
         raise RuntimeError("Neither clang or gcc are found. Install a C compiler.")
-    
-    cmd = subprocess.run([compiler, 'main.c', '-o', 'xboinc_executable', '-lm'],
+
+    tag = '.'.join(__version__.split('.')[:2])
+    cmd = subprocess.run(['uname', '-ps'], stdout=subprocess.PIPE)
+    if cmd.returncode == 0:
+        tag += '-' + cmd.stdout.decode('UTF-8').strip().lower().replace(' ','-')
+    cmd = subprocess.run([compiler, 'main.c', '-o', f'xboinc_{tag}', '-lm'],
                           stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     if cmd.returncode != 0:
         stderr = cmd.stderr.decode('UTF-8').strip().split('\n')

xboinc/generate_executable_source.py renamed to xboinc/executable/generate_executable_source.py

@@ -0,0 +1,144 @@
+#include <math.h>
+
+#include "xtrack_tracker.h"
+#include "sim_config.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+
+
+// Do not change
+// ==================================
+// version XXX.YYY as int  (no patch)
+int64_t xboinc_exec_version = 0;
+// ==================================
+
+
+int8_t* file_to_buffer(char *filename, int8_t* buf_in){
+
+    FILE *sim_fid;
+    int8_t *buf;
+
+    // Get buffer
+    sim_fid = fopen(filename, "rb");
+    if (!sim_fid){
+        return NULL;
+    }
+    fseek(sim_fid, 0L, SEEK_END);
+    unsigned long filesize = ftell(sim_fid);
+    fseek(sim_fid, 0L, SEEK_SET);
+    if (buf_in){
+        printf("Reusing buffer\n");
+        buf = buf_in;
+    }
+    else{
+        buf = malloc(filesize*sizeof(int8_t));
+    }
+    fread(buf, sizeof(int8_t), filesize, sim_fid);
+    fclose(sim_fid);
+
+    return (buf);
+}
+
+
+int main(){
+
+    int8_t* sim_buffer = file_to_buffer("./xboinc_input.bin", NULL);
+    if (!sim_buffer){
+        printf("Error: could not read simulation input file\n");
+        return -1;
+    }
+
+    // Get sim config
+    SimConfig sim_config = (SimConfig) sim_buffer;
+    SimVersion sim_ver = SimConfig_getp_sim_state_version(sim_config);
+    int64_t input_version = SimVersionData_get_xboinc_version(sim_ver);
+    // Compatible if major and minor versions match (no new executables are made at patches)
+    input_version = input_version/1000;
+    if (input_version != xboinc_exec_version){
+        printf("Error: Xboinc version of executable and input file do not match!\n");
+        return -1;  // error
+    }
+
+    const int64_t num_turns = SimConfig_get_num_turns(sim_config);
+    const int64_t num_elements = SimConfig_get_num_elements(sim_config);
+    printf("num_turns: %d\n", (int) num_turns);
+    printf("num_elements: %d\n", (int) num_elements);
+
+    ParticlesData particles = SimConfig_getp_sim_state_particles(sim_config);
+    SimStateData sim_state = SimConfig_getp_sim_state(sim_config);
+    int64_t checkpoint_every = SimConfig_get_checkpoint_every(sim_config);
+
+    // Check if checkpoint exists
+    printf("sim_state: %p\n", (int8_t*) sim_state);
+    int8_t* loaded = file_to_buffer("./checkpoint.bin", (int8_t*) sim_state);
+    if (loaded){
+       printf("Loaded checkpoint\n");
+    }
+    else{
+       printf("No checkpoint found\n");
+    }
+
+    int64_t step_turns;
+    if (checkpoint_every>0){
+        step_turns = checkpoint_every;
+    } else {
+        step_turns = num_elements;
+    }
+
+    int64_t current_turn = SimStateData_get_i_turn(sim_state);
+    while (current_turn < num_turns){
+        if (current_turn > num_turns - checkpoint_every){
+            step_turns = num_turns - checkpoint_every;
+        }
+        track_line(
+            sim_buffer, // int8_t* buffer,
+            SimConfig_getp_line_metadata(sim_config), // ElementRefData elem_ref_data
+            particles,  // ParticlesData particles,
+            step_turns, // int num_turns,
+            0,    // int ele_start,
+            (int) num_elements, //    int num_ele_track,
+            1,    // int flag_end_turn_actions,
+            1,    // int flag_reset_s_at_end_turn,
+            0,    // int flag_monitor,
+            0,    // int64_t num_ele_line, (needed only for backtracking)
+            0.0,  // double line_length, (needed only for backtracking)
+            NULL, // int8_t* buffer_tbt_monitor,
+            0,    // int64_t offset_tbt_monitor
+            NULL  // int8_t* io_buffer,
+        );
+        SimStateData_set_i_turn(sim_state, SimStateData_get_i_turn(sim_state) + step_turns);
+
+        if (checkpoint_every>0){
+            printf("Checkpointing turn %d!\n", (int) SimStateData_get_i_turn(sim_state));
+            FILE *chkp_fid;
+            chkp_fid = fopen("./checkpoint.bin", "wb");
+            fwrite(SimConfig_getp_sim_state(sim_config), sizeof(int8_t),
+                SimConfig_get_sim_state_size(sim_config), chkp_fid);
+            fclose(chkp_fid);
+        }
+    }
+
+    // Quick check
+    //for (int ii=0; ii<ParticlesData_get__capacity(particles); ii++){
+        //printf("s[%d] = %e\n", ii, ParticlesData_get_s(particles, (int64_t) ii));
+    //}
+
+    // Save output
+    FILE *out_fid;
+    out_fid = fopen("./sim_state_out.bin", "wb");
+    fwrite(SimConfig_getp_sim_state(sim_config), sizeof(int8_t),
+           SimConfig_get_sim_state_size(sim_config), out_fid);
+    fclose(out_fid);
+
+    // Remove checkpoint
+    if (remove("./checkpoint.bin") != 0){
+        printf("Error: could not remove checkpoint file\n");
+        return -1;  // error
+    }
+    else{
+        printf("Checkpoint file removed\n");
+    }
+
+    return 0;
+}

xboinc/executable/main.c

@@ -7,6 +7,11 @@
 
 _pkg_root = Path(__file__).parent.absolute()
 
+
+# ====================================================================
+# Do not change
+# ====================================================================
+
 __version__ = '0.0.3'
 
 # These are the xsuite modules that are used by boinc and the versions they are tied to.
@@ -21,3 +26,5 @@
     'xfields'  : '0.13.1',
     'xcoll'    : '0.2.5',
 }
+
+# ====================================================================