Common Build Tools

This file defines general utilities that abstract common build functionality and provides some common concrete build functions.

General Utilities

instance Lake.instMonadWorkspaceJobM : MonadWorkspace JobM

def Lake.instToJsonPUnit_lake : Lean.ToJson PUnit

def Lake.noBuildCode : ExitCode

Exit code to return if --no-build is set and a build is required.

def Lake.platformTrace : BuildTrace

Build trace for the host platform. If an artifact includes this trace, it is platform-dependent and will be rebuilt on different host platforms.

@[inline]

def Lake.addPlatformTrace : JobM PUnit

Mixes the platform into the current job's trace. If an artifact includes this trace, it is platform-dependent and will be rebuilt on different host platforms.

@[inline]

def Lake.addLeanTrace : JobM PUnit

Mixes Lean's trace into the current job's trace.

@[inline]

def Lake.addPureTrace {α : Type u_1} [ToString α] [ComputeHash α Id] (a : α) (caption : String := "pure") : JobM PUnit

Mixes the trace of a pure value into the current job's trace.

structure Lake.BuildMetadata : Type

The build trace file format, which stores information about a (successful) build.

• depHash : Hash
• inputs : Array (String × Lean.Json)
• outputs? : Option Lean.Json
• log : Log
• synthetic : Bool

  A trace file that was created from fetching an artifact from the cache.

instance Lake.instToJsonBuildMetadata : Lean.ToJson BuildMetadata

def Lake.BuildMetadata.fromJson? (json : Lean.Json) : Except String BuildMetadata

instance Lake.instFromJsonBuildMetadata : Lean.FromJson BuildMetadata

def Lake.BuildMetadata.ofStub (hash : Hash) : BuildMetadata

Construct build metadata from a trace stub. That is, the old version of the trace file format that just contained a hash.

@[reducible, inline, deprecated Lake.BuildMetadata.ofStub (since := "2025-06-28")]

abbrev Lake.BuildMetadata.ofHash (hash : Hash) : BuildMetadata

def Lake.BuildMetadata.parse (contents : String) : Except String BuildMetadata

Parse build metadata from a trace file's contents.

def Lake.BuildMetadata.ofFetch (inputHash : Hash) (outputs : Lean.Json) : BuildMetadata

Construct build metadata from a cached input-to-output mapping.

@[inline]

def Lake.BuildMetadata.ofBuild {α : Type u_1} [Lean.ToJson α] (depTrace : BuildTrace) (outputs : α) (log : Log) : BuildMetadata

Construct trace file contents from a build's trace, outputs, and log.

inductive Lake.SavedTrace : Type

The state of the trace file data saved on the file system.

• missing : SavedTrace
• invalid : SavedTrace
• ok (data : BuildMetadata) : SavedTrace

def Lake.readTraceFile (path : System.FilePath) : LogIO SavedTrace

Try to read data from a trace file. Logs if the read failed or the contents where invalid.

@[inline, deprecated Lake.readTraceFile (since := "2025-06-26")]

def Lake.readTraceFile? (path : System.FilePath) : LogIO (Option BuildMetadata)

Tries to read data from a trace file. On failure, returns none. Logs if the read failed or the contents where invalid.

def Lake.BuildMetadata.writeFile (path : System.FilePath) (data : BuildMetadata) : IO Unit

Write a trace file containing the metadata.

@[inline]

def Lake.writeFetchTrace (path : System.FilePath) (inputHash : Hash) (outputs : Lean.Json) : IO Unit

Write a trace file containing metadata on an artifact fetched from a cache.

@[inline]

def Lake.writeBuildTrace {α : Type u_1} [Lean.ToJson α] (path : System.FilePath) (depTrace : BuildTrace) (outputs : α) (log : Log) : IO Unit

Write a trace file containing metadata about a build.

@[reducible, inline, deprecated Lake.writeBuildTrace (since := "2025-06-28")]

abbrev Lake.writeTraceFile {α : Type u_1} [Lean.ToJson α] (path : System.FilePath) (depTrace : BuildTrace) (outputs : α) (log : Log) : IO Unit

