basic_types.hpp

Go to the documentation of this file.

/*
 * Author: Sven Gothel <sgothel@jausoft.com>
 * Copyright (c) 2020-2024 Gothel Software e.K.
 *
 * 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.
 */
 
#ifndef JAU_BASIC_TYPES_HPP_
#define JAU_BASIC_TYPES_HPP_
 
#include <cstring>
#include <string>
#include <memory>
#include <cstdint>
#include <vector>
#include <type_traits>
#include <iostream>
 
#include <jau/cpp_lang_util.hpp>
#include <jau/packed_attribute.hpp>
#include <jau/type_traits_queries.hpp>
 
#include <jau/int_types.hpp>
#include <jau/int_math.hpp>
 
#include <jau/byte_util.hpp>
#include <jau/string_util.hpp>
 
#include <jau/ordered_atomic.hpp>
#include <jau/fraction_type.hpp>
 
namespace jau {
 
    /**
     * \ingroup Fractions
     *
     * Returns current monotonic time since Unix Epoch `00:00:00 UTC on 1970-01-01`.
     *
     * Returned fraction_timespec is passing machine precision and range of the underlying API.
     *
     * See fraction_timespec::to_fraction_i64() of how to measure duration in high range and precision:
     * <pre>
     *   fraction_timespec t0 = getMonotonicTime();
     *   // do something
     *
     *   // Exact duration
     *   fraction_timespec td_1 = getMonotonicTime() - t0;
     *
     *   // or for durations <= 292 years
     *   fraction_i64 td_2 = (getMonotonicTime() - t0).to_fraction_i64();
     * </pre>
     *
     * This is in stark contract to counting nanoseconds in int64_t which only lasts until `2262-04-12`,
     * since INT64_MAX is 9'223'372'036'854'775'807 for 9'223'372'036 seconds or 292 years.
     *
     * Monotonic time shall be used for high-performance measurements of durations,
     * since the underlying OS shall support fast calls.
     *
     * @see fraction_timespec
     * @see fraction_timespec::to_fraction_i64()
     * @see getWallClockTime()
     */
    fraction_timespec getMonotonicTime() noexcept;
 
    /**
     * \ingroup Fractions
     *
     * Returns current wall-clock real-time since Unix Epoch `00:00:00 UTC on 1970-01-01`.
     *
     * Returned fraction_timespec is passing machine precision and range of the underlying API.
     *
     * Wall-Clock time shall be used for accurate measurements of the actual time only,
     * since the underlying OS unlikely supports fast calls.
     *
     * @see fraction_timespec
     * @see fraction_timespec::to_fraction_i64()
     * @see getMonotonicTime()
     */
    fraction_timespec getWallClockTime() noexcept;
 
    /**
     * Returns current monotonic time in milliseconds.
     */
    uint64_t getCurrentMilliseconds() noexcept;
 
    /**
     * Returns current wall-clock system `time of day` in seconds since Unix Epoch
     * `00:00:00 UTC on 1 January 1970`.
     */
    uint64_t getWallClockSeconds() noexcept;
 
    /**
     * millisecond sleep using high precision monotonic timer,
     * useful for one-shot delays (only).
     *
     * Consider using jau::sleep_until or jau::sleep_for 
     * utilizing absolute target time sleep when waiting 
     * for an event, overcoming clock re-adjustments.
     * 
     * @param td_ms duration to sleep in milliseconds
     * @param ignore_irq continue sleep when interrupted by a signal if true, defaults to true
     * @return true if completed waiting, otherwise false for interruption or error
     */
    bool milli_sleep(uint64_t td_ms, const bool ignore_irq=true) noexcept;
        
    /**
     * sleep using high precision monotonic timer,
     * useful for one-shot delays (only).
     *
     * Consider using jau::sleep_until or jau::sleep_for 
     * utilizing absolute target time sleep when waiting 
     * for an event, overcoming clock re-adjustments.
     *
     * @param relative_time an object of type fraction_timespec representing the time to sleep
     * @param ignore_irq continue sleep when interrupted by a signal if true, defaults to true
     * @return true if completed waiting, otherwise false for interruption or error
     */
    bool sleep(const fraction_timespec& relative_time, const bool ignore_irq=true) noexcept;
    
