uringmachine 0.3 → 0.5

data/vendor/liburing/test/waitid.c

@@ -19,6 +19,39 @@ static void child(long usleep_time)
 	exit(0);
 }
 
+static int test_invalid_infop(struct io_uring *ring)
+{
+	struct io_uring_sqe *sqe;
+	struct io_uring_cqe *cqe;
+	siginfo_t *si = (siginfo_t *) (uintptr_t) 0x1234;
+	int ret, w;
+	pid_t pid;
+
+	pid = fork();
+	if (!pid) {
+		child(200000);
+		exit(0);
+	}
+
+	sqe = io_uring_get_sqe(ring);
+	io_uring_prep_waitid(sqe, P_PID, pid, si, WEXITED, 0);
+	sqe->user_data = 1;
+	io_uring_submit(ring);
+
+	ret = io_uring_wait_cqe(ring, &cqe);
+	if (ret) {
+		fprintf(stderr, "cqe wait: %d\n", ret);
+		return T_EXIT_FAIL;
+	}
+	if (cqe->res != -EFAULT) {
+		fprintf(stderr, "Bad return on invalid infop: %d\n", cqe->res);
+		return T_EXIT_FAIL;
+	}
+	io_uring_cqe_seen(ring, cqe);
+	wait(&w);
+	return T_EXIT_PASS;
+}
+
 /*
  * Test linked timeout with child not exiting in time
  */
@@ -27,9 +60,9 @@ static int test_noexit(struct io_uring *ring)
 	struct io_uring_sqe *sqe;
 	struct io_uring_cqe *cqe;
 	struct __kernel_timespec ts;
+	int ret, i, w;
 	siginfo_t si;
 	pid_t pid;
-	int ret, i;
 
 	pid = fork();
 	if (!pid) {
@@ -67,6 +100,7 @@ static int test_noexit(struct io_uring *ring)
 		io_uring_cqe_seen(ring, cqe);
 	}
 
+	wait(&w);
 	return T_EXIT_PASS;
 }
 
@@ -79,7 +113,7 @@ static int test_double(struct io_uring *ring)
 	struct io_uring_cqe *cqe;
 	siginfo_t si;
 	pid_t p1, p2;
-	int ret;
+	int ret, w;
 
 	/* p1 will exit shortly */
 	p1 = fork();
@@ -116,6 +150,7 @@ static int test_double(struct io_uring *ring)
 	}
 
 	io_uring_cqe_seen(ring, cqe);
+	wait(&w);
 	return T_EXIT_PASS;
 }
 
@@ -167,7 +202,7 @@ static int test_cancel(struct io_uring *ring)
 {
 	struct io_uring_sqe *sqe;
 	struct io_uring_cqe *cqe;
-	int ret, i;
+	int ret, i, w;
 	pid_t pid;
 
 	pid = fork();
@@ -205,6 +240,7 @@ static int test_cancel(struct io_uring *ring)
 		io_uring_cqe_seen(ring, cqe);
 	}
 
+	wait(&w);
 	return T_EXIT_PASS;
 }
 
