Skip to content

allow duration based filters on diskusage requests #5455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crazy-max merged 1 commit into from
May 19, 2025
Merged

allow duration based filters on diskusage requests #5455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
874 changes: 442 additions & 432 deletions api/services/control/control.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions api/services/control/control.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ message PruneRequest {

message DiskUsageRequest {
repeated string filter = 1;
int64 ageLimit = 2;
Copy link
Copy Markdown
Member Author

@tonistiigi tonistiigi Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Struggled to find a good name for this. In Prune it is called KeepDuration but that name does not make sense at all for DiskUsage.

In buildx this is --filter until=<duration> that is detected on client side and converted to another field. buildx du will likely keep the same name there.

Copy link
Copy Markdown
Member

@jedevc jedevc Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ageLimit SGTM - but if we change this, would it also make sense to change the name in the prune request? We're already making changes to these structs in the next release because of the new storage fields.

Copy link
Copy Markdown
Member Author

@tonistiigi tonistiigi Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if prune had ageLimit is it obvious which way it works? Eg. is it pruning the things that are newer than ageLimit or older? Correct is older but I don't know if it is obvious.

Copy link
Copy Markdown
Member

@crazy-max crazy-max Nov 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I second this, ageLimit is fine for disk usage request. WDYT @dvdksn?

Copy link
Copy Markdown
Collaborator

@dvdksn dvdksn Nov 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively maxAge, we use maxUsedSpace in GC policy.

Copy link
Copy Markdown
Member

@jedevc jedevc Nov 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maxAge is nice, it works well in both places 🎉

Copy link
Copy Markdown
Member Author

@tonistiigi tonistiigi Nov 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If anything, I think this is minAge

}

message DiskUsageResponse {
Expand Down
31 changes: 31 additions & 0 deletions api/services/control/control_vtproto.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 9 additions & 2 deletions cache/manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1452,6 +1452,7 @@ func (cm *cacheManager) DiskUsage(ctx context.Context, opt client.DiskUsageInfo)
if err := cm.markShared(m); err != nil {
return nil, err
}
cutOff := time.Now().Add(-opt.AgeLimit)

var du []*client.UsageInfo
for id, cr := range m {
Expand All @@ -1468,9 +1469,15 @@ func (cm *cacheManager) DiskUsage(ctx context.Context, opt client.DiskUsageInfo)
RecordType: cr.recordType,
Shared: cr.shared,
}
if filter.Match(adaptUsageInfo(c)) {
du = append(du, c)
if !filter.Match(adaptUsageInfo(c)) {
continue
}
if opt.AgeLimit > 0 {
if c.LastUsedAt != nil && c.LastUsedAt.After(cutOff) {
continue
}
}
du = append(du, c)
}

eg, ctx := errgroup.WithContext(ctx)
Expand Down
17 changes: 15 additions & 2 deletions client/diskusage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func (c *Client) DiskUsage(ctx context.Context, opts ...DiskUsageOption) ([]*Usa
o.SetDiskUsageOption(info)
}

req := &controlapi.DiskUsageRequest{Filter: info.Filter}
req := &controlapi.DiskUsageRequest{Filter: info.Filter, AgeLimit: int64(info.AgeLimit)}
resp, err := c.ControlClient().DiskUsage(ctx, req)
if err != nil {
return nil, errors.Wrap(err, "failed to call diskusage")
Expand Down Expand Up @@ -72,7 +72,8 @@ type DiskUsageOption interface {
}

type DiskUsageInfo struct {
Filter []string
Filter []string
AgeLimit time.Duration
}

type UsageRecordType string
Expand All @@ -85,3 +86,15 @@ const (
UsageRecordTypeCacheMount UsageRecordType = "exec.cachemount"
UsageRecordTypeRegular UsageRecordType = "regular"
)

type diskUsageOptionFunc func(*DiskUsageInfo)

func (f diskUsageOptionFunc) SetDiskUsageOption(info *DiskUsageInfo) {
f(info)
}

func WithAgeLimit(age time.Duration) DiskUsageOption {
return diskUsageOptionFunc(func(info *DiskUsageInfo) {
info.AgeLimit = age
})
}
3 changes: 2 additions & 1 deletion control/control.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,8 @@ func (c *Controller) DiskUsage(ctx context.Context, r *controlapi.DiskUsageReque
}
for _, w := range workers {
du, err := w.DiskUsage(ctx, client.DiskUsageInfo{
Filter: r.Filter,
Filter: r.Filter,
AgeLimit: time.Duration(r.AgeLimit),
})
if err != nil {
return nil, err
Expand Down