@[specialize #[]]

def Lake.checkHashUpToDate {ι : Type u_1} [CheckExists ι] [GetMTime ι] (info : ι) (depTrace : BuildTrace) (depHash : Option Hash) (oldTrace : MTime := depTrace.mtime) : JobM Bool

Checks if the info is up-to-date by comparing depTrace with depHash. If old mode is enabled (e.g., --old), uses the oldTrace modification time as the point of comparison instead.

@[specialize #[]]

def Lake.SavedTrace.replayIfUpToDate {ι : Type u_1} [CheckExists ι] [GetMTime ι] (info : ι) (depTrace : BuildTrace) (savedTrace : SavedTrace) (oldTrace : MTime := depTrace.mtime) : JobM Bool

Checks whether info is up-to-date, and replays the log of the trace if available.

def Lake.SavedTrace.replayOrFetch (traceFile : System.FilePath) (inputHash : Hash) (outputs : Lean.Json) (savedTrace : SavedTrace) : JobM Unit

Replays the saved log from the trace if it exists and is not synthetic. Otherwise, writes a new synthetic trace file recording the fetch of the artifact from the cache.

@[specialize #[]]

def Lake.buildAction {α : Type} [Lean.ToJson α] (depTrace : BuildTrace) (traceFile : System.FilePath) (build : JobM α) (action : JobAction := JobAction.build) : JobM α

Runs build as a build action of kind action.

The build's input trace (depTrace), output hashes (the result of build), and log are saved to traceFile, if the build completes without a fatal error (i.e., it does not throw).

@[inline]

def Lake.buildUnlessUpToDate? {ι : Type u_1} [CheckExists ι] [GetMTime ι] (info : ι) (depTrace : BuildTrace) (traceFile : System.FilePath) (build : JobM PUnit) (action : JobAction := JobAction.build) (oldTrace : MTime := depTrace.mtime) : JobM Bool

Checks whether info is up-to-date, and runs build to recreate it if not. If rebuilt, saves the new depTrace and build log to traceFile. Returns whether info was already up-to-date.

Up-to-date Checking

If traceFile exists, checks that the hash in depTrace matches that of the traceFile. If not, and old mode is enabled (e.g., --old), falls back to the oldTrace modification time as the point of comparison. If up-to-date, replay the build log stored in traceFile.

If traceFile does not exist, checks that info has a newer modification time then depTrace / oldTrace. No log will be replayed.

@[inline]

def Lake.buildUnlessUpToDate {ι : Type u_1} [CheckExists ι] [GetMTime ι] (info : ι) (depTrace : BuildTrace) (traceFile : System.FilePath) (build : JobM PUnit) (action : JobAction := JobAction.build) (oldTrace : MTime := depTrace.mtime) : JobM PUnit

Checks whether info is up-to-date, and runs build to recreate it if not. If rebuilt, saves the new depTrace and build log to traceFile.

See buildUnlessUpToDate? for more details on how Lake determines whether info is up-to-date.

def Lake.writeFileHash (file : System.FilePath) (hash : Hash) : IO Unit

Saves the hash of a file and to its .hash file.

def Lake.cacheFileHash (file : System.FilePath) (text : Bool := false) : IO Unit

Computes the hash of a file and saves it to a .hash file.

If text := true, file is hashed as a text file rather than a binary file.

def Lake.clearFileHash (file : System.FilePath) : IO Unit

Remove the cached hash of a file (its .hash file) if it exists.

def Lake.fetchFileHash (file : System.FilePath) (text : Bool := false) : JobM Hash

Fetches the hash of a file that may already be cached in a .hash file. If hash files are not trusted (e.g., with --rehash) or the .hash file does not exist, it will be created with a newly computed hash.

If text := true, file is hashed as a text file rather than a binary file.

def Lake.fetchFileTrace (file : System.FilePath) (text : Bool := false) : JobM BuildTrace

Fetches the trace of a file that may have already have its hash cached in a .hash file. If no such .hash file exists, recomputes and creates it.

If text := true, file is hashed as text file rather than a binary file.

def Lake.buildFileUnlessUpToDate' (file : System.FilePath) (build : JobM PUnit) (text : Bool := false) : JobM Unit

Builds file using build unless it already exists and the current job's trace matches the trace stored in the .trace file. If built, saves the new trace and caches file's hash in a .hash file. Otherwise, tries to fetch the hash from the .hash file using fetchFileTrace. Build logs (if any) are saved to the trace file and replayed from there if the build is skipped.

For example, given file := "foo.c", compares getTrace with that in foo.c.trace. If built, the hash is cached in foo.c.hash and the new trace is saved to foo.c.trace (including the build log).

If text := true, file is hashed as a text file rather than a binary file.

@[reducible, inline, deprecated Lake.buildFileUnlessUpToDate' (since := "2024-12-06")]

abbrev Lake.buildFileUnlessUpToDate (file : System.FilePath) (depTrace : BuildTrace) (build : JobM PUnit) (text : Bool := false) : JobM BuildTrace

def Lake.Cache.saveArtifact (cache : Cache) (file : System.FilePath) (ext : String := "art") (text exe : Bool := false) : IO Artifact

Copies file to the Lake cache with the file extension ext, and saves its hash in its .hash file.

If text := true, file contents are hashed as a text file rather than a binary file.

If the Lake cache is disabled, the behavior of this function is undefined.

@[inline]

def Lake.cacheArtifact {m : Type → Type u_1} [MonadLakeEnv m] [MonadLiftT IO m] [Monad m] (file : System.FilePath) (ext : String := "art") (text exe : Bool := false) : m Artifact

Copies file to the Lake cache with the file extension ext, and saves its hash in its .hash file.

If text := true, file contents are hashed as a text file rather than a binary file.

If the Lake cache is disabled, the behavior of this function is undefined.

def Lake.computeArtifactTrace (buildFile art : System.FilePath) (contentHash : Hash) : BaseIO BuildTrace

Computes the trace of a cached artifact. buildFile is where the uncached artifact would be located.

class Lake.ResolveArtifacts (m : Type v → Type w) (α : Type u) (β : outParam (Type v)) : Type (max u w)

• resolveArtifacts? (contentHashes : α) : m (Option β)

@[specialize #[]]

def Lake.resolveArtifactsUsing? {β : Type} (α : Type u) [Lean.FromJson α] [ResolveArtifacts JobM α β] (inputHash : Hash) (traceFile : System.FilePath) (savedTrace : SavedTrace) (cache : CacheRef) : JobM (Option β)

Retrieve artifacts from the Lake cache using the the content hashes stored as α in either the saved trace file or in the cached input-to-content mapping.

structure Lake.FileOutputHash (ext : String) : Type

The content hash of an artifact which is stored with extension ext in the Lake cache.

• hash : Hash

instance Lake.instToJsonFileOutputHash {ext : String} : Lean.ToJson (FileOutputHash ext)

instance Lake.instFromJsonFileOutputHash {ext : String} : Lean.FromJson (FileOutputHash ext)

instance Lake.instResolveArtifactsFileOutputHashArtifactOfMonadLakeEnvOfMonadLiftTBaseIOOfMonad {m : Type → Type u_1} {ext : String} [MonadLakeEnv m] [MonadLiftT BaseIO m] [Monad m] : ResolveArtifacts m (FileOutputHash ext) Artifact

def Lake.fetchLocalArtifact (path : System.FilePath) (text : Bool := false) : JobM Artifact

Construct an artifact from a path outside the Lake artifact cache.

If text := true, file is hashed as a text file rather than a binary file.

def Lake.buildArtifactUnlessUpToDate (file : System.FilePath) (build : JobM PUnit) (text : Bool := false) (ext : String := "art") (restore exe : Bool := false) : JobM System.FilePath

Uses the current job's trace to search Lake's local artifact cache for an artifact with a matching extension (ext) and content hash. If one is found, use it. Otherwise, builds file using build and saves it to the cache. If Lake's local artifact cache is not enabled, falls back to buildFileUnlessUpToDate'.

If text := true, file is hashed as a text file rather than a binary file.

If restore := true, if file is missing but the artifact is in the cache, it will be copied to the file. This function will also return file rather than the path to the cached artifact.

def Lake.buildArtifactUnlessUpToDate.doBuild (file : System.FilePath) (build : JobM PUnit) (text : Bool := false) (depTrace : BuildTrace) (traceFile : System.FilePath) : JobM Hash

@[inline]

def Lake.buildFileAfterDep {α : Type u_1} (file : System.FilePath) (dep : Job α) (build : α → JobM PUnit) (extraDepTrace : JobM BuildTrace := pure BuildTrace.nil) (text : Bool := false) : SpawnM (Job System.FilePath)

Build file using build after dep completes if the dependency's trace (and/or extraDepTrace) has changed.

If text := true, file is handled as a text file rather than a binary file.

@[reducible, inline, deprecated Lake.buildFileAfterDep (since := "2024-12-06")]

abbrev Lake.buildFileAfterDepList {α : Type u_1} (file : System.FilePath) (deps : List (Job α)) (build : List α → JobM PUnit) (extraDepTrace : JobM BuildTrace := pure BuildTrace.nil) (text : Bool := false) : SpawnM (Job System.FilePath)

Build file using build after deps have built if any of their traces change.

If text := true, file is handled as a text file rather than a binary file.

@[inline, deprecated Lake.buildFileAfterDep (since := "2024-12-06")]

def Lake.buildFileAfterDepArray {α : Type u_1} (file : System.FilePath) (deps : Array (Job α)) (build : Array α → JobM PUnit) (extraDepTrace : JobM BuildTrace := pure BuildTrace.nil) (text : Bool := false) : SpawnM (Job System.FilePath)

Build file using build after deps have built if any of their traces change.

If text := true, file is handled as a text file rather than a binary file.

Common Builds

def Lake.inputBinFile (path : System.FilePath) : SpawnM (Job System.FilePath)

A build job for binary file that is expected to already exist (e.g., a data blob).

Any byte difference in a binary file will trigger a rebuild of its dependents.

def Lake.inputTextFile (path : System.FilePath) : SpawnM (Job System.FilePath)

A build job for text file that is expected to already exist (e.g., a source file).

Text file traces have normalized line endings to avoid unnecessary rebuilds across platforms.

@[inline]

def Lake.inputFile (path : System.FilePath) (text : Bool) : SpawnM (Job System.FilePath)

A build job for file that is expected to already exist (e.g., a data blob or source file).

If text := true, the file is handled as a text file rather than a binary file. Any byte difference in a binary file will trigger a rebuild of its dependents. In contrast, text file traces have normalized line endings to avoid unnecessary rebuilds across platforms.

def Lake.inputDir (path : System.FilePath) (text : Bool) (filter : System.FilePath → Bool) : SpawnM (Job (Array System.FilePath))

A build job for a directory of files that are expected to already exist. Returns an array of the files in the directory that match the filter.

If text := true, the files are handled as text files rather than a binary files. Any byte difference in a binary file will trigger a rebuild of its dependents. In contrast, text file traces have normalized line endings to avoid unnecessary rebuilds across platforms.

@[inline]

def Lake.buildO (oFile : System.FilePath) (srcJob : Job System.FilePath) (weakArgs traceArgs : Array String := #[]) (compiler : System.FilePath := { toString := "cc" }) (extraDepTrace : JobM BuildTrace := pure BuildTrace.nil) : SpawnM (Job System.FilePath)

Build an object file from a source file job using compiler. The invocation is:

compiler -c -o oFile srcFile weakArgs... traceArgs...

The traceArgs are included as part of the dependency trace hash, whereas the weakArgs are not. Thus, system-dependent options like -I or -L should be weakArgs to avoid build artifact incompatibility between systems (i.e., a change in the file path should not cause a rebuild).

You can add more components to the trace via extraDepTrace, which will be computed in the resulting Job before building.

def Lake.buildLeanO (oFile : System.FilePath) (srcJob : Job System.FilePath) (weakArgs traceArgs : Array String := #[]) (leanIncludeDir? : Option System.FilePath := none) : SpawnM (Job System.FilePath)

Build an object file from a source fie job (i.e, a lean -c output) using the Lean toolchain's C compiler.

def Lake.buildStaticLib (libFile : System.FilePath) (oFileJobs : Array (Job System.FilePath)) (thin : Bool := false) : SpawnM (Job System.FilePath)

Build a static library from object file jobs using the Lean toolchain's ar.

def Lake.buildSharedLib (libName : String) (libFile : System.FilePath) (linkObjs : Array (Job System.FilePath)) (linkLibs : Array (Job Dynlib)) (weakArgs traceArgs : Array String := #[]) (linker : String := "c++") (extraDepTrace : JobM BuildTrace := pure BuildTrace.nil) (plugin : Bool := false) (linkDeps : Bool := System.Platform.isWindows) : SpawnM (Job Dynlib)

Build a shared library by linking the results of linkJobs using the Lean toolchain's C compiler.

def Lake.buildLeanSharedLib (libName : String) (libFile : System.FilePath) (linkObjs : Array (Job System.FilePath)) (linkLibs : Array (Job Dynlib)) (weakArgs traceArgs : Array String := #[]) (plugin : Bool := false) (linkDeps : Bool := System.Platform.isWindows) : SpawnM (Job Dynlib)

Build a shared library by linking the results of linkJobs using linker.

def Lake.buildLeanExe (exeFile : System.FilePath) (linkObjs : Array (Job System.FilePath)) (linkLibs : Array (Job Dynlib)) (weakArgs traceArgs : Array String := #[]) (sharedLean : Bool := false) : SpawnM (Job System.FilePath)

Build an executable by linking the results of linkJobs using the Lean toolchain's linker.