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
|
/*
* Copyright (c) 2022 AtLarge Research
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.opendc.common.util
import kotlinx.coroutines.Delay
import kotlinx.coroutines.DisposableHandle
import kotlinx.coroutines.InternalCoroutinesApi
import java.lang.Runnable
import java.time.InstantSource
import kotlin.coroutines.ContinuationInterceptor
import kotlin.coroutines.CoroutineContext
/**
* Helper class to pace the incoming scheduling requests.
*
* @param context The [CoroutineContext] in which the pacer runs.
* @param clock The virtual simulation clock.
* @param quantum The scheduling quantum.
* @param process The process to invoke for the incoming requests.
*/
public class Pacer(
private val context: CoroutineContext,
private val clock: InstantSource,
private val quantum: Long,
private val process: (Long) -> Unit
) {
/**
* The [Delay] instance that provides scheduled execution of [Runnable]s.
*/
@OptIn(InternalCoroutinesApi::class)
private val delay =
requireNotNull(context[ContinuationInterceptor] as? Delay) { "Invalid CoroutineDispatcher: no delay implementation" }
/**
* The current [DisposableHandle] representing the pending scheduling cycle.
*/
private var handle: DisposableHandle? = null
/**
* Determine whether a scheduling cycle is pending.
*/
public val isPending: Boolean get() = handle != null
/**
* Enqueue a new scheduling cycle.
*/
public fun enqueue() {
if (handle != null) {
return
}
val quantum = quantum
val now = clock.millis()
// We assume that the scheduler runs at a fixed slot every time quantum (e.g t=0, t=60, t=120).
// We calculate here the delay until the next scheduling slot.
val timeUntilNextSlot = quantum - (now % quantum)
@OptIn(InternalCoroutinesApi::class)
handle = delay.invokeOnTimeout(timeUntilNextSlot, {
process(now + timeUntilNextSlot)
handle = null
}, context)
}
/**
* Cancel the currently pending scheduling cycle.
*/
public fun cancel() {
val handle = handle ?: return
this.handle = null
handle.dispose()
}
}
|
