Skip to content

Commit

Permalink
cleanup llb generation
Browse files Browse the repository at this point in the history
  • Loading branch information
@coffee-cup
coffee-cup committed Jan 29, 2025
1 parent d88ea74 commit c36ab92
Showing 1 changed file with 85 additions and 67 deletions.
152 changes: 85 additions & 67 deletions buildkit/build_llb/build_graph.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ func NewBuildGraph(plan *plan.BuildPlan, baseState *llb.State, cacheStore *Build
return g, nil
}

// GenerateLLB generates the LLB state for the build graph
func (g *BuildGraph) GenerateLLB() (*BuildGraphOutput, error) {
// Get processing order using topological sort
order, err := g.graph.ComputeProcessingOrder()
Expand Down Expand Up @@ -119,6 +120,8 @@ func (g *BuildGraph) GenerateLLB() (*BuildGraphOutput, error) {
}, nil
}

// mergeNodes merges the states of the given nodes into a single state
// This essentially creates a scratch file system and then copies the contents of each node's state into it
func (g *BuildGraph) mergeNodes(nodes []*StepNode) llb.State {
stateNames := []string{}
for _, node := range nodes {
Expand All @@ -142,6 +145,7 @@ func (g *BuildGraph) mergeNodes(nodes []*StepNode) llb.State {
return result
}

// processNode processes a node and its parents to determine the state to build upon
func (g *BuildGraph) processNode(node *StepNode) error {
// If already processed, we're done
if node.Processed {
Expand Down Expand Up @@ -217,6 +221,7 @@ func (g *BuildGraph) processNode(node *StepNode) error {
return nil
}

// convertNodeToLLB converts a step node to an LLB state
func (g *BuildGraph) convertNodeToLLB(node *StepNode, baseState *llb.State) (*llb.State, error) {
state := *baseState
state = state.Dir("/app")
Expand Down Expand Up @@ -293,92 +298,105 @@ func (g *BuildGraph) getNodeStartingState(baseState llb.State, node *StepNode) (
func (g *BuildGraph) convertCommandToLLB(node *StepNode, cmd plan.Command, state llb.State, step *plan.Step) (llb.State, error) {
switch cmd := cmd.(type) {
case plan.ExecCommand:
opts := []llb.RunOption{llb.Shlex(cmd.Cmd)}
if cmd.CustomName != "" {
opts = append(opts, llb.WithCustomName(cmd.CustomName))
}
return g.convertExecCommandToLLB(node, cmd, state)
case plan.PathCommand:
return g.convertPathCommandToLLB(node, cmd, state)
case plan.VariableCommand:
return g.convertVariableCommandToLLB(node, cmd, state)
case plan.CopyCommand:
return g.convertCopyCommandToLLB(cmd, state)
case plan.FileCommand:
return g.convertFileCommandToLLB(cmd, state, step)
}
return state, nil
}

if node.Step.UseSecrets == nil || *node.Step.UseSecrets { // default to using secrets
for _, secret := range g.Plan.Secrets {
opts = append(opts, llb.AddSecret(secret, llb.SecretID(secret), llb.SecretAsEnv(true), llb.SecretAsEnvName(secret)))
}
func (g *BuildGraph) convertExecCommandToLLB(node *StepNode, cmd plan.ExecCommand, state llb.State) (llb.State, error) {
opts := []llb.RunOption{llb.Shlex(cmd.Cmd)}
if cmd.CustomName != "" {
opts = append(opts, llb.WithCustomName(cmd.CustomName))
}

// If there is a secrets hash, add a mount to invalidate the cache if the secrets hash changes
if g.SecretsHash != "" {
opts = append(opts, llb.AddMount("/cache-invalidate",
llb.Scratch().File(llb.Mkfile("secrets-hash", 0644, []byte(g.SecretsHash)))))
}
if node.Step.UseSecrets == nil || *node.Step.UseSecrets { // default to using secrets
for _, secret := range g.Plan.Secrets {
opts = append(opts, llb.AddSecret(secret, llb.SecretID(secret), llb.SecretAsEnv(true), llb.SecretAsEnvName(secret)))
}

if len(cmd.Caches) > 0 {
cacheOpts, err := g.getCacheMountOptions(cmd.Caches)
if err != nil {
return state, err
}
opts = append(opts, cacheOpts...)
// If there is a secrets hash, add a mount to invalidate the cache if the secrets hash changes
if g.SecretsHash != "" {
opts = append(opts, llb.AddMount("/cache-invalidate",
llb.Scratch().File(llb.Mkfile("secrets-hash", 0644, []byte(g.SecretsHash)))))
}
}

s := state.Run(opts...).Root()
return s, nil

case plan.PathCommand:
node.appendPath(cmd.Path)
pathList := node.getPathList()
pathString := strings.Join(pathList, ":")

s := state.AddEnvf("PATH", "%s:%s", pathString, system.DefaultPathEnvUnix)
if len(cmd.Caches) > 0 {
cacheOpts, err := g.getCacheMountOptions(cmd.Caches)
if err != nil {
return state, err
}
opts = append(opts, cacheOpts...)
}

return s, nil
s := state.Run(opts...).Root()
return s, nil
}

case plan.VariableCommand:
s := state.AddEnv(cmd.Name, cmd.Value)
node.OutputEnv.AddEnvVar(cmd.Name, cmd.Value)
func (g *BuildGraph) convertPathCommandToLLB(node *StepNode, cmd plan.PathCommand, state llb.State) (llb.State, error) {
node.appendPath(cmd.Path)
pathList := node.getPathList()
pathString := strings.Join(pathList, ":")

return s, nil
s := state.AddEnvf("PATH", "%s:%s", pathString, system.DefaultPathEnvUnix)
return s, nil
}

case plan.CopyCommand:
src := llb.Local("context")
if cmd.Image != "" {
src = llb.Image(cmd.Image, llb.Platform(*g.Platform))
}
func (g *BuildGraph) convertVariableCommandToLLB(node *StepNode, cmd plan.VariableCommand, state llb.State) (llb.State, error) {
s := state.AddEnv(cmd.Name, cmd.Value)
node.OutputEnv.AddEnvVar(cmd.Name, cmd.Value)
return s, nil
}

s := state.File(llb.Copy(src, cmd.Src, cmd.Dest, &llb.CopyInfo{
CreateDestPath: true,
FollowSymlinks: true,
CopyDirContentsOnly: false,
AllowWildcard: false,
}))
func (g *BuildGraph) convertCopyCommandToLLB(cmd plan.CopyCommand, state llb.State) (llb.State, error) {
src := llb.Local("context")
if cmd.Image != "" {
src = llb.Image(cmd.Image, llb.Platform(*g.Platform))
}

return s, nil
s := state.File(llb.Copy(src, cmd.Src, cmd.Dest, &llb.CopyInfo{
CreateDestPath: true,
FollowSymlinks: true,
CopyDirContentsOnly: false,
AllowWildcard: false,
}))

case plan.FileCommand:
asset, ok := step.Assets[cmd.Name]
if !ok {
return state, fmt.Errorf("asset %q not found", cmd.Name)
}
return s, nil
}

// Create parent directories for the file
parentDir := filepath.Dir(cmd.Path)
if parentDir != "/" {
s := state.File(llb.Mkdir(parentDir, 0755, llb.WithParents(true)))
state = s
}
func (g *BuildGraph) convertFileCommandToLLB(cmd plan.FileCommand, state llb.State, step *plan.Step) (llb.State, error) {
asset, ok := step.Assets[cmd.Name]
if !ok {
return state, fmt.Errorf("asset %q not found", cmd.Name)
}

var mode os.FileMode = 0644
if cmd.Mode != 0 {
mode = cmd.Mode
}
// Create parent directories for the file
parentDir := filepath.Dir(cmd.Path)
if parentDir != "/" {
s := state.File(llb.Mkdir(parentDir, 0755, llb.WithParents(true)))
state = s
}

fileAction := llb.Mkfile(cmd.Path, mode, []byte(asset))
s := state.File(fileAction)
if cmd.CustomName != "" {
s = state.File(fileAction, llb.WithCustomName(cmd.CustomName))
}
var mode os.FileMode = 0644
if cmd.Mode != 0 {
mode = cmd.Mode
}

return s, nil
fileAction := llb.Mkfile(cmd.Path, mode, []byte(asset))
s := state.File(fileAction)
if cmd.CustomName != "" {
s = state.File(fileAction, llb.WithCustomName(cmd.CustomName))
}

return state, nil
return s, nil
}

// getCacheMountOptions returns the llb.RunOption slice for the given cache keys
Expand Down

0 comments on commit c36ab92

Please sign in to comment.