    /**
     * sleep_until causes the current thread to block until the  specific time is reached.
     *
     * Method works similar to std::this_thread::sleep_until(), but utilizes fraction_timespec instead of `int64_t nanoseconds counter`
     * for maintaining high-precision and infinite range.
     *
     * Implementation also uses ::clock_nanosleep(), with absolute time and either
     * monotonic- or wall-clok time depending on given monotonic flag.
     * This instead of ::nanosleep() with undefined clock-type and interruptions.
     *
     * @param absolute_time an object of type fraction_timespec representing the time when to stop waiting
     * @param monotonic if true, implementation uses the fast and steady monotonic clock (default), otherwise the wall-clock
     * @param ignore_irq continue sleep when interrupted by a signal if true, defaults to true
     * @return true if completed waiting, otherwise false for interruption or error
     * @see sleep_until()
     * @see sleep_for()
     * @see wait_until()
     * @see wait_for()
     */
    bool sleep_until(const fraction_timespec& absolute_time, const bool monotonic=true, const bool ignore_irq=true) noexcept;
 
    /**
     * sleep_for causes the current thread to block until a specific amount of time has passed.
     *
     * Implementation calls sleep_until() passing absolute time derived via getMonotonicTime() or getWallClockTime(), see:
     * <pre>
     *   fraction_timespec absolute_time = ( monotonic ? getMonotonicTime() : getWallClockTime() ) + relative_time;
     * </pre>
     *
     * Method works similar to std::this_thread::sleep_until(), but utilizes fraction_timespec instead of `int64_t nanoseconds counter`
     * for maintaining high-precision and infinite range.
     *
     * @param relative_time an object of type fraction_timespec representing the the maximum time to spend waiting
     * @param monotonic if true, implementation uses the fast and steady monotonic clock (default), otherwise the wall-clock
     * @param ignore_irq continue sleep when interrupted by a signal if true, defaults to true
     * @return true if completed waiting, otherwise false for interruption or error
     * @see sleep_until()
     * @see sleep_for()
     * @see wait_until()
     * @see wait_for()
     */
    bool sleep_for(const fraction_timespec& relative_time, const bool monotonic=true, const bool ignore_irq=true) noexcept;
 
    /**
     * sleep_for causes the current thread to block until a specific amount of time has passed.
     *
     * Implementation calls sleep_until() passing absolute time derived via getMonotonicTime() or getWallClockTime(), see:
     * <pre>
     *   fraction_timespec absolute_time = ( monotonic ? getMonotonicTime() : getWallClockTime() ) + relative_time;
     * </pre>
     *
     * Method works similar to std::this_thread::sleep_until(), but utilizes fraction_timespec instead of `int64_t nanoseconds counter`
     * for maintaining high-precision and infinite range.
     *
     * @param relative_time an object of type fraction_i64 representing the the maximum time to spend waiting, which is limited to 292 years if using nanoseconds fractions.
     * @param monotonic if true, implementation uses the fast and steady monotonic clock (default), otherwise the wall-clock
     * @param ignore_irq continue sleep when interrupted by a signal if true, defaults to true
     * @return true if completed waiting, otherwise false for interruption or error
     * @see sleep_until()
     * @see sleep_for()
     * @see wait_until()
     * @see wait_for()
     */
    bool sleep_for(const fraction_i64& relative_time, const bool monotonic=true, const bool ignore_irq=true) noexcept;
 
    /**
     * wait_until causes the current thread to block until the condition variable is notified, a specific time is reached, or a spurious wakeup occurs.
     *
     * Method works similar to std::condition_variable::wait_until(), but utilizes fraction_timespec instead of `int64_t nanoseconds counter`
     * for maintaining high-precision and infinite range.
     *
     * @param cv std::condition_variable instance
     * @param lock an object of type std::unique_lock<std::mutex>, which must be locked by the current thread
     * @param absolute_time an object of type fraction_timespec representing the time when to stop waiting
     * @param monotonic if true, implementation uses the fast and steady monotonic clock (default), otherwise the wall-clock
     * @return std::cv_status::timeout if the relative timeout specified by rel_time expired, std::cv_status::no_timeout otherwise.
     * @see sleep_until()
     * @see sleep_for()
     * @see wait_until()
     * @see wait_for()
     */
    std::cv_status wait_until(std::condition_variable& cv, std::unique_lock<std::mutex>& lock, const fraction_timespec& absolute_time, 
                              const bool monotonic=true) noexcept;
 
