ircd::ctx: Move ctx headers into directory.

charybdis/charybdis.cc

@@ -21,7 +21,7 @@
 
 #include <ircd/ircd.h>
 #include <boost/asio.hpp>
-#include <ircd/ctx_ctx.h>
+#include <ircd/ctx/ctx.h>
 #include "lgetopt.h"
 
 namespace path = ircd::path;

include/ircd/ctx.h

@@ -25,7 +25,23 @@
 #pragma once
 #define HAVE_IRCD_CTX_H
 
-#ifdef __cplusplus
+//
+// This is the public interface to the userspace context system. No 3rd party
+// symbols are included from here. This file is included automatically in stdinc.h
+// and you do not have to include it manually.
+//
+// There are two primary objects at work in the context system:
+//
+// `struct context` <ircd/ctx/context.h>
+// Public interface emulating std::thread; included automatically from here.
+// To spawn and manipulate contexts, deal with this object.
+//
+// `struct ctx` <ircd/ctx/ctx.h>
+// Internal implementation of the context and state holder. This is not included here.
+// Several low-level functions are exposed for library creators. This file is usually
+// included when boost/asio.hpp is also included and calls are actually made into boost.
+//
+
 namespace ircd {
 namespace ctx  {
 
@@ -80,71 +96,55 @@ void sleep_until(const time_point &tp);
 template<class duration> void sleep(const duration &);
 void sleep(const int &secs);
 
-class context
-{
-	std::unique_ptr<ctx> c;
+} // namespace ctx
 
-  public:
-	bool operator!() const                       { return !c;                                      }
-	operator bool() const                        { return bool(c);                                 }
+using ctx::timeout;
 
-	operator const ctx &() const                 { return *c;                                      }
-	operator ctx &()                             { return *c;                                      }
+} // namespace ircd
 
-	bool joined() const                          { return !c || ircd::ctx::finished(*c);           }
-	void interrupt()                             { ircd::ctx::interrupt(*c);                       }
-	void join();                                 // Blocks the current context until this one finishes
-	ctx *detach();                               // other calls undefined after this call
-
-	// Note: Constructing with SELF_DESTRUCT flag makes any further use of this object undefined.
-	context(const size_t &stack_size, std::function<void ()>, const enum flags &flags = (enum flags)0);
-	context(std::function<void ()>, const enum flags &flags = (enum flags)0);
-	context(context &&) noexcept = default;
-	context(const context &) = delete;
-	~context() noexcept;
-
-	friend void swap(context &a, context &b) noexcept;
-};
+#include "ctx/context.h"
+#include "ctx/prof.h"
+#include "ctx/dock.h"
+#include "ctx/mutex.h"
+#include "ctx/shared_state.h"
+#include "ctx/promise.h"
+#include "ctx/future.h"
+#include "ctx/async.h"
+#include "ctx/pool.h"
+#include "ctx/ole.h"
 
 inline void
-swap(context &a, context &b)
-noexcept
-{
-	std::swap(a.c, b.c);
-}
-
-inline void
-sleep(const int &secs)
+ircd::ctx::sleep(const int &secs)
 {
 	sleep(seconds(secs));
 }
 
 template<class duration>
 void
-sleep(const duration &d)
+ircd::ctx::sleep(const duration &d)
 {
 	sleep_until(steady_clock::now() + d);
 }
 
 template<class E>
-throw_overload<E>
-wait_until(const time_point &tp)
+ircd::throw_overload<E>
+ircd::ctx::wait_until(const time_point &tp)
 {
 	if(wait_until<std::nothrow_t>(tp))
 		throw E();
 }
 
 template<class E>
-nothrow_overload<E, bool>
-wait_until(const time_point &tp)
+ircd::nothrow_overload<E, bool>
+ircd::ctx::wait_until(const time_point &tp)
 {
 	return wait_until(tp, std::nothrow);
 }
 
 template<class E,
          class duration>
