Alignment; wait_any, wait all, fixups

Author: dakka

README.md

@@ -32,7 +32,7 @@ Currently only `Linux/x86_64` is supported. Other platforms to be supported in t
 - header-only
 - `std::thread` like interface
 - no external dependencies
-- easy to use, lightweight
+- simplicity, lightweight
 - make use of C++20 features
 - constexpr where possible
 
@@ -64,8 +64,8 @@ Currently only `Linux/x86_64` is supported. Other platforms to be supported in t
 
 # Examples
 ## 1. A simple resumable function
-In the following example each iteration of `main` and `func` simply yields, printing the iteration count.
-Note to pass a reference to the fiber we need to use the `std::ref` wrapper. Before exiting `func` calls the built-in printer.
+In the following example each iteration of `main` and `func` simply yields, printing the iteration count before and after each yield.
+Note to pass a reference to the `flags` variable we need to use the `std::ref` wrapper. Before exiting `func` calls the built-in printer.
 When `func` exits, control returns to `main` where testing `f0` for non-zero returns false indicating the fiber has finished.
 
 Note that you can name a fiber using `fiber_params`, and using designated initialisers (here we use `.name`).

examples/fibertest.cpp

@@ -118,12 +118,13 @@ int main(void)
 		std::cout << "main: " << std::dec << ii << '\n';
 		//fibers::print(std::cout);
 	}
-	std::cout << "Exiting from main\nSizes\n";
+	std::cout << "Exiting from main\n";
+	std::cout << fibers::size_finished() << " fibers finished\n";
 	std::cout << "fiber: " << sizeof(fiber) << '\n';
 	std::cout << "fiber::cvars: " << sizeof(fiber::cvars) << '\n';
 	std::cout << "fiber::all_cvars: " << sizeof(fiber::all_cvars) << '\n';
 	std::cout << "fiber_id: " << sizeof(fiber_id) << '\n';
 	std::cout << "fiber_base: " << sizeof(fiber_base) << '\n';
-	std::cout <<"fiber_params: " << sizeof(fiber_params) << '\n';
+	std::cout << "fiber_params: " << sizeof(fiber_params) << '\n';
 	return 0;
 }

examples/fibertest26.cpp

@@ -73,6 +73,7 @@ class Reader : public fiber
 	}
 
 	// non-blocking resumable reader
+	// message: [header:12-16][' '][body:80-102][' '][trailer:10]
 	void read_nb(int rdcnt)
 	{
 		int mread{};

examples/fibertest28.cpp

@@ -0,0 +1,73 @@
+//-----------------------------------------------------------------------------------------
+// fiber (header only)
+// Copyright (C) 2022-23 Fix8 Market Technologies Pty Ltd
+//   by David L. Dight
+// see https://github.com/fix8mt/fiber
+//
+// Lightweight header-only stackful per-thread fiber
+//		with built-in roundrobin scheduler x86_64 / linux only
+//
+// Distributed under the Boost Software License, Version 1.0 August 17th, 2003
+//
+// Permission is hereby granted, free of charge, to any person or organization
+// obtaining a copy of the software and accompanying documentation covered by
+// this license (the "Software") to use, reproduce, display, distribute,
+// execute, and transmit the Software, and to prepare derivative works of the
+// Software, and to permit third-parties to whom the Software is furnished to
+// do so, all subject to the following:
+//
+// The copyright notices in the Software and this entire statement, including
+// the above license grant, this restriction and the following disclaimer,
+// must be included in all copies of the Software, in whole or in part, and
+// all derivative works of the Software, unless such copies or derivative
+// works are solely in the form of machine-executable object code generated by
+// a source language processor.
+//
+// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//-----------------------------------------------------------------------------------------
+#include <iostream>
+#include <iomanip>
+#include <thread>
+#include <string>
+#include <fix8/fiber.hpp>
+
+using namespace FIX8;
+
+struct tell
+{
+	tell() { std::cout << this_fiber::name() << ":entry (fiber id:" << this_fiber::get_id() << ")\n"; }
+	~tell() { std::cout << this_fiber::name() << ":exit\n"; }
+
+	static void wrap_yield(int val)
+	{
+		std::cout << this_fiber::name() << ": " << val << '\n';
+		this_fiber::yield();
+		std::cout << this_fiber::name() << ": " << val << " (resumed)\n";
+	}
+};
+
+int main(int argc, char *argv[])
+{
+	tell wrp;
+   bool flag{};
+
+   std::cout << "flag=" << std::boolalpha << flag << '\n';
+   fiber f0({.name="\tfunc"}, [](bool& flag, int cnt)
+	{
+		tell wrp1;
+		fibers::print();
+		for (int kk{}; kk < cnt; tell::wrap_yield(kk++));
+		flag = true;
+	}, std::ref(flag), 5);
+	for (int ii{}; f0; tell::wrap_yield(ii++))
+		;
+   std::cout << "flag=" << std::boolalpha << flag << '\n';
+   return 0;
+}
+

examples/fibertest29.cpp

@@ -0,0 +1,65 @@
+//-----------------------------------------------------------------------------------------
+// fiber (header only)
+// Copyright (C) 2022-23 Fix8 Market Technologies Pty Ltd
+//   by David L. Dight
+// see https://github.com/fix8mt/fiber
+//
+// Lightweight header-only stackful per-thread fiber
+//		with built-in roundrobin scheduler x86_64 / linux only
+//
+// Distributed under the Boost Software License, Version 1.0 August 17th, 2003
+//
+// Permission is hereby granted, free of charge, to any person or organization
+// obtaining a copy of the software and accompanying documentation covered by
+// this license (the "Software") to use, reproduce, display, distribute,
+// execute, and transmit the Software, and to prepare derivative works of the
+// Software, and to permit third-parties to whom the Software is furnished to
+// do so, all subject to the following:
+//
+// The copyright notices in the Software and this entire statement, including
+// the above license grant, this restriction and the following disclaimer,
+// must be included in all copies of the Software, in whole or in part, and
+// all derivative works of the Software, unless such copies or derivative
+// works are solely in the form of machine-executable object code generated by
+// a source language processor.
+//
+// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//-----------------------------------------------------------------------------------------
+#include <iostream>
+#include <iomanip>
+#include <thread>
+#include <string>
+#include <fix8/fiber.hpp>
+
+using namespace FIX8;
+using namespace std::literals;
+
+void func (int loops)
+{
+	std::cout << this_fiber::name() << ":entry (fiber id:" << this_fiber::get_id() << ")\n";
+	for (int ii{}; ii < loops; ++ii)
+	{
+		std::cout << this_fiber::name() << ": " << ii << '\n';
+		this_fiber::yield();
+		std::this_thread::sleep_for(100ms);
+	}
+	this_fiber::schedule_main();
+	std::cout << this_fiber::name() << ": exit\n";
+}
+
+int main(int argc, char *argv[])
+{
+   fiber f0({.name="func0"}, func, 5), f1({.name="func1"}, func, 10), f2({.name="func2"}, func, 15);
+	argc > 1 ? fibers::wait_all() : fibers::wait_any();
+	fibers::print();
+	std::cout << fibers::size_finished() << " fibers finished, " << fibers::size() << " remaining\n";
+	std::cout << fibers::kill_all() << " killed\n";
+   return 0;
+}
+

examples/montest1.cpp

@@ -85,7 +85,8 @@ class foo
 //-----------------------------------------------------------------------------------------
 int main(int argc, char *argv[])
 {
-	int interval{100}, fcnt{-1}, sleepval{50};
+	constexpr int sleep_default{50}, interval_default{100};
+	int interval{interval_default}, fcnt{-1}, sleepval{sleep_default}, val;
 	bool lorder{true}, skip{true};
 	fiber_monitor::sort_mode sm{ fiber_monitor::sort_mode::by_ms };
 
@@ -98,45 +99,33 @@ int main(int argc, char *argv[])
       { "fibers",		1, 0, 'f' },	{ "mode",		1, 0, 'm' }
    }};
 
