Hardware
/
litex
mirror of https://github.com/enjoy-digital/litex.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

litex_setup: Improve script status prints.

This commit is contained in:
Florent Kermarrec 2022-01-05 14:52:21 +01:00
parent a6e2a529dc
commit c424e51df4
1 changed files with 74 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
litex_setup.py
View File

@ -2,6 +2,7 @@
import os import os
import sys import sys
import time
import subprocess import subprocess
import shutil import shutil
import hashlib import hashlib
@ -9,9 +10,46 @@ import argparse
import urllib.request import urllib.request
start_time = time.time()
current_path = os.path.abspath(os.curdir) current_path = os.path.abspath(os.curdir)
# Git Repositories --------------------------------------------------------------------------------- # Helpers ------------------------------------------------------------------------------------------
def colorer(s, color="bright"): # FIXME: Move colorer to litex.common?
header = {
"bright" : "\x1b[1m",
"green" : "\x1b[1m\x1b[32m",
"cyan" : "\x1b[1m\x1b[36m",
"red" : "\x1b[1m\x1b[31m",
"yellow" : "\x1b[1m\x1b[33m",
"underline" : "\x1b[1m\x1b[4m"}[color]
trailer = "\x1b[0m"
return header + str(s) + trailer
def print_banner():
b = []
b.append(" __ _ __ _ __ ")
b.append(" / / (_) /____ | |/_/ ")
b.append(" / /__/ / __/ -_)> < ")
b.append(" /____/_/\\__/\\__/_/|_| ")
b.append(" Build your hardware, easily! ")
b.append(" LiteX Setup utility. ")
b.append("")
print("\n".join(b))
def print_status(status):
exec_time = (time.time() - start_time)
print(colorer(f"[{exec_time:8.3f}]", color="green") + " " + colorer(status))
def print_error(status):
exec_time = (time.time() - start_time)
print(colorer(f"[{exec_time:8.3f}]", color="red") + " " + colorer(status))
class SetupError(Exception):
def __init__(self):
sys.stderr = None # Error already described, avoid traceback/exception.
# Git repositories ---------------------------------------------------------------------------------
# Get SHA1: git rev-parse --short=7 HEAD # Get SHA1: git rev-parse --short=7 HEAD
@ -69,9 +107,7 @@ git_repos = {
# Installs ----------------------------------------------------------------------------------------- # Installs -----------------------------------------------------------------------------------------
# Minimal: Only Migen + LiteX. # Minimal: Only Migen + LiteX.
minimal_repos = [ minimal_repos = ["migen", "litex"]
"migen", "litex"
]
# Standard: Migen + LiteX + Cores + Software + Popular CPUs (LM32, Mor1kx, SERV, VexRiscv). # Standard: Migen + LiteX + Cores + Software + Popular CPUs (LM32, Mor1kx, SERV, VexRiscv).
standard_repos = list(git_repos.keys()) standard_repos = list(git_repos.keys())
@ -95,7 +131,7 @@ install_configs = {
"full" : full_repos, "full" : full_repos,
} }
# Script Location / Auto-Update -------------------------------------------------------------------- # Script location / auto-update --------------------------------------------------------------------
def litex_setup_location_check(): def litex_setup_location_check():
# Check if script is executed inside a cloned LiteX repository or alongside? # Check if script is executed inside a cloned LiteX repository or alongside?
@ -106,30 +142,33 @@ def litex_setup_location_check():
def litex_setup_auto_update(): def litex_setup_auto_update():
litex_setup_url = "https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py" litex_setup_url = "https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py"
current_sha1 = hashlib.sha1(open(os.path.realpath(__file__)).read().encode("utf-8")).hexdigest() current_sha1 = hashlib.sha1(open(os.path.realpath(__file__)).read().encode("utf-8")).hexdigest()
print("[Checking litex_setup.py]...") print_status("LiteX Setup auto-update...")
try: try:
import requests import requests
r = requests.get(litex_setup_url) r = requests.get(litex_setup_url)
if r.status_code != 404: if r.status_code != 404:
upstream_sha1 = hashlib.sha1(r.content).hexdigest() upstream_sha1 = hashlib.sha1(r.content).hexdigest()
if current_sha1 != upstream_sha1: if current_sha1 != upstream_sha1:
print("[Updating litex_setup.py]...") print_status("LiteX Setup is obsolete, updating.")
with open(os.path.realpath(__file__), "wb") as f: with open(os.path.realpath(__file__), "wb") as f:
f.write(r.content) f.write(r.content)
os.execl(sys.executable, sys.executable, *sys.argv) os.execl(sys.executable, sys.executable, *sys.argv)
else:
print_status("LiteX Setup is up to date.")
except: except:
pass pass
# Repositories Initialization ---------------------------------------------------------------------- # Git repositories initialization ------------------------------------------------------------------
def litex_setup_init_repos(config="standard", dev_mode=False): def litex_setup_init_repos(config="standard", dev_mode=False):
print_status("Initializing Git repositories...")
print_status("--------------------------------")
for name in install_configs[config]: for name in install_configs[config]:
repo = git_repos[name] repo = git_repos[name]
os.chdir(os.path.join(current_path)) os.chdir(os.path.join(current_path))
print(f"[Checking {name}]...")
if not os.path.exists(name): if not os.path.exists(name):
# Clone Repo. # Clone Repo.
print(f"[Cloning {name}]...") print_status(f"Cloning {name} Git repository...")
repo_url = repo.url repo_url = repo.url
if dev_mode: if dev_mode:
repo_url = repo_url.replace("https://github.com/", "git@github.com:") repo_url = repo_url.replace("https://github.com/", "git@github.com:")
@ -141,18 +180,23 @@ def litex_setup_init_repos(config="standard", dev_mode=False):
if repo.sha1 is not None: if repo.sha1 is not None:
os.chdir(os.path.join(current_path, name)) os.chdir(os.path.join(current_path, name))
os.system(f"git checkout {repo.sha1:07x}") os.system(f"git checkout {repo.sha1:07x}")
else:
print_status(f"{name} Git Repo already present.")
# Repositories Update ------------------------------------------------------------------------------ # Git repositories update --------------------------------------------------------------------------
def litex_setup_update_repos(config="standard"): def litex_setup_update_repos(config="standard"):
print_status("Updating Git repositories...")
print_status("----------------------------")
for name in install_configs[config]: for name in install_configs[config]:
repo = git_repos[name] repo = git_repos[name]
os.chdir(os.path.join(current_path)) os.chdir(os.path.join(current_path))
# Check if Repo is present. # Check if Repo is present.
if not os.path.exists(name): if not os.path.exists(name):
raise Exception("{} not initialized, please (re)-run init and install first.".format(name)) print_error(f"{name} Git repository is not initialized, please run --init first.")
raise SetupError
# Update Repo. # Update Repo.
print(f"[Updating {name}]...") print_status(f"Updating {name} Git repository...")
os.chdir(os.path.join(current_path, name)) os.chdir(os.path.join(current_path, name))
subprocess.check_call("git checkout " + repo.branch, shell=True) subprocess.check_call("git checkout " + repo.branch, shell=True)
subprocess.check_call("git pull --ff-only", shell=True) subprocess.check_call("git pull --ff-only", shell=True)
@ -164,35 +208,39 @@ def litex_setup_update_repos(config="standard"):
os.chdir(os.path.join(current_path, name)) os.chdir(os.path.join(current_path, name))
os.system(f"git checkout {repo.sha1:07x}") os.system(f"git checkout {repo.sha1:07x}")
# Repositories Install ----------------------------------------------------------------------------- # Git repositories install -------------------------------------------------------------------------
def litex_setup_install_repos(config="standard", user_mode=False): def litex_setup_install_repos(config="standard", user_mode=False):
print_status("Installing Git repositories...")
print_status("------------------------------")
for name in install_configs[config]: for name in install_configs[config]:
repo = git_repos[name] repo = git_repos[name]
os.chdir(os.path.join(current_path)) os.chdir(os.path.join(current_path))
# Install Repo. # Install Repo.
if repo.develop: if repo.develop:
print(f"[Installing {name}]...") print_status(f"Installing {name} Git repository...")
os.chdir(os.path.join(current_path, name)) os.chdir(os.path.join(current_path, name))
subprocess.check_call("python3 setup.py develop {options}".format( subprocess.check_call("python3 setup.py develop {options}".format(
options="--user" if user_mode else "", options="--user" if user_mode else "",
), shell=True) ), shell=True)
if user_mode: if user_mode:
if ".local/bin" not in os.environ.get("PATH", ""): if ".local/bin" not in os.environ.get("PATH", ""):
print("Make sure that ~/.local/bin is in your PATH") print_status("Make sure that ~/.local/bin is in your PATH")
print("export PATH=$PATH:~/.local/bin") print_status("export PATH=$PATH:~/.local/bin")
# GCC Toolchains Download -------------------------------------------------------------------------- # GCC toolchains download --------------------------------------------------------------------------
def gcc_toolchain_download(url, filename): def gcc_toolchain_download(url, filename):
print_status("Downloading GCC toolchain...")
print_status("----------------------------")
if not os.path.exists(filename): if not os.path.exists(filename):
full_url = url + filename full_url = url + filename
print(f"[Downloading {full_url} to {filename}]...") print_status(f"Downloading {full_url} to {filename}...")
urllib.request.urlretrieve(full_url, filename) urllib.request.urlretrieve(full_url, filename)
else: else:
print("Using existing file {filename}.") print_status(f"Using existing file {filename}.")
print(f"[Extracting {filename}]...") print_status(f"Extracting {filename}...")
shutil.unpack_archive(filename) shutil.unpack_archive(filename)
# RISC-V toolchain. # RISC-V toolchain.
@ -253,12 +301,13 @@ def lm32_gcc_toolchain_download():
# Run ---------------------------------------------------------------------------------------------- # Run ----------------------------------------------------------------------------------------------
def main(): def main():
parser = argparse.ArgumentParser(description="LiteX Setup utility.") print_banner()
parser = argparse.ArgumentParser()
# Git Repositories. # Git Repositories.
parser.add_argument("--init", action="store_true", help="Initialize Git Repositories.") parser.add_argument("--init", action="store_true", help="Initialize Git repositories.")
parser.add_argument("--update", action="store_true", help="Update Git Repositories.") parser.add_argument("--update", action="store_true", help="Update Git repositories.")
parser.add_argument("--install", action="store_true", help="Install Git Repositories.") parser.add_argument("--install", action="store_true", help="Install Git repositories.")
parser.add_argument("--user", action="store_true", help="Install in User-Mode.") parser.add_argument("--user", action="store_true", help="Install in User-Mode.")
parser.add_argument("--config", default="standard", help="Install config (minimal, standard, full).") parser.add_argument("--config", default="standard", help="Install config (minimal, standard, full).")