mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-10-31 19:52:29 +00:00
Code Activity
z3/scripts/mk_win_dist_cmake.py
Nikolaj Bjorner 30b4fe69e4 2nd attempt to use uniform java library location under bin #7406 
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
2024-09-30 10:05:09 -07:00

424 lines
14 KiB
Python
Raw Blame History

############################################
# Copyright (c) 2012 Microsoft Corporation
#
# Scripts for automatically generating
# Window distribution zip files.
#
# Author: Leonardo de Moura (leonardo)
############################################
import os
import subprocess
import zipfile
import re
import getopt
import sys
import shutil
from mk_exception import *
from fnmatch import fnmatch
def getenv(name, default):
try:
return os.environ[name].strip(' "\'')
except:
return default
BUILD_DIR = 'build-dist'
DIST_DIR = 'dist'
BUILD_X64_DIR = os.path.join(BUILD_DIR, 'x64')
BUILD_X86_DIR = os.path.join(BUILD_DIR, 'x86')
BUILD_ARM64_DIR = os.path.join(BUILD_DIR, 'arm64')
VERBOSE = True
FORCE_MK = False
ASSEMBLY_VERSION = None
DOTNET_CORE_ENABLED = True
DOTNET_KEY_FILE = None
JAVA_ENABLED = True
ZIP_BUILD_OUTPUTS = False
GIT_HASH = False
PYTHON_ENABLED = True
X86ONLY = False
X64ONLY = False
ARM64ONLY = False
ARCHITECTURES = []
def set_verbose(flag):
global VERBOSE
VERBOSE = flag
def is_verbose():
return VERBOSE
def mk_dir(d):
if not os.path.exists(d):
if is_verbose():
print("Make directory", d)
os.makedirs(d)
def get_z3_name(arch):
version = "4"
if ASSEMBLY_VERSION:
version = ASSEMBLY_VERSION
print("Assembly version:", version)
if GIT_HASH:
return 'z3-%s.%s-%s-win' % (version, get_git_hash(), arch)
else:
return 'z3-%s-%s-win' % (version, arch)
def get_build_dir(arch):
return ARCHITECTURES[arch]
def get_build_dist(arch):
return os.path.join(get_build_dir(arch), DIST_DIR)
def get_build_dist_path(arch):
return os.path.join(get_build_dir(arch), DIST_DIR, get_z3_name(arch))
def get_bin_dist_path(arch):
return os.path.join(get_build_dist_path(arch), "bin")
def get_lib_dist_path(arch):
return os.path.join(get_build_dist_path(arch), "lib")
def get_java_dist_path(arch):
return os.path.join(get_build_dist_path(arch), "java")
def get_dist_path(arch):
return os.path.join(DIST_DIR, arch)
def set_build_dir(path):
global BUILD_DIR, BUILD_X86_DIR, BUILD_X64_DIR, BUILD_ARM64_DIR, ARCHITECTURES
BUILD_DIR = os.path.expanduser(os.path.normpath(path))
BUILD_X86_DIR = os.path.join(path, 'x86')
BUILD_X64_DIR = os.path.join(path, 'x64')
BUILD_ARM64_DIR = os.path.join(path, 'arm64') # Set ARM64 build directory
ARCHITECTURES = {'x64': BUILD_X64_DIR, 'x86':BUILD_X86_DIR, 'arm64':BUILD_ARM64_DIR}
def display_help():
print("mk_win_dist.py: Z3 Windows distribution generator\n")
print("This script generates the zip files containing executables, dlls, header files for Windows.")
print("It must be executed from the Z3 root directory.")
print("\nOptions:")
print(" -h, --help display this message.")
print(" -s, --silent do not print verbose messages.")
print(" -b <sudir>, --build=<subdir> subdirectory where x86 and x64 Z3 versions will be built (default: build-dist).")
print(" -f, --force force script to regenerate Makefiles.")
print(" --version=<version> release version.")
print(" --assembly-version assembly version for dll")
print(" --nodotnet do not include .NET bindings in the binary distribution files.")
print(" --dotnet-key=<file> strongname sign the .NET assembly with the private key in <file>.")
print(" --nojava do not include Java bindings in the binary distribution files.")
print(" --nopython do not include Python bindings in the binary distribution files.")
print(" --zip package build outputs in zip file.")
print(" --githash include git hash in the Zip file.")
print(" --x86-only x86 dist only.")
print(" --x64-only x64 dist only.")
print(" --arm64-only arm64 dist only.")
exit(0)
# Parse configuration option for mk_make script
def parse_options():
global FORCE_MK, JAVA_ENABLED, ZIP_BUILD_OUTPUTS, GIT_HASH, DOTNET_CORE_ENABLED, DOTNET_KEY_FILE, ASSEMBLY_VERSION, PYTHON_ENABLED, X86ONLY, X64ONLY, ARM64ONLY
path = BUILD_DIR
options, remainder = getopt.gnu_getopt(sys.argv[1:], 'b:hsf', ['build=',
'help',
'silent',
'force',
'nojava',
'nodotnet',
'dotnet-key=',
'assembly-version=',
'zip',
'githash',
'nopython',
'x86-only',
'x64-only',
'arm64-only'
])
for opt, arg in options:
if opt in ('-b', '--build'):
if arg == 'src':
raise MKException('The src directory should not be used to host the Makefile')
path = arg
elif opt in ('-s', '--silent'):
set_verbose(False)
elif opt in ('-h', '--help'):
display_help()
elif opt in ('-f', '--force'):
FORCE_MK = True
elif opt == '--nodotnet':
DOTNET_CORE_ENABLED = False
elif opt == '--assembly-version':
ASSEMBLY_VERSION = arg
elif opt == '--nopython':
PYTHON_ENABLED = False
elif opt == '--dotnet-key':
DOTNET_KEY_FILE = arg
elif opt == '--nojava':
JAVA_ENABLED = False
elif opt == '--zip':
ZIP_BUILD_OUTPUTS = True
elif opt == '--githash':
GIT_HASH = True
elif opt == '--x86-only' and not X64ONLY:
X86ONLY = True
elif opt == '--arm64-only' and not X86ONLY and not X64ONLY:
ARM64ONLY = True
elif opt == '--x64-only' and not X86ONLY:
X64ONLY = True
else:
raise MKException("Invalid command line option '%s'" % opt)
set_build_dir(path)
# Check whether build directory already exists or not
def check_build_dir(path):
return os.path.exists(path) and os.path.exists(os.path.join(path, 'Makefile'))
def check_output(cmd):
out = subprocess.Popen(cmd, stdout=subprocess.PIPE).communicate()[0]
if out != None:
enc = sys.getdefaultencoding()
if enc != None: return out.decode(enc).rstrip('\r\n')
else: return out.rstrip('\r\n')
else:
return ""
def get_git_hash():
try:
branch = check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD'])
r = check_output(['git', 'show-ref', '--abbrev=12', 'refs/heads/%s' % branch])
except:
raise MKException("Failed to retrieve git hash")
ls = r.split(' ')
if len(ls) != 2:
raise MKException("Unexpected git output " + r)
return ls[0]
# Create a build directory using mk_make.py
def mk_build_dir(arch):
build_path = get_build_dir(arch)
if not check_build_dir(build_path) or FORCE_MK:
mk_dir(build_path)
vsarch = arch
if arch == "arm64":
vsarch = "amd64_arm64"
cmds = []
cmds.append(f"cd {build_path}")
cmds.append('call "%VCINSTALLDIR%Auxiliary\\build\\vcvarsall.bat" ' + vsarch)
cmd = []
cmd.append("cmake -S .")
if DOTNET_CORE_ENABLED:
cmd.append(' -DZ3_BUILD_DOTNET_BINDINGS=ON')
# cmd.append(' -DZ3_INSTALL_DOTNET_BINDINGS=ON')
if JAVA_ENABLED:
cmd.append(' -DZ3_BUILD_JAVA_BINDINGS=ON')
cmd.append(' -DZ3_INSTALL_JAVA_BINDINGS=ON')
cmd.append(' -DZ3_JAVA_JAR_INSTALLDIR=java')
cmd.append(' -DZ3_JAVA_JNI_LIB_INSTALLDIR=bin/java')
if PYTHON_ENABLED:
cmd.append(' -DZ3_BUILD_PYTHON_BINDINGS=ON')
cmd.append(' -DZ3_INSTALL_PYTHON_BINDINGS=ON')
cmd.append(' -DCMAKE_INSTALL_PYTHON_PKG_DIR=bin/python')
if GIT_HASH:
git_hash = get_git_hash()
cmd.append(' -DGIT_HASH=' + git_hash)
cmd.append(' -DZ3_USE_LIB_GMP=OFF')
cmd.append(' -DZ3_BUILD_LIBZ3_SHARED=ON')
cmd.append(' -DCMAKE_BUILD_TYPE=RelWithDebInfo')
cmd.append(' -DCMAKE_INSTALL_PREFIX=' + os.path.join(DIST_DIR, get_z3_name(arch)))
cmd.append(' -G "Ninja"')
cmd.append(' ../..\n')
cmds.append("".join(cmd))
print("CMAKE commands:", cmds)
sys.stdout.flush()
if exec_cmds(cmds) != 0:
raise MKException("failed to run commands")
# Check if on Visual Studio command prompt
def check_vc_cmd_prompt():
try:
DEVNULL = open(os.devnull, 'wb')
subprocess.call(['cl'], stdout=DEVNULL, stderr=DEVNULL)
except:
raise MKException("You must execute the mk_win_dist.py script on a Visual Studio Command Prompt")
def exec_cmds(cmds):
cmd_file = 'z3_tmp.cmd'
f = open(cmd_file, 'w')
for cmd in cmds:
f.write(cmd)
f.write('\n')
f.close()
res = 0
try:
res = subprocess.call(cmd_file, shell=True)
except:
res = 1
try:
os.erase(cmd_file)
except:
pass
return res
def build_z3(arch):
if is_verbose():
print("build z3")
build_dir = get_build_dir(arch)
if arch == "arm64":
arch = "amd64_arm64"
cmds = []
cmds.append('call "%VCINSTALLDIR%Auxiliary\\build\\vcvarsall.bat" ' + arch)
cmds.append('cd %s' % build_dir)
cmds.append('ninja install')
if exec_cmds(cmds) != 0:
raise MKException("Failed to make z3")
def mk_zip(arch):
if not ZIP_BUILD_OUTPUTS:
return
build_dist = get_build_dist_path(arch)
dist_name = get_z3_name(arch)
dist_path = get_dist_path(arch)
build_dir = get_build_dir(arch)
old = os.getcwd()
try:
if is_verbose():
print("dist path", dist_path)
mk_dir(dist_path)
zfname = os.path.join(dist_path, '%s.zip' % dist_name)
zipout = zipfile.ZipFile(zfname, 'w', zipfile.ZIP_DEFLATED)
os.chdir(get_build_dist(arch))
for root, dirs, files in os.walk("."):
for f in files:
if is_verbose():
print("adding ", os.path.join(root, f))
zipout.write(os.path.join(root, f))
if is_verbose():
print("Generated '%s'" % zfname)
except:
pass
os.chdir(old)
VS_RUNTIME_PATS = [re.compile(r'vcomp.*\.dll'),
re.compile(r'msvcp.*\.dll'),
re.compile(r'msvcr.*\.dll'),
re.compile(r'vcrun.*\.dll')]
# Copy Visual Studio Runtime libraries
def cp_vs_runtime(arch):
platform = arch
vcdir = os.environ['VCINSTALLDIR']
path = '%sredist' % vcdir
vs_runtime_files = []
print("Walking %s" % path)
# Everything changes with every release of VS
# Prior versions of VS had DLLs under "redist\x64"
# There are now several variants of redistributables
# The naming convention defies my understanding so
# we use a "check_root" filter to find some hopefully suitable
# redistributable.
def check_root(root):
return platform in root and ("CRT" in root or "MP" in root) and "onecore" not in root and "debug" not in root
for root, dirs, files in os.walk(path):
for filename in files:
if fnmatch(filename, '*.dll') and check_root(root):
print("Checking %s %s" % (root, filename))
for pat in VS_RUNTIME_PATS:
if pat.match(filename):
fname = os.path.join(root, filename)
if not os.path.isdir(fname):
vs_runtime_files.append(fname)
if not vs_runtime_files:
raise MKException("Did not find any runtime files to include")
bin_dist_path = get_bin_dist_path(arch)
for f in vs_runtime_files:
shutil.copy(f, bin_dist_path)
if is_verbose():
print("Copied '%s' to '%s'" % (f, bin_dist_path))
def cp_license(arch):
if is_verbose():
print("copy licence")
path = get_build_dist_path(arch)
mk_dir(path)
shutil.copy("LICENSE.txt", path)
def cp_dotnet(arch):
if not DOTNET_CORE_ENABLED:
return
if is_verbose():
print("copy dotnet")
build_dir = get_build_dir(arch)
dist_dir = get_bin_dist_path(arch)
shutil.copytree(os.path.join(build_dir, "Microsoft.Z3"),
dist_dir,
dirs_exist_ok=True)
def cp_into_bin(arch):
if is_verbose():
print("copy lib")
lib_dir = get_lib_dist_path(arch)
bin_dir = get_bin_dist_path(arch)
shutil.copyfile(os.path.join(lib_dir, "libz3.lib"),
os.path.join(bin_dir, "libz3.lib"))
shutil.rmtree(lib_dir)
if JAVA_ENABLED:
java_dir = os.path.join(bin_dir, "java")
for file in os.listdir(java_dir):
src_path = os.path.join(java_dir, file)
dst_path = os.path.join(bin_dir, file)
shutil.copy2(src_path, dst_path)
shutil.rmtree(java_dir)
def cp_pdb(arch):
if is_verbose():
print("copy pdb")
build_dir = get_build_dir(arch)
bin_path = get_bin_dist_path(arch)
mk_dir(bin_path)
for f in os.listdir(build_dir):
if f.endswith("libz3.pdb"):
shutil.copy(os.path.join(build_dir, f), bin_path)
def build_for_arch(arch):
mk_build_dir(arch)
build_z3(arch)
cp_license(arch)
cp_pdb(arch)
cp_dotnet(arch)
cp_vs_runtime(arch)
cp_into_bin(arch)
mk_zip(arch)
# Entry point
def main():
if os.name != 'nt':
raise MKException("This script is for Windows only")
parse_options()
check_vc_cmd_prompt()
if X86ONLY:
build_for_arch("x86")
elif X64ONLY:
build_for_arch("x64")
elif ARM64ONLY:
build_for_arch("arm64")
else:
for arch in ARCHITECTURES:
build_for_arch(arch)
main()
View git blame Copy permalink