lc-framework-src 0.1.0+lc.2025

#!/usr/bin/env python3

"""
This file is part of the LC framework for synthesizing high-speed parallel lossless and error-bounded lossy data compression and decompression algorithms for CPUs and GPUs.

BSD 3-Clause License

Copyright (c) 2021-2025, Noushin Azami, Alex Fallin, Brandon Burtchell, Andrew Rodriguez, Benila Jerald, Yiqian Liu, Anju Mongandampulath Akathoott, and Martin Burtscher
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

URL: The latest version of this code is available at https://github.com/burtscher/LC-framework.

Sponsor: This code is based upon work supported by the U.S. Department of Energy, Office of Science, Office of Advanced Scientific Research (ASCR), under contract DE-SC0022223.
"""

import re
import glob, os
from pathlib import Path
from os.path import exists
from sys import stderr
import math
import shutil
import argparse

parser = argparse.ArgumentParser("lc")
parser.add_argument("--output_dir", default=".")
parser.add_argument("--verbose", action="store_true")
parser.add_argument("--base_file", default="framework.h")
parser.add_argument("--main_file", default="framework.cu")
args = parser.parse_args()

# generate lc framework
shutil.copyfile(args.main_file, args.output_dir + "/lc.cpp")
shutil.copyfile(args.base_file, args.output_dir + "/lc.h")
for i in ["/components/include", "/preprocessors/include", "/verifiers/include"]:
    os.makedirs(args.output_dir + i, exist_ok=True)

# necessary functions
def update_enum(filename, comps, item):
  with open(filename, 'w') as f:
    f.write("#ifndef LC_" + item + "_H\n")
    f.write("#define LC_" + item + "_H\n\n")
    f.write("enum LC_" + item + " {NUL_" + item)
    for c in comps:
      if item == 'VERIFIER':
        c = c[0:]
      else:
        c = c[2:]
      f.write(", " + str(c))

    f.write("};\n\n")

def update_cpu_components(filename, comps, component_type):
  with open(filename, 'a') as f:
    for c in comps:
      if c.startswith("v_"):
        c = c[2:]
      f.write("#include \"" + component_type + "/" + str(c) + ".h\"\n")
    f.write("\n#endif\n")

def update_gpu_components(filename, comps):
  with open(filename, 'w') as f:
    for c in comps:
      f.write("#include \"../" + str(c) + ".h\"\n")
    f.write("\n#endif\n")

# find components CPU
cfiles = next(os.walk('./components'))[2]
cpucomps = []
for f in cfiles:
  if f.startswith("h_"):
    cpucomps.append(f[:-2])
if args.verbose:
    print("cpucomps \n", ', '.join(cpucomps), file=stderr)

# sort components
cpucomps.sort()

# update constants
with open(args.output_dir + '/include/consts.h', 'w') as f:
  f.write("static const int CS = 1024 * 16;  // chunk size (in bytes) [do not change]\n")

# update enum.h
update_enum(args.output_dir + '/components/include/CPUcomponents.h', cpucomps, 'CPUcomponents')

# update CPUcomponents.h
update_cpu_components(args.output_dir + '/components/include/CPUcomponents.h', cpucomps, "components")

# find preprocessors CPU
cfiles = next(os.walk('./preprocessors'))[2]
cpupreprocess = []
for f in cfiles:
  if f.startswith("h_"):
    cpupreprocess.append(f[:-2])
if args.verbose:
    print("\ncpupreprocess \n",', '.join(cpupreprocess), file=stderr)

# update preprocessor enum.h
update_enum(args.output_dir + '/preprocessors/include/CPUpreprocessors.h', cpupreprocess, 'CPUpreprocessor')

# update CPUpreprocessors.h
update_cpu_components(args.output_dir + '/preprocessors/include/CPUpreprocessors.h', cpupreprocess, "preprocessors")

# find verifiers
cfiles = next(os.walk('./verifiers'))[2]
cpuverifier = []
for f in cfiles:
  if f.endswith(".h"):
    cpuverifier.append("v_" + f[:-2])
if args.verbose:
    print("\nverifier \n", ', '.join(cpuverifier), file=stderr)

# update enum.h
update_enum(args.output_dir + '/verifiers/include/verifiers.h', cpuverifier, 'VERIFIER')

# update verifiers.h
update_cpu_components(args.output_dir + '/verifiers/include/verifiers.h', cpuverifier, "verifiers")

file = args.output_dir + "/lc.h"
# update switch host encode
with open(file, "r+") as f:
  contents = f.read()
  m = re.search(r"##switch-host-encode-beg##[\s\S]*##switch-host-encode-end##", contents)
  str_to_add = ''
  for c in cpucomps:
    c = c[2:]
    str_to_add += "        case " + str(c) + ": good = h_" + str(c) + "(csize, in, out); break;\n"
  contents = contents[:m.span()[0]] + "##switch-host-encode-beg##*/\n" + str_to_add + "        /*##switch-host-encode-end##" + contents[m.span()[1]:]
  f.seek(0)
  f.truncate()
  f.write(contents)

