uringmachine 0.31.0 → 0.32.0

data/benchmark/openssl.rb

@@ -81,7 +81,7 @@ end
 @um.ssl_set_bio(@ssl_conn)
 @ssl_conn.connect
 
-@conn = @um.connection(@ssl_conn, :ssl)
+@io = @um.io(@ssl_conn)
 
 @msg = 'abc' * 1000
 @msg_newline = @msg + "\n"
@@ -91,15 +91,15 @@ def do_io(ssl)
   ssl.gets
 end
 
-def do_io_connection(ssl, um, conn)
+def do_io_io(ssl, um, io)
   um.ssl_write(ssl, @msg_newline, 0)
-  conn.read_line(0)
+  io.read_line(0)
 end
 
 Benchmark.ips do |x|
   x.report('stock') { do_io(@ssl_stock) }
   x.report('UM BIO') { do_io(@ssl_um) }
-  x.report('UM Stream') { do_io_connection(@ssl_conn, @um, @conn) }
+  x.report('UM::IO') { do_io_io(@ssl_conn, @um, @io) }
 
   x.compare!(order: :baseline)
 end

data/examples/fiber_concurrency_io.rb

@@ -4,7 +4,7 @@
 def fiber_switch
   while true
     next_fiber, value = @runqueue.shift
-    return next_fiber.transfer value if next_fiber
+    return next_fiber.transfer(value) if next_fiber
 
     process_events
   end

data/examples/fiber_concurrency_um.rb

@@ -0,0 +1,16 @@
+require 'uringmachine'
+
+machine = UM.new
+
+reader = machine.spin {
+  input = +''
+  machine.read(UM::STDIN_FILENO, input, 256)
+  machine.write(UM::STDOUT_FILENO, "Got: #{input}")
+}
+
+sleeper = machine.spin {
+  machine.sleep(5)
+  machine.write(UM::STDOUT_FILENO, "5 seconds have elapsed!")
+}
+
+machine.join(reader, sleeper)

data/examples/io_uring_simple.c

@@ -7,6 +7,7 @@ int ret;
 char buf[100];
 
 ret = io_uring_queue_init(8, &ring, 0);
+
 sqe = io_uring_get_sqe(&ring);
 io_uring_prep_read(sqe, STDIN_FILENO, buf, 100, 0);
 sqe->user_data = 42;
@@ -14,11 +15,19 @@ io_uring_submit(&ring);
 
 ...
 