-throw_overload<E, duration>
-wait(const duration &d)
+ircd::throw_overload<E, duration>
+ircd::ctx::wait(const duration &d)
 {
 	const auto ret(wait<std::nothrow_t>(d));
 	return ret <= duration(0)? throw E() : ret;
@@ -152,8 +152,8 @@ wait(const duration &d)
 
 template<class E,
          class duration>
-nothrow_overload<E, duration>
-wait(const duration &d)
+ircd::nothrow_overload<E, duration>
+ircd::ctx::wait(const duration &d)
 {
 	using std::chrono::duration_cast;
 
@@ -161,17 +161,9 @@ wait(const duration &d)
 	return duration_cast<duration>(ret);
 }
 
-inline ctx &
-cur()
+inline ircd::ctx::ctx &
+ircd::ctx::cur()
 {
 	assert(current);
 	return *current;
 }
-
-}      // namespace ctx
-
-using ctx::context;
-using ctx::timeout;
-
-}      // namespace ircd
-#endif // __cplusplus

include/ircd/ctx/context.h

@@ -0,0 +1,68 @@
+/*
+ * charybdis: oh just a little chat server
+ * ctx.h: userland context switching (stackful coroutines)
+ *
+ * Copyright (C) 2016 Charybdis Development Team
+ * Copyright (C) 2016 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+#define HAVE_IRCD_CTX_CONTEXT_H
+
+namespace ircd {
+namespace ctx  {
+
+class context
+{
+	std::unique_ptr<ctx> c;
+
+  public:
+	bool operator!() const                       { return !c;                                      }
+	operator bool() const                        { return bool(c);                                 }
+
+	operator const ctx &() const                 { return *c;                                      }
+	operator ctx &()                             { return *c;                                      }
+
+	bool joined() const                          { return !c || ircd::ctx::finished(*c);           }
+	void interrupt()                             { ircd::ctx::interrupt(*c);                       }
+	void join();                                 // Blocks the current context until this one finishes
+	ctx *detach();                               // other calls undefined after this call
+
+	// Note: Constructing with SELF_DESTRUCT flag makes any further use of this object undefined.
+	context(const size_t &stack_size, std::function<void ()>, const enum flags &flags = (enum flags)0);
+	context(std::function<void ()>, const enum flags &flags = (enum flags)0);
+	context(context &&) noexcept = default;
+	context(const context &) = delete;
+	~context() noexcept;
+
+	friend void swap(context &a, context &b) noexcept;
+};
+
+inline void
+swap(context &a, context &b)
+noexcept
+{
+	std::swap(a.c, b.c);
+}
+
+} // namespace ctx
+
+using ctx::context;
+
+} // namespace ircd

include/ircd/sock.h

@@ -26,7 +26,7 @@
 #include <boost/asio.hpp>
 #include <boost/asio/steady_timer.hpp>
 #include "bufs.h"
-#include "ctx_ctx.h"
+#include "ctx/ctx.h"
 
 namespace ircd {
 

include/ircd/stdinc.h

@@ -91,15 +91,6 @@ namespace ircd
 #include "mode_lease.h"
 #include "snomask.h"
 #include "ctx.h"
-#include "ctx_prof.h"
-#include "ctx_dock.h"
-#include "ctx_mutex.h"
-#include "ctx_shared_state.h"
-#include "ctx_promise.h"
-#include "ctx_future.h"
-#include "ctx_async.h"
-#include "ctx_pool.h"
-#include "ctx_ole.h"
 #include "hook.h"
 #include "line.h"
 #include "tape.h"

ircd/ctx.cc

@@ -19,7 +19,7 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#include <ircd/ctx_ctx.h>
+#include <ircd/ctx/ctx.h>
 
 using namespace ircd;
 

ircd/ircd.cc

@@ -24,7 +24,7 @@
  */
 
 #include <boost/asio.hpp>
-#include <ircd/ctx_ctx.h>
+#include <ircd/ctx/ctx.h>
 #include <ircd/js.h>
 
 namespace ircd

modules/conf/listen.cc

@@ -20,7 +20,7 @@
  */
 
 #include <boost/asio.hpp>
-#include <ircd/ctx_ctx.h>
+#include <ircd/ctx/ctx.h>
 #include <ircd/lex_cast.h>
 #include <ircd/sock.h>
 

modules/m_host.cc

@@ -20,7 +20,7 @@
  */
 
 #include <boost/asio.hpp>
-#include <ircd/ctx_ctx.h>
+#include <ircd/ctx/ctx.h>
 
 namespace ip = boost::asio::ip;
 using namespace ircd;