# update switch host decode
with open(file, "r+") as f:
  contents = f.read()
  m = re.search(r"##switch-host-decode-beg##[\s\S]*##switch-host-decode-end##", contents)
  str_to_add = ''
  for c in cpucomps:
    c = c[2:]
    str_to_add += "          case " + str(c) + ": h_i" + str(c) + "(csize, in, out); break;\n"
  contents = contents[:m.span()[0]] + "##switch-host-decode-beg##*/\n" + str_to_add + "          /*##switch-host-decode-end##" + contents[m.span()[1]:]
  f.seek(0)
  f.truncate()
  f.write(contents)

# update switch pipeline
with open(file, "r+") as f:
  contents = f.read()
  m = re.search(r"##switch-pipeline-beg##[\s\S]*##switch-pipeline-end##", contents)
  str_to_add = ''
  for c in cpucomps:
    c = c[2:]
    str_to_add += "      case " + str(c) + ": s += \" " + str(c) + "\"; break;\n"
  contents = contents[:m.span()[0]] + "##switch-pipeline-beg##*/\n" + str_to_add + "      /*##switch-pipeline-end##" + contents[m.span()[1]:]
  f.seek(0)
  f.truncate()
  f.write(contents)

# update switch verify
with open(file, "r+") as f:
  contents = f.read()
  m = re.search(r"##switch-verify-beg##[\s\S]*##switch-verify-end##", contents)
  str_to_add = ''
  for c in cpuverifier:
    c = c[2:]
    str_to_add += "      case v_" + str(c) + ": " + str(c) + "(size, recon, orig, params.size(), params.data()); break;\n"
  contents = contents[:m.span()[0]] + "##switch-verify-beg##*/\n" + str_to_add + "      /*##switch-verify-end##" + contents[m.span()[1]:]
  f.seek(0)
  f.truncate()
  f.write(contents)

# update switch host preprocess encode
with open(file, "r+") as f:
  contents = f.read()
  m = re.search(r"##switch-host-preprocess-encode-beg##[\s\S]*##switch-host-preprocess-encode-end##", contents)
  str_to_add = ''
  for c in cpupreprocess:
    c = c[2:]
    str_to_add += "      case " + str(c) + ": h_" + str(c) + "(hpreencsize, hpreencdata, params.size(), params.data()); break;\n"
  contents = contents[:m.span()[0]] + "##switch-host-preprocess-encode-beg##*/\n" + str_to_add + "      /*##switch-host-preprocess-encode-end##" + contents[m.span()[1]:]
  f.seek(0)
  f.truncate()
  f.write(contents)

# update switch host preprocess decode
with open(file, "r+") as f:
  contents = f.read()
  m = re.search(r"##switch-host-preprocess-decode-beg##[\s\S]*##switch-host-preprocess-decode-end##", contents)
  str_to_add = ''
  for c in cpupreprocess:
    c = c[2:]
    str_to_add += "      case " + str(c) + ": h_i" + str(c) + "(hpredecsize, hpredecdata, params.size(), params.data()); break;\n"
  contents = contents[:m.span()[0]] + "##switch-host-preprocess-decode-beg##*/\n" + str_to_add + "      /*##switch-host-preprocess-decode-end##" + contents[m.span()[1]:]
  f.seek(0)
  f.truncate()
  f.write(contents)

# update enum map
with open(file, "r+") as f:
    contents = f.read()
    m = re.search(r"##component-map-beg##[\s\S]*##component-map-end##", contents)
    str_to_add = ''
    i = 0
    for c in cpucomps:
        c = c[2:]
        i += 1
        str_to_add += "  components[\"" + str(c) + "\"] = " + str(i) + ";\n"
    contents = contents[:m.span()[0]] + "##component-map-beg##*/\n" + str_to_add + "  /*##component-map-end##" + contents[m.span()[1]:]
    f.seek(0)
    f.truncate()
    f.write(contents)

# update preprocessor map
with open(file, "r+") as f:
    contents = f.read()
    m = re.search(r"##preprocessor-map-beg##[\s\S]*##preprocessor-map-end##", contents)
    str_to_add = ''
    for c in cpupreprocess:
        c = c[2:]
        str_to_add += "  preprocessors[\"" + str(c) + "\"] = " + str(c) + ";\n"
    contents = contents[:m.span()[0]] + "##preprocessor-map-beg##*/\n" + str_to_add + "  /*##preprocessor-map-end##" + contents[m.span()[1]:]
    f.seek(0)
    f.truncate()
    f.write(contents)

# update verifier map
with open(file, "r+") as f:
    contents = f.read()
    m = re.search(r"##verifier-map-beg##[\s\S]*##verifier-map-end##", contents)
    str_to_add = ''
    for c in cpuverifier:
        c = c[2:]
        str_to_add += "  verifs[\"" + str(c) + "\"] = v_" + str(c) + ";\n"
    contents = contents[:m.span()[0]] + "##verifier-map-beg##*/\n" + str_to_add + "  /*##verifier-map-end##" + contents[m.span()[1]:]
    f.seek(0)
    f.truncate()
    f.write(contents)

print("\nCompile with\ng++ -O3 -march=native -fopenmp -mno-fma -ffp-contract=off -DUSE_CPU -I. -std=c++17 -o lc lc.cpp\n")
print("Run the following command to see the usage message\n./lc")