-ret = io_uring_wait_cqe(&ring, &cqe);
-if (!ret) {
+sqe = io_uring_get_sqe(&ring);
+io_uring_prep_cancel(sqe, 42, IORING_ASYNC_CANCEL_USERDATA);
+sqe->flags = IOSQE_CQE_SKIP_SUCCESS;
+io_uring_submit(&ring);
+
+if (!io_uring_wait_cqe(&ring, &cqe)) {
   if (cqe->user_data == 42) {
-    int len = cqe->res;
-    printf("Got: %d\n", len);
+    if (cqe->res == -ECANCELED)
+      printf("Cancelled!\n");
+    else {
+      int len = cqe->res;
+      printf("Got %d bytes\n", len);
+    }
   }
   io_uring_cqe_seen(&ring, cqe);
 }

data/examples/pg.rb

@@ -66,9 +66,9 @@ $machine.listen(server_fd, UM::SOMAXCONN)
 puts 'Listening on port 1234'
 
 def handle_connection(fd)
-  conn = UM::Connection.new($machine, fd)
+  io = UM::IO.new($machine, fd)
 
-  while (l = conn.gets)
+  while (l = io.gets)
     $machine.write(fd, "You said: #{l}")
   end
 rescue Exception => e

data/examples/um_cancellation.rb

@@ -0,0 +1,20 @@
+f = machine.spin do
+  buf = +''
+  machine.read(fd, buf, 256)
+  machine.write(UM::STDOUT_FILENO, "Got: #{buf}")
+rescue UM::Terminate
+  machine.write(UM::STDOUT_FILENO, "Cancelled")
+end
+
+machine.sleep(0.1)
+machine.schedule(f, UM::Terminate.new)
+
+
+
+
+# read with timeout
+input = +''
+machine.timeout(timeout, TimeoutError) {
+  machine.read(fd, input, 256)
+}
+

data/examples/um_fiber_scheduler.rb

@@ -0,0 +1,10 @@
+machine = UM.new
+scheduler = UM::FiberScheduler.new(machine)
+Fiber.set_scheduler(scheduler)
+
+Fiber.schedule {
+  # UringMachine-driven I/O!
+  puts "What's your favorite color?"
+  color = gets
+  puts "Wrong answer: #{color}!"
+}

data/examples/um_io.rb

@@ -0,0 +1,19 @@
+io = machine.io(fd)
+
+# parse an incoming HTTP request
+line = io.read_line(4096)
+m = line.match(/^([a-z]+)\s+([^\s]+)\s+(http\/1\.1)/i)
+headers = {
+  ':method'   => m[1].downcase,
+  ':path'     => m[2],
+  ':protocol' => m[3].downcase
+}
+while true
+  line = io.read_line(4096)
+  break if line.empty?
+
+  m = line.match(/^([a-z0-9\-]+)\:\s+(.+)/i)
+  headers[m[1].downcase] = m[2]
+end
+
+io.write("HTTP/1.1 200 OK\r\nContent-Length: 3\r\n\r\nfoo")

data/examples/um_mo.c

@@ -0,0 +1,32 @@
+VALUE um_sleep(struct um *machine, double duration) {
+  struct um_op *op = um_op_acquire(machine);
+  op->fiber = rb_fiber_current();
+  op->ts = um_double_to_timespec(duration);
+  struct io_uring_sqe *sqe = um_get_sqe(machine, op);
+  io_uring_prep_timeout(sqe, &op->ts, 0, 0);
+
+  VALUE ret = um_switch(machine);
+  if (um_verify_op_completion(machine, op)) ret = DBL2NUM(duration);
+  um_op_release(machine, op);
+
+  RAISE_IF_EXCEPTION(ret);
+  return ret;
+}
+
+VALUE um_switch(struct um *machine) {
+  while (true) {
+    struct um_op *op = um_runqueue_shift(machine);
+    if (op) return rb_fiber_transfer(op->fiber, 1, &op->value);
+
+    um_wait_for_and_process_ready_cqes(machine);
+  }
+}
+
+void um_process_cqe(struct um *machine, struct io_uring_cqe *cqe) {
+  struct um_op *op = (struct um_op *)cqe->user_data;
+  if (op) {
+    op->result.res    = cqe->res;
+    op->result.flags  = cqe->flags;
+    um_runqueue_push(machine, op);
+  }
+}

data/examples/um_multishot.rb

@@ -0,0 +1,15 @@
+# singleshot accept
+while (fd = machine.accept(server_fd))
+  handle_connection(fd)
+end
+
+# multishot accept
+machine.accept_each(server_fd) { handle_connection(it) }
+
+# multishot timeout
+machine.periodically(5) { ... }
+
+# multishot recv
+machine.recv_each(fd, 0) { |data|
+  machine.write(UM::STDOUT_FILENO, "Got: #{data}\n")
+}

data/examples/um_ssl.rb

@@ -0,0 +1,11 @@
+ssl = OpenSSL::SSL::SSLSocket.new(IO.for_fd(server_fd), server_ctx)
+machine.ssl_set_bio(ssl)
+ssl.accept
+
+ssl.write('Hello!')
+# also:
+machine.ssl_write(ssl, 'Hello!')
+
+io = machine.io(ssl)
+line = io.read_line(4096)
+...

data/ext/um/um.h

@@ -80,12 +80,12 @@ enum um_op_kind {
   OP_TIMEOUT_MULTISHOT,
 };
 
-enum um_connection_mode {
-  CONNECTION_FD,
-  CONNECTION_SOCKET,
-  CONNECTION_SSL,
-  CONNECTION_STRING,
-  CONNECTION_IO_BUFFER
+enum um_io_mode {
+  IO_FD,
+  IO_SOCKET,
+  IO_SSL,
+  IO_STRING,
+  IO_IO_BUFFER
 };
 
 #define OP_F_CQE_SEEN       (1U << 0) // CQE has been seen
@@ -272,11 +272,11 @@ struct um_async_op {
   struct um_op *op;
 };
 
-struct um_connection {
+struct um_io {
   VALUE self;
   struct um *machine;
 
-  enum um_connection_mode mode;
+  enum um_io_mode mode;
   union {
     int fd;
     VALUE target;
@@ -304,7 +304,7 @@ extern VALUE eUMError;
 extern VALUE cMutex;
 extern VALUE cQueue;
 extern VALUE cAsyncOp;
-extern VALUE eConnectionRESPError;
+extern VALUE eIORESPError;
 
 struct um *um_get_machine(VALUE self);
 void um_setup(VALUE self, struct um *machine, uint size, uint sqpoll_timeout_msec, int sidecar_mode);
@@ -438,16 +438,16 @@ VALUE um_queue_pop(struct um *machine, struct um_queue *queue);
 VALUE um_queue_unshift(struct um *machine, struct um_queue *queue, VALUE value);
 VALUE um_queue_shift(struct um *machine, struct um_queue *queue);
 
-void connection_teardown(struct um_connection *conn);
-void connection_clear(struct um_connection *conn);
-VALUE connection_read_line(struct um_connection *conn, VALUE out_buffer, size_t maxlen);
-VALUE connection_read(struct um_connection *conn, VALUE out_buffer, ssize_t len, size_t inc, int safe_inc);
-VALUE connection_read_to_delim(struct um_connection *conn, VALUE out_buffer, VALUE delim, ssize_t maxlen);
-void connection_skip(struct um_connection *conn, size_t inc, int safe_inc);
-void connection_read_each(struct um_connection *conn);
-size_t connection_write_raw(struct um_connection *conn, const char *buffer, size_t len);
-VALUE connection_writev(struct um_connection *conn, int argc, VALUE *argv);
-VALUE resp_read(struct um_connection *conn, VALUE out_buffer);
+void io_teardown(struct um_io *io);
+void io_clear(struct um_io *io);
+VALUE io_read_line(struct um_io *io, VALUE out_buffer, size_t maxlen);
+VALUE io_read(struct um_io *io, VALUE out_buffer, ssize_t len, size_t inc, int safe_inc);
+VALUE io_read_to_delim(struct um_io *io, VALUE out_buffer, VALUE delim, ssize_t maxlen);
+void io_skip(struct um_io *io, size_t inc, int safe_inc);
+void io_read_each(struct um_io *io);
+size_t io_write_raw(struct um_io *io, const char *buffer, size_t len);
+VALUE io_writev(struct um_io *io, int argc, VALUE *argv);
+VALUE resp_read(struct um_io *io, VALUE out_buffer);
 void resp_encode(struct um_write_buffer *buf, VALUE obj);
 void resp_encode_cmd(struct um_write_buffer *buf, int argc, VALUE *argv);
 

data/ext/um/um_ext.c

@@ -2,14 +2,12 @@ void Init_UM();
 void Init_Mutex();
 void Init_Queue();
 void Init_AsyncOp();
-void Init_SSL();
-void Init_Stream();
+void Init_IO();
 
 void Init_um_ext(void) {
   Init_UM();
   Init_Mutex();
   Init_Queue();
   Init_AsyncOp();
-  // Init_SSL();
-  Init_Stream();
+  Init_IO();
 }