urbackup_backend/external/aws-cpp-sdk/include/aws/common/clock.h
2021-07-07 18:47:38 +02:00

66 lines
2.3 KiB
C
Executable File

#ifndef AWS_COMMON_CLOCK_H
#define AWS_COMMON_CLOCK_H
/*
* Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
#include <aws/common/common.h>
#include <aws/common/math.h>
enum aws_timestamp_unit {
AWS_TIMESTAMP_SECS = 1,
AWS_TIMESTAMP_MILLIS = 1000,
AWS_TIMESTAMP_MICROS = 1000000,
AWS_TIMESTAMP_NANOS = 1000000000,
};
AWS_EXTERN_C_BEGIN
/**
* Converts 'timestamp' from unit 'convert_from' to unit 'convert_to', if the units are the same then 'timestamp' is
* returned. If 'remainder' is NOT NULL, it will be set to the remainder if convert_from is a more precise unit than
* convert_to. To avoid unnecessary branching, 'remainder' is not zero initialized in this function, be sure to set it
* to 0 first if you care about that kind of thing. If conversion would lead to integer overflow, the timestamp
* returned will be the highest possible time that is representable, i.e. UINT64_MAX.
*/
AWS_STATIC_IMPL uint64_t aws_timestamp_convert(
uint64_t timestamp,
enum aws_timestamp_unit convert_from,
enum aws_timestamp_unit convert_to,
uint64_t *remainder);
/**
* Get ticks in nanoseconds (usually 100 nanosecond precision) on the high resolution clock (most-likely TSC). This
* clock has no bearing on the actual system time. On success, timestamp will be set.
*/
AWS_COMMON_API
int aws_high_res_clock_get_ticks(uint64_t *timestamp);
/**
* Get ticks in nanoseconds (usually 100 nanosecond precision) on the system clock. Reflects actual system time via
* nanoseconds since unix epoch. Use with care since an inaccurately set clock will probably cause bugs. On success,
* timestamp will be set.
*/
AWS_COMMON_API
int aws_sys_clock_get_ticks(uint64_t *timestamp);
#ifndef AWS_NO_STATIC_IMPL
# include <aws/common/clock.inl>
#endif /* AWS_NO_STATIC_IMPL */
AWS_EXTERN_C_END
#endif /* AWS_COMMON_CLOCK_H */