-	for (int opt; (opt = getopt_long (argc, argv, optstr, long_options.data(), 0)) != -1;)
+	while ((val = getopt_long (argc, argv, optstr, long_options.data(), 0)) != -1)
 #else
-	for (int opt; (opt = getopt (argc, argv, optstr)) != -1;)
+	while ((val = getopt (argc, argv, optstr)) != -1)
 #endif
 	{
 		try
 		{
-			switch (opt)
+			switch (val)
 			{
-			case 'f':
-				fcnt = std::stoi(optarg);
-				break;
-			case 's':
-				sleepval = std::stoi(optarg);
-				break;
 			case 'm':
 				if (long unsigned ism{ std::stoul(optarg) - 1UL }; ism < static_cast<long unsigned>(fiber_monitor::sort_mode::count))
 					sm = fiber_monitor::sort_mode(ism);
 				break;
-			case 'r':
-				fibers::set_flag(global_fiber_flags::retain);
-				break;
-			case 'k':
-				skip = false;
-				break;
-			case 'o':
-				lorder = false;
-				break;
-			case 'i':
-				interval = std::stoi(optarg);
-				break;
+			case 'f': fcnt = std::stoi(optarg); break;
+			case 's': sleepval = std::stoi(optarg); break;
+			case 'r': fibers::set_flag(global_fiber_flags::retain); break;
+			case 'k': skip ^= true; break;
+			case 'o': lorder ^= true; break;
+			case 'i': interval = std::stoi(optarg); break;
 			case '?':
 			case ':':
 			case 'h':
 				std::cout << "Usage: " << argv[0] << " -[" << optstr << R"(]
-  -i,--interval interval msecs (default 100)
+  -i,--interval interval msecs (default )" << interval << R"()
   -f,--fibers fiber count (default )" << (fiber_monitor::get_terminal_dimensions().second - 4) << R"()
-  -s,--sleep sleep msecs (default 50)
-  -m,--mode sort mode )" << fiber_monitor::sort_help() << R"((default 3)
+  -s,--sleep sleep msecs (default )" << sleepval << R"()
+  -m,--mode sort mode )" << fiber_monitor::sort_help() << "(default " << (static_cast<long unsigned>(sm) + 1) << R"()
   -o,--order no launch order
   -k,--noskip no skip main
   -r,--interval retain finished fibers
@@ -166,16 +155,13 @@ int main(int argc, char *argv[])
 			&foo::func, &bar, 2 * (ii + 1)))->set_params("sub"s + std::to_string(ii));
 	}
 
-	while (fibers::has_fibers())
+	fibers::wait_all([&fm]()
 	{
-		this_fiber::yield();
 		if (!fm)
-		{
 			fibers::kill_all();
-			break;
-		}
-	}
+		return !fm;
+	});
 	fm.update();
-	std::this_thread::sleep_for(1s);
+	std::this_thread::sleep_for(2s);
 	return 0;
 }