    /**
     * wait_for causes the current thread to block until the condition variable is notified, a specific amount of time has passed, or a spurious wakeup occurs.
     *
     * Implementation calls wait_until() passing absolute time derived via getMonotonicTime() or getWallClockTime(), see:
     * <pre>
     *   fraction_timespec absolute_time = ( monotonic ? getMonotonicTime() : getWallClockTime() ) + relative_time;
     * </pre>
     *
     * Method works similar to std::condition_variable::wait_for(), but utilizes fraction_timespec instead of `int64_t nanoseconds counter`
     * for maintaining high-precision and infinite range.
     *
     * When using a condition predicate loop to ensure no spurious wake-up preemptively ends waiting for the condition variable event or timeout,
     * it is always recommended to use wait_until() using the absolute timeout time computed once before said loop. Example from latch::wait_for():
     * <pre>
            std::unique_lock<std::mutex> lock(mtx_cd);
            const fraction_timespec timeout_time = getMonotonicTime() + timeout_duration;
            while( 0 < count ) {
                std::cv_status s = wait_until(cv, lock, timeout_time);
                if( 0 == count ) {
                    return true;
                }
                if( std::cv_status::timeout == s ) {
                    return false;
                }
            }
     * </pre>
     * @param cv std::condition_variable instance
     * @param lock an object of type std::unique_lock<std::mutex>, which must be locked by the current thread
     * @param relative_time an object of type fraction_timespec representing the the maximum time to spend waiting
     * @param monotonic if true, implementation uses the fast and steady monotonic clock (default), otherwise the wall-clock
     * @return std::cv_status::timeout if the relative timeout specified by rel_time expired, std::cv_status::no_timeout otherwise.
     * @see sleep_until()
     * @see sleep_for()
     * @see wait_until()
     * @see wait_for()
     */
    std::cv_status wait_for(std::condition_variable& cv, std::unique_lock<std::mutex>& lock, const fraction_timespec& relative_time, 
                            const bool monotonic=true) noexcept;
 
    /**
     * wait_for causes the current thread to block until the condition variable is notified, a specific amount of time has passed, or a spurious wakeup occurs.
     *
     * Implementation calls wait_until() passing absolute time derived via getMonotonicTime() or getWallClockTime(), see:
     * <pre>
     *   fraction_timespec absolute_time = ( monotonic ? getMonotonicTime() : getWallClockTime() ) + relative_time;
     * </pre>
     *
     * Method works similar to std::condition_variable::wait_for(), but utilizes fraction_timespec instead of `int64_t nanoseconds counter`
     * for maintaining high-precision and infinite range.
     *
     * When using a condition predicate loop to ensure no spurious wake-up preemptively ends waiting for the condition variable event or timeout,
     * it is always recommended to use wait_until() using the absolute timeout time computed once before said loop. Example from latch::wait_for():
     * <pre>
            std::unique_lock<std::mutex> lock(mtx_cd);
            const fraction_timespec timeout_time = getMonotonicTime() + timeout_duration;
            while( 0 < count ) {
                std::cv_status s = wait_until(cv, lock, timeout_time);
                if( 0 == count ) {
                    return true;
                }
                if( std::cv_status::timeout == s ) {
                    return false;
                }
            }
     * </pre>
     * @param cv std::condition_variable instance
     * @param lock an object of type std::unique_lock<std::mutex>, which must be locked by the current thread
     * @param relative_time an object of type fraction_i64 representing the the maximum time to spend waiting, which is limited to 292 years if using nanoseconds fractions.
     * @param monotonic if true, implementation uses the fast and steady monotonic clock (default), otherwise the wall-clock
     * @return std::cv_status::timeout if the relative timeout specified by rel_time expired, std::cv_status::no_timeout otherwise.
     * @see sleep_until()
     * @see sleep_for()
     * @see wait_until()
     * @see wait_for()
     */
    std::cv_status wait_for(std::condition_variable& cv, std::unique_lock<std::mutex>& lock, const fraction_i64& relative_time, 
                            const bool monotonic=true) noexcept;
 
    /**
    // *************************************************
    // *************************************************
    // *************************************************
     */
 
