github.com/metacubex/gvisor@v0.0.0-20240320004321-933faba989ec/pkg/sentry/time/clocks.go (about)

     1  // Copyright 2018 The gVisor Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package time
    16  
    17  // Clocks represents a clock source that contains both a monotonic and realtime
    18  // clock.
    19  type Clocks interface {
    20  	// Update performs an update step, keeping the clocks in sync with the
    21  	// reference host clocks, and returning the new timekeeping parameters.
    22  	//
    23  	// Update should be called at approximately ApproxUpdateInterval.
    24  	Update() (monotonicParams Parameters, monotonicOk bool, realtimeParam Parameters, realtimeOk bool)
    25  
    26  	// GetTime returns the current time in nanoseconds for the given clock.
    27  	//
    28  	// Clocks implementations must support at least Monotonic and
    29  	// Realtime.
    30  	GetTime(c ClockID) (int64, error)
    31  }