Files
CoCo3_Plus_MiSTer/tools/release.py
T

153 lines
11 KiB
Python

#!/usr/bin/env python3
"""Create a checked, copyable MiSTer FAT-volume overlay from a standalone build."""
import argparse,datetime,hashlib,json,shutil,subprocess,zipfile
from pathlib import Path,PurePosixPath
ROOT=Path(__file__).resolve().parents[1]
# Reviewed source-package content. The repository retains all upstream history;
# a source-review ZIP deliberately omits historical RBFs, Office files and PDFs.
SOURCE_ROOT_FILES={'.gitattributes','.gitignore','AGENTS.md','CHANGELOG.md',
'COPYRIGHT.md','LICENSING.md','NOTICE.md','README.md','CoCo3.qpf','CoCo3.qsf',
'CoCo3.sv','CoCo3FPGA.sdc','build_id_num.v','changes.txt','external-io.sdc',
'files.qip','pll.xml','reset-cpu.sdc','uart-reset.sdc'}
SOURCE_SUFFIXES={
'docs':{'.md'},'roms':{'.md'},
'rtl':{'.sv','.v','.vh','.vhd','.mif','.hex','.qip','.qsys','.ip','.tcl','.sdc',
'.ppf','.sip','.spd'},
'sys':{'.sv','.v','.vh','.vhd','.mif','.hex','.qip','.qsys','.ip','.tcl','.sdc'},
'scripts':{'.py','.tcl'},'tests':{'.py','.sv'},'tools':{'.py','.json'},
'validation':{'.json'},'windows':{'.ps1'}}
SOURCE_REPOSITORY='https://vccplus-git.brianholman.com/VCCPlus/CoCo3_Plus_MiSTer.git'
NON_HASHED_BUILD_FILES={'.gitignore','README.md','changes.txt'}
SSC={'pic-7040-510.bin':(4096,'0013cd78482cc5f2360fdf584e9ba51d34861e8ccd9d88247f1a54039c16c365'),
'sp0256-al2.bin':(2048,'98c280fd082169c54081e503dfe7d7d9a6fd46d4ffcc973e199ea0e1d9bc1ac9')}
BOOT={'boot0.rom':(32768,'ad358430568250eb8330a37f85361d9ce67e5ae6d5a28c17b31802cd3953a5d2'),
'boot1.rom':(8192,'1c40c5a74e72edaeecc2511fee1aab347eae2c3d5fc6778cb622e3df14d63157')}
def sha(p):return hashlib.sha256(p.read_bytes()).hexdigest()
def checked(p,size,digest):
if not p.is_file() or p.stat().st_size!=size or sha(p)!=digest:raise RuntimeError('Missing or incorrect input: '+str(p))
return p
def qualify_inputs(record):
inventory_path=ROOT/'tools/project_inputs.json'
if 'project_inventory_sha256' not in record:
raise RuntimeError('Legacy FPGA receipt lacks project_inventory_sha256; preserve it unchanged and run a fresh independently qualified build. Do not backfill fit evidence.')
if record['project_inventory_sha256']!=sha(inventory_path):
raise RuntimeError('FPGA receipt does not qualify the current tools/project_inputs.json')
names=json.loads(inventory_path.read_text())['files']
if not isinstance(names,list) or len(names)!=len(set(names)):
raise RuntimeError('Invalid or duplicate project input inventory')
for name in names:
path=PurePosixPath(name)
if path.is_absolute() or '..' in path.parts or '\\' in name or ':' in name:
raise RuntimeError('Unsafe project input: '+name)
expected=set(names)-NON_HASHED_BUILD_FILES
actual=record.get('inputs')
if not isinstance(actual,dict) or set(actual)!=expected:
raise RuntimeError('FPGA receipt must qualify the exact current project input set')
for name,digest in actual.items():
path=ROOT/name
if not path.is_file() or path.is_symlink() or sha(path)!=digest:
raise RuntimeError('Source differs from built input: '+name)
def committed_tree(revision):
tree={}
for entry in subprocess.check_output(['git','ls-tree','-rz','--full-tree',revision],cwd=ROOT).split(b'\0'):
if not entry:continue
metadata,name=entry.split(b'\t',1)
mode,kind,object_id=metadata.split()
if kind==b'blob' and mode in (b'100644',b'100755'):
tree[name.decode('utf-8')]=object_id.decode('ascii')
return tree
def committed_blob(object_id):
return subprocess.check_output(['git','cat-file','blob',object_id],cwd=ROOT)
def source_member(name):
path=PurePosixPath(name)
if name in SOURCE_ROOT_FILES or name=='rtl/ssc/LICENSE':return True
if len(path.parts)==2 and path.parts[0]=='LICENSES':return True
return len(path.parts)>1 and path.suffix.lower() in SOURCE_SUFFIXES.get(path.parts[0],set())
def default_config(ssc):
# Main serializes cur_status[16] in byte order, low bits first.
# Audio / SDC / ROM / Floppy, startup Slot4, 512K; migrated-layout marker.
layout=6+(3<<3)+(1<<6)+(2<<9)
status=(1<<63)|(layout<<43)|(3<<12)|((1<<42) if ssc else 0)
return status.to_bytes(16,'little')
def make_release(output,build,roms,ssc,without_ssc=False,public=False):
record=json.loads((build/'build.json').read_text())
if not record.get('passed'):raise RuntimeError('Successful standalone FPGA build required')
rbf=checked(build/'project/output_files/CoCo3.rbf',record['rbf_bytes'],record['rbf_sha256'])
qualify_inputs(record)
inputs={} if public else {f'games/coco3plus/{n}':checked(roms/n,*identity) for n,identity in BOOT.items()}
if not without_ssc and not public:inputs.update({f'games/coco3plus/{n}':checked(ssc/n,*v) for n,v in SSC.items()})
if subprocess.check_output(['git','status','--porcelain','--untracked-files=no'],cwd=ROOT).strip():raise RuntimeError('Commit reviewed changes before creating a distributable source package')
source_revision=subprocess.check_output(['git','rev-parse','HEAD'],cwd=ROOT).decode().strip()
tree=committed_tree(source_revision)
notice_names={'NOTICE.md','LICENSING.md','COPYRIGHT.md','rtl/ssc/LICENSE'}
notice_names.update(name for name in tree if len(PurePosixPath(name).parts)==2 and name.startswith('LICENSES/'))
if not notice_names<=tree.keys():raise RuntimeError('Required committed license notices missing')
if output.exists():raise RuntimeError('Preserve previous release: '+str(output))
fat=output/'fat';fat.mkdir(parents=True)
core=f'_Computer/.coco3plus/{record["rbf_sha256"][:12]}/coco3plus.rbf';inputs[core]=rbf
for n,p in inputs.items():
target=fat/n;target.parent.mkdir(parents=True,exist_ok=True);shutil.copyfile(p,target)
for name in sorted(notice_names):
leaf='SSC-BSD-3-Clause.txt' if name=='rtl/ssc/LICENSE' else PurePosixPath(name).name
target=fat/'games/coco3plus/licenses'/leaf;target.parent.mkdir(parents=True,exist_ok=True)
target.write_bytes(committed_blob(tree[name]))
launcher=fat/'_Computer/Coco 3 Plus.mgl';launcher.parent.mkdir(exist_ok=True)
launcher.write_text(f'<mistergamedescription>\n <rbf>{core[:-4]}</rbf>\n <setname>coco3plus</setname>\n</mistergamedescription>\n',newline='\n')
config=fat/'config';config.mkdir()
(config/'coco3plus_v51.CFG').write_bytes(default_config(not without_ssc))
if not without_ssc:
for index,n in ((4,'pic-7040-510.bin'),(5,'sp0256-al2.bin')):
value=f'/media/fat/games/coco3plus/{n}'.encode()
(config/f'coco3plus.f{index}').write_bytes(value.ljust(1024,b'\0'))
manifest=dict(format=1,created_utc=datetime.datetime.now(datetime.timezone.utc).isoformat(),public_package=public,
rbf_sha256=record['rbf_sha256'],ssc_included=not without_ssc and not public,roms_required_separately=public,
files={p.relative_to(fat).as_posix():dict(bytes=p.stat().st_size,sha256=sha(p),
policy='create-if-missing' if p.name=='coco3plus_v51.CFG' else 'backup-and-replace') for p in sorted(fat.rglob('*')) if p.is_file()})
if public:manifest['required_roms']={n:dict(bytes=v[0],sha256=v[1]) for n,v in {**BOOT,**({} if without_ssc else SSC)}.items()}
(output/'manifest.json').write_text(json.dumps(manifest,indent=2)+'\n')
(output/'SHA256SUMS.txt').write_text(''.join(f'{v["sha256"]} fat/{n}\n' for n,v in manifest['files'].items()))
(output/'README.txt').write_text('Coco 3 Plus FAT-volume overlay. This is not a bootable disk image.\nCopy fat/ CONTENTS to the MiSTer FAT-volume root with MiSTer shut down.\nPreserve existing config/coco3plus_v51.CFG. Back up files before replacing.\nOriginal CoCo3 and other cores are not replaced. Start Computer/Coco 3 Plus.\nSSC ROMs, when included, are separately supplied local inputs; do not redistribute without permission.\n')
if public:
with (output/'README.txt').open('a') as file:file.write('PUBLIC CORE/SOURCE PACKAGE: no CoCo boot or SSC ROMs included.\nBefore launching, supply boot0.rom and boot1.rom in games/coco3plus and the SSC ROMs if using SSC.\nSee roms/README.md and docs/INSTALL.md in corresponding-source.zip for exact identities and source-build installation.\nThis incomplete-ROM public package is not accepted directly by the SSH installer. Build a complete local package using your own verified ROM inputs.\n')
# Use reviewed paths AND committed bytes. This ZIP has no .git metadata; the
# supported build route is a pinned full clone, not an extracted archive.
source_names=sorted(name for name in tree if source_member(name))
with zipfile.ZipFile(output/'corresponding-source.zip','x',zipfile.ZIP_DEFLATED) as archive:
for name in source_names:archive.writestr('coco3plus/'+name,committed_blob(tree[name]))
checkout=('SOURCE REVIEW ARCHIVE: no Git metadata or historical binary/manual artifacts.\n'
'Build tools require Git metadata and the full maintained project inventory.\n'
'Use Git for Windows, Python 3.10+ and the pinned Quartus toolchain.\n'
'Clone the full repository (do not use --depth), then detach at this exact revision:\n'
f'git clone {SOURCE_REPOSITORY} coco3plus\n'
'cd coco3plus\n'
f'git checkout --detach {source_revision}\n'
'git rev-parse HEAD\n'
'Follow docs/BUILD_WINDOWS.md in that checkout. Repository access is required.\n'
'The source review ZIP alone is not a standalone build checkout.\n')
(output/'SOURCE-CHECKOUT.txt').write_text(checkout)
with (output/'README.txt').open('a') as file:file.write('For the supported pinned Git build route, see SOURCE-CHECKOUT.txt. The source-review ZIP alone cannot run the build scripts.\n')
manifest['source_revision']=source_revision
manifest['project_inventory_sha256']=record['project_inventory_sha256']
manifest['source_files']=source_names
manifest['source_build_route']='Pinned full Git checkout; see SOURCE-CHECKOUT.txt'
manifest['corresponding_source_sha256']=sha(output/'corresponding-source.zip')
(output/'manifest.json').write_text(json.dumps(manifest,indent=2)+'\n')
archive_path=output.with_name(output.name+'.zip')
if archive_path.exists():raise RuntimeError('Preserve previous release archive: '+str(archive_path))
with zipfile.ZipFile(archive_path,'x',zipfile.ZIP_DEFLATED) as archive:
for file in sorted(output.rglob('*')):
if file.is_file():archive.write(file,file.relative_to(output).as_posix())
archive_path.with_suffix('.zip.sha256').write_text(sha(archive_path)+' '+archive_path.name+'\n')
return manifest
def main():
p=argparse.ArgumentParser(description=__doc__)
p.add_argument('--output',type=Path,default=ROOT/'dist/coco3plus')
p.add_argument('--build',type=Path,default=ROOT/'build/fpga')
p.add_argument('--roms',type=Path,default=ROOT/'build/roms')
p.add_argument('--ssc',type=Path,default=ROOT/'roms/ssc')
p.add_argument('--without-ssc',action='store_true')
p.add_argument('--public',action='store_true',help='Omit ALL separately obtained/assembled ROMs; core/source distribution only')
a=p.parse_args();m=make_release(a.output.resolve(),a.build.resolve(),a.roms.resolve(),a.ssc.resolve(),a.without_ssc,a.public)
print('Release '+str(a.output.resolve())+'; RBF SHA-256 '+m['rbf_sha256'])
if __name__=='__main__':main()