    #define E_FILE_LINE __FILE__,__LINE__
 
    class ExceptionBase {
      private:
        std::string msg_;
        std::string backtrace_;
        std::string what_;
 
      protected:
        ExceptionBase(std::string type, std::string const& m, const char* file, int line) noexcept;
 
      public:
        virtual ~ExceptionBase() noexcept = default;
 
        ExceptionBase(const ExceptionBase &o) = default;
        ExceptionBase(ExceptionBase &&o) = default;
        ExceptionBase& operator=(const ExceptionBase &o) = default;
        ExceptionBase& operator=(ExceptionBase &&o) = default;
 
        const std::string& message() const noexcept { return msg_; }
        const std::string& backtrace() const noexcept { return backtrace_; }
 
        /** Allow conversion to `const std::string&`, as required by Catch2's `REQUIRE_THROWS_MATCHES` */
        operator const std::string&  () const noexcept { return message(); };
 
        virtual const char* what() const noexcept {
            return what_.c_str(); // return std::runtime_error::what();
        }
 
        std::ostream& operator<<(std::ostream& out) noexcept {
            return out << what_;
        }
    };
 
    class OutOfMemoryError : public std::bad_alloc, public ExceptionBase {
      public:
        OutOfMemoryError(std::string const& m, const char* file, int line)
        : bad_alloc(), ExceptionBase("OutOfMemoryError", m, file, line) {}
 
        const char* what() const noexcept override {
            return ExceptionBase::what(); // return std::runtime_error::what();
        }
    };
 
    class RuntimeException : public std::exception, public ExceptionBase {
      protected:
        RuntimeException(std::string type, std::string const& m, const char* file, int line) noexcept
        : exception(), ExceptionBase(std::move(type), m, file, line) {}
 
      public:
        RuntimeException(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("RuntimeException", m, file, line) {}
 
        ~RuntimeException() noexcept override = default;
 
        RuntimeException(const RuntimeException& o) = default;
        RuntimeException(RuntimeException&& o) = default;
        RuntimeException& operator=(const RuntimeException& o) = default;
        RuntimeException& operator=(RuntimeException&& o) = default;
 
        const char* what() const noexcept override {
            return ExceptionBase::what();
        }
    };
 
    class InternalError : public RuntimeException {
      public:
        InternalError(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("InternalError", m, file, line) {}
    };
 
    class NotImplementedError : public RuntimeException {
      public:
        NotImplementedError(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("NotImplementedError", m, file, line) {}
    };
 
    class NullPointerException : public RuntimeException {
      public:
        NullPointerException(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("NullPointerException", m, file, line) {}
    };
 
    class IllegalArgumentException : public RuntimeException {
      public:
        IllegalArgumentException(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("IllegalArgumentException", m, file, line) {}
    };
 
    class IllegalStateException : public RuntimeException {
      public:
        IllegalStateException(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("IllegalStateException", m, file, line) {}
    };
 
    class UnsupportedOperationException : public RuntimeException {
      public:
        UnsupportedOperationException(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("UnsupportedOperationException", m, file, line) {}
    };
 
    class IndexOutOfBoundsException : public RuntimeException {
      public:
        IndexOutOfBoundsException(const std::size_t index, const std::size_t length, const char* file, int line) noexcept
        : RuntimeException("IndexOutOfBoundsException", "Index "+std::to_string(index)+", data length "+std::to_string(length), file, line) {}
 
        IndexOutOfBoundsException(const std::string& index_s, const std::string& length_s, const char* file, int line) noexcept
        : RuntimeException("IndexOutOfBoundsException", "Index "+index_s+", data length "+length_s, file, line) {}
 
        IndexOutOfBoundsException(const std::size_t index, const std::size_t count, const std::size_t length, const char* file, int line) noexcept
        : RuntimeException("IndexOutOfBoundsException", "Index "+std::to_string(index)+", count "+std::to_string(count)+", data length "+std::to_string(length), file, line) {}
    };
 
    class IOError : public RuntimeException {
      public:
        IOError(std::string const& m, const char* file, int line) noexcept
        : RuntimeException("IOError", m, file, line) {}
    };
 
 
    /**
    // *************************************************
    // *************************************************
    // *************************************************
     */
 
    /** \addtogroup Integer
     *
     *  @{
     */
 
