~james/core

core/spindle/engine/scheduler.go -rw-r--r-- 4.5 KiB
452f17b7 — james chore(import): snapshot james.dad.town/core at f70c71c7696a 16 hours ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
package engine

import (
	"context"
	"fmt"
	"slices"
	"sync"
	"time"
)

const defaultAgingThreshold = 30 * time.Second

type Resources[Self any] interface {
	Fits(Self) bool
	Add(Self) Self
	Sub(Self) Self
}

type ResourceScheduler[R Resources[R]] struct {
	mu             sync.Mutex
	budget         R
	max            R
	used           R
	queue          []*resourceWaiter[R]
	now            func() time.Time // get time now, is a field for mocking
	agingThreshold time.Duration

	OnAcquire  func(req R, allowed bool, reason string)
	OnSnapshot func(budget, max, used R, queueLen int)
}

type resourceWaiter[R Resources[R]] struct {
	req        R
	ready      chan struct{}
	enqueuedAt time.Time
}

type resourceLease[R Resources[R]] struct {
	scheduler *ResourceScheduler[R]
	req       R
	once      sync.Once
}

func NewResourceScheduler[R Resources[R]](budget, max R, agingThreshold time.Duration) *ResourceScheduler[R] {
	if agingThreshold <= 0 {
		agingThreshold = defaultAgingThreshold
	}
	return &ResourceScheduler[R]{
		budget:         budget,
		max:            max,
		now:            time.Now,
		agingThreshold: agingThreshold,
	}
}

// the mill owns the backlog so a NoWait caller must have room immediately or fail
func (s *ResourceScheduler[R]) Acquire(ctx context.Context, req R, mode AcquireMode) (WorkflowSlot, error) {
	if s == nil {
		return NoopSlot{}, nil
	}

	s.mu.Lock()
	if !req.Fits(s.budget) || !req.Fits(s.max) {
		s.mu.Unlock()
		if s.OnAcquire != nil {
			reason := "request_exceeds_budget"
			if !req.Fits(s.max) {
				reason = "request_exceeds_max"
			}
			s.OnAcquire(req, false, reason)
		}
		return nil, fmt.Errorf("%w: request=%v budget=%v max=%v", ErrNoWorkflowSlots, req, s.budget, s.max)
	}
	// ignores the queue because it never blocks
	// only bypasses empty queues to prevent starvation
	if s.used.Add(req).Fits(s.budget) && (mode == NoWait || len(s.queue) == 0) {
		s.used = s.used.Add(req)
		if s.OnAcquire != nil {
			s.OnAcquire(req, true, "allowed_immediately")
		}
		if s.OnSnapshot != nil {
			s.OnSnapshot(s.budget, s.max, s.used, len(s.queue))
		}
		s.mu.Unlock()
		return &resourceLease[R]{scheduler: s, req: req}, nil
	}
	if mode == NoWait {
		used := s.used
		s.mu.Unlock()
		if s.OnAcquire != nil {
			s.OnAcquire(req, false, "no_wait_slot_unavailable")
		}
		return nil, fmt.Errorf("%w: request=%v used=%v budget=%v", ErrNoWorkflowSlots, req, used, s.budget)
	}

	waiter := &resourceWaiter[R]{req: req, ready: make(chan struct{}), enqueuedAt: s.now()}
	s.queue = append(s.queue, waiter)
	if s.OnSnapshot != nil {
		s.OnSnapshot(s.budget, s.max, s.used, len(s.queue))
	}
	s.schedule()
	s.mu.Unlock()

	select {
	case <-waiter.ready:
		if s.OnAcquire != nil {
			s.OnAcquire(req, true, "allowed_from_queue")
		}
		return &resourceLease[R]{scheduler: s, req: req}, nil
	case <-ctx.Done():
		s.mu.Lock()
		select {
		case <-waiter.ready:
			// undo committed resources, schedule already did that
			s.used = s.used.Sub(req)
			if s.OnAcquire != nil {
				s.OnAcquire(req, false, "context_done_after_ready")
			}
		default:
			// still in queue, just remove
			s.remove(waiter)
			if s.OnAcquire != nil {
				s.OnAcquire(req, false, "context_done_in_queue")
			}
		}
		s.schedule()
		if s.OnSnapshot != nil {
			s.OnSnapshot(s.budget, s.max, s.used, len(s.queue))
		}
		s.mu.Unlock()
		return nil, ctx.Err()
	}
}

func (l *resourceLease[R]) Release() {
	if l == nil || l.scheduler == nil {
		return
	}
	l.once.Do(func() {
		l.scheduler.release(l.req)
	})
}

func (s *ResourceScheduler[R]) release(req R) {
	s.mu.Lock()
	defer s.mu.Unlock()
	s.used = s.used.Sub(req)
	s.schedule()
	if s.OnSnapshot != nil {
		s.OnSnapshot(s.budget, s.max, s.used, len(s.queue))
	}
}

// start every waiter whose request fits. once a waiter is older than
// agingThreshold, count its request as already used so younger waiters
// stop being scheduled ahead of it
func (s *ResourceScheduler[R]) schedule() {
	var reserved R
	now := s.now()
	i := 0
	changed := false
	for i < len(s.queue) {
		w := s.queue[i]
		if s.used.Add(reserved).Add(w.req).Fits(s.budget) {
			s.queue = slices.Delete(s.queue, i, i+1)
			s.used = s.used.Add(w.req)
			close(w.ready)
			changed = true
			continue
		}
		if now.Sub(w.enqueuedAt) >= s.agingThreshold {
			reserved = reserved.Add(w.req)
		}
		i++
	}
	if changed && s.OnSnapshot != nil {
		s.OnSnapshot(s.budget, s.max, s.used, len(s.queue))
	}
}

func (s *ResourceScheduler[R]) remove(waiter *resourceWaiter[R]) {
	if i := slices.Index(s.queue, waiter); i >= 0 {
		s.queue = slices.Delete(s.queue, i, i+1)
	}
}