mirror of
https://github.com/matrix-construct/construct
synced 2024-09-28 03:38:53 +02:00
ircd::ctx: Split sleep()/wait() suites into headers.
This commit is contained in:
parent
92b7ae5c17
commit
a6131d1268
4 changed files with 141 additions and 96 deletions
|
@ -79,6 +79,8 @@ namespace ircd::ctx
|
||||||
|
|
||||||
#include "prof.h"
|
#include "prof.h"
|
||||||
#include "this_ctx.h"
|
#include "this_ctx.h"
|
||||||
|
#include "wait.h"
|
||||||
|
#include "sleep.h"
|
||||||
#include "stack_usage_assertion.h"
|
#include "stack_usage_assertion.h"
|
||||||
#include "slice_usage_warning.h"
|
#include "slice_usage_warning.h"
|
||||||
#include "syscall_usage_warning.h"
|
#include "syscall_usage_warning.h"
|
||||||
|
|
39
include/ircd/ctx/sleep.h
Normal file
39
include/ircd/ctx/sleep.h
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
// The Construct
|
||||||
|
//
|
||||||
|
// Copyright (C) The Construct Developers, Authors & Contributors
|
||||||
|
// Copyright (C) 2016-2020 Jason Volk <jason@zemos.net>
|
||||||
|
//
|
||||||
|
// Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
// purpose with or without fee is hereby granted, provided that the above
|
||||||
|
// copyright notice and this permission notice is present in all copies. The
|
||||||
|
// full license for this software is available in the LICENSE file.
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
#define HAVE_IRCD_CTX_SLEEP_H
|
||||||
|
|
||||||
|
namespace ircd::ctx { inline namespace this_ctx
|
||||||
|
{
|
||||||
|
// Ignores notes. Throws if interrupted.
|
||||||
|
void sleep_until(const system_point &tp);
|
||||||
|
template<class duration> void sleep(const duration &);
|
||||||
|
void sleep(const int &secs);
|
||||||
|
}}
|
||||||
|
|
||||||
|
/// This overload matches ::sleep() and acts as a drop-in for ircd contexts.
|
||||||
|
/// interruption point.
|
||||||
|
inline void
|
||||||
|
ircd::ctx::this_ctx::sleep(const int &secs)
|
||||||
|
{
|
||||||
|
sleep(seconds(secs));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Yield the context for a period of time and ignore notifications. sleep()
|
||||||
|
/// is like wait() but it only returns after the timeout and not because of a
|
||||||
|
/// note.
|
||||||
|
/// interruption point.
|
||||||
|
template<class duration>
|
||||||
|
void
|
||||||
|
ircd::ctx::this_ctx::sleep(const duration &d)
|
||||||
|
{
|
||||||
|
sleep_until(system_clock::now() + d);
|
||||||
|
}
|
|
@ -12,33 +12,15 @@
|
||||||
#define HAVE_IRCD_CTX_THIS_CTX_H
|
#define HAVE_IRCD_CTX_THIS_CTX_H
|
||||||
|
|
||||||
/// Interface to the currently running context
|
/// Interface to the currently running context
|
||||||
namespace ircd::ctx {
|
namespace ircd::ctx { inline namespace this_ctx
|
||||||
inline namespace this_ctx
|
|
||||||
{
|
{
|
||||||
struct ctx &cur() noexcept; ///< Assumptional reference to *current
|
struct ctx &cur() noexcept; ///< Assumptional reference to *current
|
||||||
const uint64_t &id() noexcept; // Unique ID for cur ctx
|
const uint64_t &id() noexcept; // Unique ID for cur ctx
|
||||||
string_view name() noexcept; // Optional label for cur ctx
|
string_view name() noexcept; // Optional label for cur ctx
|
||||||
ulong cycles() noexcept; // misc profiling related
|
ulong cycles() noexcept; // misc profiling related
|
||||||
bool interruption_requested() noexcept; // interruption(cur())
|
bool interruption_requested() noexcept; // interruption(cur())
|
||||||
|
|
||||||
void interruption_point(); // throws if interruption_requested()
|
void interruption_point(); // throws if interruption_requested()
|
||||||
void wait(); // Returns when context is woken up.
|
|
||||||
void yield(); // Allow other contexts to run before returning.
|
void yield(); // Allow other contexts to run before returning.
|
||||||
|
|
||||||
// Return remaining time if notified; or <= 0 if not, and timeout thrown on throw overloads
|
|
||||||
microseconds wait(const microseconds &, const std::nothrow_t &);
|
|
||||||
template<class E, class duration> nothrow_overload<E, duration> wait(const duration &);
|
|
||||||
template<class E = timeout, class duration> throw_overload<E, duration> wait(const duration &);
|
|
||||||
|
|
||||||
// Returns false if notified; true if time point reached, timeout thrown on throw_overloads
|
|
||||||
bool wait_until(const system_point &tp, const std::nothrow_t &);
|
|
||||||
template<class E> nothrow_overload<E, bool> wait_until(const system_point &tp);
|
|
||||||
template<class E = timeout> throw_overload<E> wait_until(const system_point &tp);
|
|
||||||
|
|
||||||
// Ignores notes. Throws if interrupted.
|
|
||||||
void sleep_until(const system_point &tp);
|
|
||||||
template<class duration> void sleep(const duration &);
|
|
||||||
void sleep(const int &secs);
|
|
||||||
}}
|
}}
|
||||||
|
|
||||||
namespace ircd::ctx
|
namespace ircd::ctx
|
||||||
|
@ -52,83 +34,6 @@ namespace ircd
|
||||||
namespace this_ctx = ctx::this_ctx;
|
namespace this_ctx = ctx::this_ctx;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This overload matches ::sleep() and acts as a drop-in for ircd contexts.
|
|
||||||
/// interruption point.
|
|
||||||
inline void
|
|
||||||
ircd::ctx::this_ctx::sleep(const int &secs)
|
|
||||||
{
|
|
||||||
sleep(seconds(secs));
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Yield the context for a period of time and ignore notifications. sleep()
|
|
||||||
/// is like wait() but it only returns after the timeout and not because of a
|
|
||||||
/// note.
|
|
||||||
/// interruption point.
|
|
||||||
template<class duration>
|
|
||||||
void
|
|
||||||
ircd::ctx::this_ctx::sleep(const duration &d)
|
|
||||||
{
|
|
||||||
sleep_until(system_clock::now() + d);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Wait for a notification until a point in time. If there is a notification
|
|
||||||
/// then context continues normally. If there's never a notification then an
|
|
||||||
/// exception (= timeout) is thrown.
|
|
||||||
/// interruption point.
|
|
||||||
template<class E>
|
|
||||||
ircd::throw_overload<E>
|
|
||||||
ircd::ctx::this_ctx::wait_until(const system_point &tp)
|
|
||||||
{
|
|
||||||
if(wait_until<std::nothrow_t>(tp))
|
|
||||||
throw E{};
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Wait for a notification until a point in time. If there is a notification
|
|
||||||
/// then returns true. If there's never a notification then returns false.
|
|
||||||
/// interruption point. this is not noexcept.
|
|
||||||
template<class E>
|
|
||||||
ircd::nothrow_overload<E, bool>
|
|
||||||
ircd::ctx::this_ctx::wait_until(const system_point &tp)
|
|
||||||
{
|
|
||||||
return wait_until(tp, std::nothrow);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Wait for a notification for at most some amount of time. If the duration is
|
|
||||||
/// reached without a notification then E (= timeout) is thrown. Otherwise,
|
|
||||||
/// returns the time remaining on the duration.
|
|
||||||
/// interruption point
|
|
||||||
template<class E,
|
|
||||||
class duration>
|
|
||||||
ircd::throw_overload<E, duration>
|
|
||||||
ircd::ctx::this_ctx::wait(const duration &d)
|
|
||||||
{
|
|
||||||
const auto ret
|
|
||||||
{
|
|
||||||
wait<std::nothrow_t>(d)
|
|
||||||
};
|
|
||||||
|
|
||||||
return ret <= duration(0)?
|
|
||||||
throw E{}:
|
|
||||||
ret;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Wait for a notification for some amount of time. This function returns
|
|
||||||
/// when a context is notified. It always returns the duration remaining which
|
|
||||||
/// will be <= 0 to indicate a timeout without notification.
|
|
||||||
/// interruption point. this is not noexcept.
|
|
||||||
template<class E,
|
|
||||||
class duration>
|
|
||||||
ircd::nothrow_overload<E, duration>
|
|
||||||
ircd::ctx::this_ctx::wait(const duration &d)
|
|
||||||
{
|
|
||||||
const auto ret
|
|
||||||
{
|
|
||||||
wait(duration_cast<microseconds>(d), std::nothrow)
|
|
||||||
};
|
|
||||||
|
|
||||||
return duration_cast<duration>(ret);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// View the name of the currently running context, or "*" if no context is
|
/// View the name of the currently running context, or "*" if no context is
|
||||||
/// currently running.
|
/// currently running.
|
||||||
inline ircd::string_view
|
inline ircd::string_view
|
||||||
|
|
99
include/ircd/ctx/wait.h
Normal file
99
include/ircd/ctx/wait.h
Normal file
|
@ -0,0 +1,99 @@
|
||||||
|
// The Construct
|
||||||
|
//
|
||||||
|
// Copyright (C) The Construct Developers, Authors & Contributors
|
||||||
|
// Copyright (C) 2016-2020 Jason Volk <jason@zemos.net>
|
||||||
|
//
|
||||||
|
// Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
// purpose with or without fee is hereby granted, provided that the above
|
||||||
|
// copyright notice and this permission notice is present in all copies. The
|
||||||
|
// full license for this software is available in the LICENSE file.
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
#define HAVE_IRCD_CTX_WAIT_H
|
||||||
|
|
||||||
|
namespace ircd::ctx { inline namespace this_ctx
|
||||||
|
{
|
||||||
|
// Returns when context is woken up.
|
||||||
|
void wait();
|
||||||
|
|
||||||
|
// Return remaining time if notified; or <= 0 if not, and timeout thrown on throw overloads
|
||||||
|
microseconds wait(const microseconds &, const std::nothrow_t &);
|
||||||
|
|
||||||
|
template<class E,
|
||||||
|
class duration>
|
||||||
|
nothrow_overload<E, duration> wait(const duration &);
|
||||||
|
|
||||||
|
// timeout thrown if time point reached
|
||||||
|
template<class E = timeout,
|
||||||
|
class duration>
|
||||||
|
throw_overload<E, duration> wait(const duration &);
|
||||||
|
|
||||||
|
// Returns false if notified; true if time point reached
|
||||||
|
bool wait_until(const system_point &tp, const std::nothrow_t &);
|
||||||
|
|
||||||
|
// Returns false if notified; true if time point reached
|
||||||
|
template<class E>
|
||||||
|
nothrow_overload<E, bool> wait_until(const system_point &tp);
|
||||||
|
|
||||||
|
// timeout thrown if time point reached
|
||||||
|
template<class E = timeout>
|
||||||
|
throw_overload<E> wait_until(const system_point &tp);
|
||||||
|
}}
|
||||||
|
|
||||||
|
/// Wait for a notification until a point in time. If there is a notification
|
||||||
|
/// then context continues normally. If there's never a notification then an
|
||||||
|
/// exception (= timeout) is thrown.
|
||||||
|
/// interruption point.
|
||||||
|
template<class E>
|
||||||
|
ircd::throw_overload<E>
|
||||||
|
ircd::ctx::this_ctx::wait_until(const system_point &tp)
|
||||||
|
{
|
||||||
|
if(wait_until<std::nothrow_t>(tp))
|
||||||
|
throw E{};
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Wait for a notification until a point in time. If there is a notification
|
||||||
|
/// then returns true. If there's never a notification then returns false.
|
||||||
|
/// interruption point. this is not noexcept.
|
||||||
|
template<class E>
|
||||||
|
ircd::nothrow_overload<E, bool>
|
||||||
|
ircd::ctx::this_ctx::wait_until(const system_point &tp)
|
||||||
|
{
|
||||||
|
return wait_until(tp, std::nothrow);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Wait for a notification for at most some amount of time. If the duration is
|
||||||
|
/// reached without a notification then E (= timeout) is thrown. Otherwise,
|
||||||
|
/// returns the time remaining on the duration.
|
||||||
|
/// interruption point
|
||||||
|
template<class E,
|
||||||
|
class duration>
|
||||||
|
ircd::throw_overload<E, duration>
|
||||||
|
ircd::ctx::this_ctx::wait(const duration &d)
|
||||||
|
{
|
||||||
|
const auto ret
|
||||||
|
{
|
||||||
|
wait<std::nothrow_t>(d)
|
||||||
|
};
|
||||||
|
|
||||||
|
return ret <= duration(0)?
|
||||||
|
throw E{}:
|
||||||
|
ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Wait for a notification for some amount of time. This function returns
|
||||||
|
/// when a context is notified. It always returns the duration remaining which
|
||||||
|
/// will be <= 0 to indicate a timeout without notification.
|
||||||
|
/// interruption point. this is not noexcept.
|
||||||
|
template<class E,
|
||||||
|
class duration>
|
||||||
|
ircd::nothrow_overload<E, duration>
|
||||||
|
ircd::ctx::this_ctx::wait(const duration &d)
|
||||||
|
{
|
||||||
|
const auto ret
|
||||||
|
{
|
||||||
|
wait(duration_cast<microseconds>(d), std::nothrow)
|
||||||
|
};
|
||||||
|
|
||||||
|
return duration_cast<duration>(ret);
|
||||||
|
}
|
Loading…
Reference in a new issue