    inline void set_bit_uint32(const uint8_t nr, uint32_t &mask)
    {
        using namespace jau::int_literals;
        if( nr > 31 ) { throw IndexOutOfBoundsException(nr, 32, E_FILE_LINE); }
        mask |= 1_u32 << (nr & 31);
    }
 
    inline void clear_bit_uint32(const uint8_t nr, uint32_t &mask)
    {
        using namespace jau::int_literals;
        if( nr > 31 ) { throw IndexOutOfBoundsException(nr, 32, E_FILE_LINE); }
        mask |= ~(1_u32 << (nr & 31));
    }
 
    inline uint32_t test_bit_uint32(const uint8_t nr, const uint32_t mask)
    {
        using namespace jau::int_literals;
        if( nr > 31 ) { throw IndexOutOfBoundsException(nr, 32, E_FILE_LINE); }
        return mask & (1_u32 << (nr & 31));
    }
 
    inline void set_bit_uint64(const uint8_t nr, uint64_t &mask)
    {
        using namespace jau::int_literals;
        if( nr > 63 ) { throw IndexOutOfBoundsException(nr, 64, E_FILE_LINE); }
        mask |= 1_u64 << (nr & 63);
    }
 
    inline void clear_bit_uint64(const uint8_t nr, uint64_t &mask)
    {
        using namespace jau::int_literals;
        if( nr > 63 ) { throw IndexOutOfBoundsException(nr, 64, E_FILE_LINE); }
        mask |= ~(1_u64 << (nr & 63));
    }
 
    inline uint64_t test_bit_uint64(const uint8_t nr, const uint64_t mask)
    {
        using namespace jau::int_literals;
        if( nr > 63 ) { throw IndexOutOfBoundsException(nr, 64, E_FILE_LINE); }
        return mask & (1_u64 << (nr & 63));
    }
 
    /**
    // *************************************************
    // *************************************************
    // *************************************************
     */
 
    /**
     * Merge the given 'uuid16' into a 'base_uuid' copy at the given little endian 'uuid16_le_octet_index' position.
     * <p>
     * The given 'uuid16' value will be added with the 'base_uuid' copy at the given position.
     * </p>
     * <pre>
     * base_uuid: 00000000-0000-1000-8000-00805F9B34FB
     *    uuid16: DCBA
     * uuid16_le_octet_index: 12
     *    result: 0000DCBA-0000-1000-8000-00805F9B34FB
     *
     * LE: low-mem - FB349B5F8000-0080-0010-0000-ABCD0000 - high-mem
     *                                           ^ index 12
     * LE: uuid16 -> value.data[12+13]
     *
     * BE: low-mem - 0000DCBA-0000-1000-8000-00805F9B34FB - high-mem
     *                   ^ index 2
     * BE: uuid16 -> value.data[2+3]
     * </pre>
     */
    uint128dp_t merge_uint128(uint16_t const uuid16, uint128dp_t const & base_uuid, nsize_t const uuid16_le_octet_index);
 
    /**
     * Merge the given 'uuid32' into a 'base_uuid' copy at the given little endian 'uuid32_le_octet_index' position.
     * <p>
     * The given 'uuid32' value will be added with the 'base_uuid' copy at the given position.
     * </p>
     * <pre>
     * base_uuid: 00000000-0000-1000-8000-00805F9B34FB
     *    uuid32: 87654321
     * uuid32_le_octet_index: 12
     *    result: 87654321-0000-1000-8000-00805F9B34FB
     *
     * LE: low-mem - FB349B5F8000-0080-0010-0000-12345678 - high-mem
     *                                           ^ index 12
     * LE: uuid32 -> value.data[12..15]
     *
     * BE: low-mem - 87654321-0000-1000-8000-00805F9B34FB - high-mem
     *               ^ index 0
     * BE: uuid32 -> value.data[0..3]
     * </pre>
     */
    uint128dp_t merge_uint128(uint32_t const uuid32, uint128dp_t const & base_uuid, nsize_t const uuid32_le_octet_index);
 
    /**@}*/
 
} // namespace jau
 
/** \example test_intdecstring01.cpp
 * This C++ unit test validates the jau::to_decstring implementation
 */
 
#endif /* JAU_BASIC_TYPES_HPP_ */