@@ -216,10 +252,12 @@ static int test_cancel_race(struct io_uring *ring, int async)
 {
 	struct io_uring_sqe *sqe;
 	struct io_uring_cqe *cqe;
-	int ret, i;
+	int ret, i, to_wait, total_forks;
 	pid_t pid;
 
+	total_forks = 0;
 	for (i = 0; i < 10; i++) {
+		total_forks++;
 		pid = fork();
 		if (!pid) {
 			child(getpid() & 1);
@@ -243,16 +281,20 @@ static int test_cancel_race(struct io_uring *ring, int async)
 
 	io_uring_submit(ring);
 
+	to_wait = total_forks;
 	for (i = 0; i < 2; i++) {
 		ret = io_uring_wait_cqe(ring, &cqe);
 		if (ret) {
 			fprintf(stderr, "cqe wait: %d\n", ret);
 			return T_EXIT_FAIL;
 		}
-		if (cqe->user_data == 1 && !(cqe->res == -ECANCELED ||
-					     cqe->res == 0)) {
-			fprintf(stderr, "cqe1 res: %d\n", cqe->res);
-			return T_EXIT_FAIL;
+		if (cqe->user_data == 1) {
+			if (!cqe->res)
+				to_wait--;
+			if (!(cqe->res == -ECANCELED || cqe->res == 0)) {
+				fprintf(stderr, "cqe1 res: %d\n", cqe->res);
+				return T_EXIT_FAIL;
+			}
 		}
 		if (cqe->user_data == 2 &&
 		    !(cqe->res == 1 || cqe->res == 0 || cqe->res == -ENOENT ||
@@ -263,6 +305,12 @@ static int test_cancel_race(struct io_uring *ring, int async)
 		io_uring_cqe_seen(ring, cqe);
 	}
 
+	for (i = 0; i < to_wait; i++) {
+		int w;
+
+		wait(&w);
+	}
+
 	return T_EXIT_PASS;
 }
 
@@ -360,6 +408,12 @@ int main(int argc, char *argv[])
 		return T_EXIT_FAIL;
 	}
 
+	ret = test_invalid_infop(&ring);
+	if (ret == T_EXIT_FAIL) {
+		fprintf(stderr, "test_invalid_infop failed\n");
+		return T_EXIT_FAIL;
+	}
+
 	for (i = 0; i < 1000; i++) {
 		ret = test_cancel_race(&ring, i & 1);
 		if (ret == T_EXIT_FAIL) {

data/vendor/liburing/test/wq-aff.c

@@ -127,6 +127,33 @@ static int test(int sqpoll)
 	return ret;
 }
 
+static int test_invalid_cpu(void)
+{
+	struct io_uring_params p = { };
+	struct io_uring ring;
+	int ret, nr_cpus;
+
+	nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
+	if (nr_cpus < 0) {
+		perror("sysconf(_SC_NPROCESSORS_ONLN");
+		return T_EXIT_SKIP;
+	}
+
+	p.flags = IORING_SETUP_SQPOLL | IORING_SETUP_SQ_AFF;
+	p.sq_thread_cpu = 16 * nr_cpus;
+
+	ret = io_uring_queue_init_params(8, &ring, &p);
+	if (ret == -EPERM) {
+		return T_EXIT_SKIP;
+	} else if (ret != -EINVAL) {
+		fprintf(stderr, "Queue init: %d\n", ret);
+		return T_EXIT_FAIL;
+	}
+
+	io_uring_queue_exit(&ring);
+	return T_EXIT_PASS;
+}
+
 int main(int argc, char *argv[])
 {
 	int ret;
@@ -134,6 +161,14 @@ int main(int argc, char *argv[])
 	if (argc > 1)
 		return T_EXIT_SKIP;
 
+	ret = test_invalid_cpu();
+	if (ret == T_EXIT_SKIP) {
+		return T_EXIT_SKIP;
+	} else if (ret != T_EXIT_PASS) {
+		fprintf(stderr, "test sqpoll cpu failed\n");
+		return T_EXIT_FAIL;
+	}
+
 	ret = test(1);
 	if (ret == T_EXIT_SKIP) {
 		return T_EXIT_SKIP;

data/vendor/liburing/test/xfail_prep_link_timeout_out_of_scope.c

@@ -0,0 +1,46 @@
+/* SPDX-License-Identifier: MIT */
+/*
+ * Description: Check to see if the asan checks catch an stack-use-after-free for prep_link_timeout
+ */
+
+#include <stdio.h>
+#include <errno.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+#include <assert.h>
+#include "liburing.h"
+#include "helpers.h"
+
+#include <stdio.h>
+
+int main(int argc, char *argv[])
+{
+	struct io_uring ring;
+	struct io_uring_sqe *sqe;
+	int ret;
+
+	if (argc > 1)
+		return T_EXIT_SKIP;
+
+	ret = io_uring_queue_init(8, &ring, 0);
+	if (ret < 0) {
+		printf("io_uring_queue_init ret %i\n", ret);
+		return T_EXIT_PASS; // this test expects an inverted exit code
+	}
+
+	// force timespec to go out of scope, test "passes" if asan catches this bug.
+	{
+		struct __kernel_timespec timespec;
+		timespec.tv_sec = 0;
+		timespec.tv_nsec = 5000;
+
+		sqe = io_uring_get_sqe(&ring);
+		io_uring_prep_timeout(sqe, &timespec, 0, 0);
+		io_uring_sqe_set_data(sqe, (void *) 1);
+	}
+
+	ret = io_uring_submit_and_wait(&ring, 1);
+	printf("submit_and_wait %i\n", ret);
+
+	return T_EXIT_PASS; // this test expects an inverted exit code
+}

data/vendor/liburing/test/xfail_register_buffers_out_of_scope.c

@@ -0,0 +1,51 @@
+/* SPDX-License-Identifier: MIT */
+/*
+ * Description: Check to see if the asan checks catch an stack-use-after-free for io_uring_sqe_set_data
+ */
+
+#include <stdio.h>
+#include <errno.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+#include <assert.h>
+#include <stdlib.h>
+#include "liburing.h"
+#include "helpers.h"
+
+#include <stdio.h>
+
+#define BUFFERS     8
+#define BUFFER_SIZE 128
+
+int main(int argc, char *argv[])
+{
+	struct io_uring ring;
+	struct iovec *iovs;
+	int i;
+	int ret;
+
+	if (argc > 1)
+		return T_EXIT_SKIP;
+
+	ret = io_uring_queue_init(8, &ring, 0);
+	if (ret < 0) {
+		printf("io_uring_queue_init ret %i\n", ret);
+		return T_EXIT_PASS; // this test expects an inverted exit code
+	}
+
+	iovs = calloc(BUFFERS, sizeof(struct iovec));
+	for (i = 0; i < BUFFERS; i++) {
+		iovs[i].iov_base = malloc(BUFFER_SIZE);
+		iovs[i].iov_len = BUFFER_SIZE;
+	}
+	// force one iov_base to be freed, test "passes" if asan catches this bug.
+	free(iovs[4].iov_base);
+
+	ret = io_uring_register_buffers(&ring, iovs, BUFFERS);
+	printf("io_uring_register_buffers %i\n", ret);
+
+	ret = io_uring_submit_and_wait(&ring, 1);
+	printf("submit_and_wait %i\n", ret);
+
+	return T_EXIT_PASS; // this test expects an inverted exit code
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uringmachine
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.5'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-04 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -84,21 +84,32 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- examples/bm_snooze.rb
+- examples/bm_write.rb
+- examples/dns_client.rb
 - examples/echo_server.rb
-- examples/event_loop.rb
-- examples/fibers.rb
 - examples/http_server.rb
-- examples/http_server_multishot.rb
-- examples/http_server_simpler.rb
+- examples/inout.rb
+- examples/nc.rb
+- examples/server_client.rb
+- examples/snooze.rb
+- examples/write_dev_null.rb
 - ext/um/extconf.rb
 - ext/um/um.c
 - ext/um/um.h
+- ext/um/um_buffer.c
 - ext/um/um_class.c
+- ext/um/um_const.c
 - ext/um/um_ext.c
+- ext/um/um_mutex_class.c
 - ext/um/um_op.c
+- ext/um/um_queue_class.c
+- ext/um/um_sync.c
 - ext/um/um_utils.c
 - lib/uringmachine.rb
+- lib/uringmachine/dns_resolver.rb
 - lib/uringmachine/version.rb
+- supressions/ruby.supp
 - test/helper.rb
 - test/test_um.rb
 - uringmachine.gemspec
@@ -110,6 +121,7 @@ files:
 - vendor/liburing/.gitignore
 - vendor/liburing/CHANGELOG
 - vendor/liburing/CITATION.cff
+- vendor/liburing/CONTRIBUTING.md
 - vendor/liburing/COPYING
 - vendor/liburing/COPYING.GPL
 - vendor/liburing/LICENSE
@@ -140,12 +152,14 @@ files:
 - vendor/liburing/examples/io_uring-cp.c
 - vendor/liburing/examples/io_uring-test.c
 - vendor/liburing/examples/io_uring-udp.c
+- vendor/liburing/examples/kdigest.c
 - vendor/liburing/examples/link-cp.c
 - vendor/liburing/examples/napi-busy-poll-client.c
 - vendor/liburing/examples/napi-busy-poll-server.c
 - vendor/liburing/examples/poll-bench.c
 - vendor/liburing/examples/proxy.c
 - vendor/liburing/examples/proxy.h
+- vendor/liburing/examples/reg-wait.c
 - vendor/liburing/examples/rsrc-update-bench.c
 - vendor/liburing/examples/send-zerocopy.c
 - vendor/liburing/examples/ucontext-cp.c
@@ -167,6 +181,7 @@ files:
 - vendor/liburing/src/include/liburing.h
 - vendor/liburing/src/include/liburing/barrier.h
 - vendor/liburing/src/include/liburing/io_uring.h
+- vendor/liburing/src/include/liburing/sanitize.h
 - vendor/liburing/src/int_flags.h
 - vendor/liburing/src/lib.h
 - vendor/liburing/src/liburing-ffi.map
@@ -174,6 +189,7 @@ files:
 - vendor/liburing/src/nolibc.c
 - vendor/liburing/src/queue.c
 - vendor/liburing/src/register.c
+- vendor/liburing/src/sanitize.c
 - vendor/liburing/src/setup.c
 - vendor/liburing/src/setup.h
 - vendor/liburing/src/syscall.c
@@ -202,6 +218,7 @@ files:
 - vendor/liburing/test/buf-ring.c
 - vendor/liburing/test/ce593a6c480a.c
 - vendor/liburing/test/close-opath.c
+- vendor/liburing/test/cmd-discard.c
 - vendor/liburing/test/config
 - vendor/liburing/test/connect-rep.c
 - vendor/liburing/test/connect.c
@@ -234,6 +251,8 @@ files:
 - vendor/liburing/test/fd-install.c
 - vendor/liburing/test/fd-pass.c
 - vendor/liburing/test/fdinfo.c
+- vendor/liburing/test/fifo-nonblock-read.c
+- vendor/liburing/test/file-exit-unreg.c
 - vendor/liburing/test/file-register.c
 - vendor/liburing/test/file-update.c
 - vendor/liburing/test/file-verify.c
@@ -261,11 +280,13 @@ files:
 - vendor/liburing/test/iopoll-leak.c
 - vendor/liburing/test/iopoll-overflow.c
 - vendor/liburing/test/iopoll.c
+- vendor/liburing/test/kallsyms.c
 - vendor/liburing/test/lfs-openat-write.c
 - vendor/liburing/test/lfs-openat.c
 - vendor/liburing/test/link-timeout.c
 - vendor/liburing/test/link.c
 - vendor/liburing/test/link_drain.c
+- vendor/liburing/test/linked-defer-close.c
 - vendor/liburing/test/madvise.c
 - vendor/liburing/test/min-timeout-wait.c
 - vendor/liburing/test/min-timeout.c
@@ -303,21 +324,27 @@ files:
 - vendor/liburing/test/poll-ring.c
 - vendor/liburing/test/poll-v-poll.c
 - vendor/liburing/test/poll.c
+- vendor/liburing/test/pollfree.c
 - vendor/liburing/test/probe.c
 - vendor/liburing/test/read-before-exit.c
 - vendor/liburing/test/read-mshot-empty.c
+- vendor/liburing/test/read-mshot-stdin.c
 - vendor/liburing/test/read-mshot.c
 - vendor/liburing/test/read-write.c
 - vendor/liburing/test/recv-msgall-stream.c
 - vendor/liburing/test/recv-msgall.c
 - vendor/liburing/test/recv-multishot.c
+- vendor/liburing/test/recvsend_bundle-inc.c
 - vendor/liburing/test/recvsend_bundle.c
 - vendor/liburing/test/reg-fd-only.c
 - vendor/liburing/test/reg-hint.c
 - vendor/liburing/test/reg-reg-ring.c
+- vendor/liburing/test/reg-wait.c
+- vendor/liburing/test/regbuf-clone.c
 - vendor/liburing/test/regbuf-merge.c
 - vendor/liburing/test/register-restrictions.c
 - vendor/liburing/test/rename.c
+- vendor/liburing/test/resize-rings.c
 - vendor/liburing/test/ring-leak.c
 - vendor/liburing/test/ring-leak2.c
 - vendor/liburing/test/ringbuf-read.c
@@ -354,6 +381,7 @@ files:
 - vendor/liburing/test/sqpoll-exec.c
 - vendor/liburing/test/sqpoll-exit-hang.c
 - vendor/liburing/test/sqpoll-sleep.c
+- vendor/liburing/test/sqwait.c
 - vendor/liburing/test/statx.c
 - vendor/liburing/test/stdout.c
 - vendor/liburing/test/submit-and-wait.c
@@ -369,12 +397,15 @@ files:
 - vendor/liburing/test/truncate.c
 - vendor/liburing/test/tty-write-dpoll.c
 - vendor/liburing/test/unlink.c
+- vendor/liburing/test/uring_cmd_ublk.c
 - vendor/liburing/test/version.c
 - vendor/liburing/test/wait-timeout.c
 - vendor/liburing/test/waitid.c
 - vendor/liburing/test/wakeup-hang.c
 - vendor/liburing/test/wq-aff.c
 - vendor/liburing/test/xattr.c
+- vendor/liburing/test/xfail_prep_link_timeout_out_of_scope.c
+- vendor/liburing/test/xfail_register_buffers_out_of_scope.c
 homepage: https://github.com/digital-fabric/uringmachine
 licenses:
 - MIT

data/examples/event_loop.rb

@@ -1,69 +0,0 @@
-require_relative '../lib/iou'
-require 'socket'
-
-class IOUEventLoop
-  attr_reader :ring
-
-  def initialize
-    @ring = IOU::Ring.new
-  end
-
-  def async_queue
-    @async_queue ||= []
-  end
-
-  def async(&block)
-    @async_queue << block
-    signal if @waiting
-  end
-
-  def signal
-    # generate an event to cause process_completions to return
-    ring.prep_nop
-    ring.submit
-  end
-
-  def run_async_tasks
-    pending = @async_queue
-    @async_queue = []
-    pending&.each(&:call)
-  end
-
-  def run
-    yield if block_given?
-    while !@stopped
-      run_async_tasks
-      @waiting = true
-      ring.process_completions
-      @waiting = false
-    end
-  end
-
-  def stop
-    @stopped = true
-    signal if @waiting
-  end
-
-  def timeout(delay, &block)
-    ring.prep_timeout(interval: delay, &block)
-    ring.submit
-  end
-
-  def interval(period, &block)
-    ring.prep_timeout(interval: period, multishot: true, &block)
-    ring.submit
-  end
-end
-
-# exaple usage
-event_loop = IOUEventLoop.new
-
-trap('SIGINT') { event_loop.stop }
-
-event_loop.run do
-  event_loop.interval(1) do
-    puts "The time is #{Time.now}"
-  end
-end
-
-puts "Stopped"

data/examples/fibers.rb

@@ -1,105 +0,0 @@
-require_relative '../lib/iou'
-require 'socket'
-require 'fiber'
-
-class ::Fiber
-  attr_accessor :__op_id
-end
-
-class Scheduler
-  class Cancel < Exception
-  end
-
-  attr_reader :ring
-
-  def initialize
-    @ring = IOU::Ring.new
-    @runqueue = []
-  end
-
-  def switchpoint
-    while true
-      f, v = @runqueue.shift
-      if f
-        return f.transfer(v)
-      end
-
-      @ring.process_completions
-    end
-  end
-
-  def fiber_wait(op_id)
-    Fiber.current.__op_id = op_id
-    v = switchpoint
-    Fiber.current.__op_id = nil
-    raise v if v.is_a?(Exception)
-    
-    v
-  end
-
-  def read(**args)
-    f = Fiber.current
-    id = ring.prep_read(**args) do |c|
-      if c[:result] < 0
-        @runqueue << [f, RuntimeError.new('error')]
-      else
-        @runqueue << [f, c[:buffer]]
-      end
-    end
-    fiber_wait(id)
-  end
-
-  def write(**args)
-    f = Fiber.current
-    id = ring.prep_write(**args) do |c|
-      if c[:result] < 0
-        @runqueue << [f, RuntimeError.new('error')]
-      else
-        @runqueue << [f, c[:result]]
-      end
-    end
-    fiber_wait(id)
-  end
-
-  def sleep(interval)
-    f = Fiber.current
-    id = ring.prep_timeout(interval: interval) do |c|
-      if c[:result] == Errno::ECANCELED::Errno
-        @runqueue << [f, c[:result]]
-      else
-        @runqueue << [f, c[:result]]
-      end
-    end
-    fiber_wait(id)
-  end
-
-  def cancel_fiber_op(f)
-    op_id = f.__op_id
-    if op_id
-      ring.prep_cancel(op_id)
-    end
-  end
-
-  def move_on_after(interval)
-    f = Fiber.current
-    cancel_id = ring.prep_timeout(interval: interval) do |c|
-      if c[:result] != Errno::ECANCELED::Errno
-        cancel_fiber_op(f)
-      end
-    end
-    v = yield
-    ring.prep_cancel(cancel_id)
-    v
-  end
-end
-
-s = Scheduler.new
-
-puts "Going to sleep..."
-s.sleep 3
-puts "Woke up"
-
-s.move_on_after(1) do
-  puts "Going to sleep (move on after 1 second)"
-  s.sleep 3
-end

data/examples/http_server_multishot.rb

@@ -1,57 +0,0 @@
-require_relative '../lib/iou'
-require 'socket'
-require 'http/parser'
-
-def log(msg)
-  # return
-  STDERR.puts msg
-end
-
-socket = TCPServer.open('127.0.0.1', 1234)
-log 'Listening on port 1234... (multishot read)'
-
-@ring = IOU::Ring.new
-@bg_id = @ring.setup_buffer_ring(count: 1024, size: 4096)
-
-@ring.prep_accept(fd: socket.fileno, multishot: true) do |c|
-  setup_connection(c[:result]) if c[:result] > 0
-end
-
-def setup_connection(fd)
-  log "Connection accepted fd #{fd}"
-
-  parser = Http::Parser.new
-  parser.on_message_complete = -> {
-    http_send_response(fd, "Hello, world!\n")
-  }
-
-  http_prep_read(fd, parser)
-end
-
-def http_prep_read(fd, parser)
-  id = @ring.prep_read(fd: fd, multishot: true, buffer_group: @bg_id) do |c|
-    if c[:result] > 0
-      parser << c[:buffer]
-    elsif c[:result] == 0
-      log "Connection closed by client on fd #{fd}"
-    else
-      if c[:result] != -Errno::ECANCELED::Errno
-        log "Got error #{c[:result]} on fd #{fd}, closing connection..."
-      end
-      @ring.prep_close(fd: fd) do |c|
-        log "Connection closed on fd #{fd}, result #{c[:result]}"
-      end
-    end
-  rescue HTTP::Parser::Error
-    puts "Error parsing, closing connection..."
-    @ring.prep_cancel(id)
-  end
-end
-
-def http_send_response(fd, body)
-  msg = "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nConnection: keep-alive\r\nContent-Length: #{body.bytesize}\r\n\r\n#{body}"
-  @ring.prep_write(fd: fd, buffer: msg)
-end
-
-trap('SIGINT') { exit! }
-@ring.process_completions_loop