uringmachine 0.32.0 → 1.0.0

data/ext/um/um_class.c

@@ -22,7 +22,6 @@ VALUE SYM_ops_free;
 VALUE SYM_ops_transient;
 VALUE SYM_time_total_cpu;
 VALUE SYM_time_total_wait;
-VALUE SYM_buffer_groups;
 VALUE SYM_buffers_allocated;
 VALUE SYM_buffers_free;
 VALUE SYM_segments_free;
@@ -129,18 +128,6 @@ VALUE UM_initialize(int argc, VALUE *argv, VALUE self) {
   return self;
 }
 
-/* Creates a buffer group (buffer ring) with the given buffer size and buffer count.
- *
- * @param size [Integer] buffer size in bytes
- * @param count [Integer] number of buffers in group
- * @return [Integer] buffer group id
- */
-VALUE UM_setup_buffer_ring(VALUE self, VALUE size, VALUE count) {
-  struct um *machine = um_get_machine(self);
-  int bgid = um_setup_buffer_ring(machine, NUM2UINT(size), NUM2UINT(count));
-  return INT2NUM(bgid);
-}
-
 /* Returns the SQ (submission queue) size.
  *
  * @return [Integer] SQ size
@@ -408,21 +395,19 @@ VALUE UM_read(int argc, VALUE *argv, VALUE self) {
 }
 
 /* call-seq:
- *   machine.read_each(fd, bgid) { |data| }
+ *   machine.read_each(fd) { |data| }
  *
- * Reads repeatedly from the given `fd` using the given buffer group id. The
- * buffer group should have been previously setup using `#setup_buffer_ring`.
- * Read data is yielded in an infinite loop to the given block.
+ * Reads repeatedly from the given fd. Read data is yielded in an infinite
+ * loop to the given block.
  *
  * - https://www.man7.org/linux/man-pages/man3/io_uring_prep_read_multishot.3.html
  *
  * @param fd [Integer] file descriptor
- * @param bgid [Integer] buffer group id
  * @return [void]
  */
-VALUE UM_read_each(VALUE self, VALUE fd, VALUE bgid) {
+VALUE UM_read_each(VALUE self, VALUE fd) {
   struct um *machine = um_get_machine(self);
-  return um_read_each(machine, NUM2INT(fd), NUM2INT(bgid));
+  return um_read_each(machine, NUM2INT(fd));
 }
 
 /* call-seq:
@@ -836,38 +821,6 @@ VALUE UM_sendv(int argc, VALUE *argv, VALUE self) {
 }
 
 
-/* call-seq:
- *   machine.send_bundle(fd, bgid, *buffers) -> bytes_sent
- *
- * Sends data on the given socket from the given buffers using a registered
- * buffer group. The buffer group should have been previously registered using
- * `#setup_buffer_ring`.
- *
- * - https://www.man7.org/linux/man-pages/man2/send.2.html
- * - https://www.man7.org/linux/man-pages/man3/io_uring_prep_send.3.html
- *
- * @overload send_bundle(fd, bgid, *buffers)
- *   @param fd [Integer] file descriptor
- *   @param bgid [Integer] buffer group id
- *   @param *buffers [Array<String, IO::Buffer>] buffers
- *   @return [Integer] number of bytes sent
- */
-VALUE UM_send_bundle(int argc, VALUE *argv, VALUE self) {
-  struct um *machine = um_get_machine(self);
-  VALUE fd;
-  VALUE bgid;
-  VALUE strings;
-  rb_scan_args(argc, argv, "2*", &fd, &bgid, &strings);
-
-  if (RARRAY_LEN(strings) == 1) {
-    VALUE first = rb_ary_entry(strings, 0);
-    if (TYPE(first) == T_ARRAY)
-      strings = first;
-  }
-
-  return um_send_bundle(machine, NUM2INT(fd), NUM2INT(bgid), strings);
-}
-
 /* call-seq:
  *   machine.recv(fd, buffer, maxlen, flags) -> bytes_received
  *
@@ -888,23 +841,20 @@ VALUE UM_recv(VALUE self, VALUE fd, VALUE buffer, VALUE maxlen, VALUE flags) {
 }
 
 /* call-seq:
- *   machine.recv_each(fd, bgid, flags) { |data| ... }
+ *   machine.recv_each(fd, flags) { |data| ... }
  *
- * Repeatedlty receives data from the given socket in an infinite loop using the
- * given buffer group id. The buffer group should have been previously setup
- * using `#setup_buffer_ring`.
+ * Repeatedlty receives data from the given socket in an infinite loop.
  *
  * - https://www.man7.org/linux/man-pages/man2/recv.2.html
  * - https://www.man7.org/linux/man-pages/man3/io_uring_prep_recv.3.html
  *
  * @param fd [Integer] file descriptor
- * @param bgid [Integer] buffer group id
  * @param flags [Integer] flags mask
  * @return [void]
  */
-VALUE UM_recv_each(VALUE self, VALUE fd, VALUE bgid, VALUE flags) {
+VALUE UM_recv_each(VALUE self, VALUE fd, VALUE flags) {
   struct um *machine = um_get_machine(self);
-  return um_recv_each(machine, NUM2INT(fd), NUM2INT(bgid), NUM2INT(flags));
+  return um_recv_each(machine, NUM2INT(fd), NUM2INT(flags));
 }
 
 /* call-seq:
@@ -1512,8 +1462,6 @@ void Init_UM(void) {
   rb_define_method(cUM, "sidecar_start", UM_sidecar_start, 0);
   rb_define_method(cUM, "sidecar_stop", UM_sidecar_stop, 0);
 
-  rb_define_method(cUM, "setup_buffer_ring", UM_setup_buffer_ring, 2);
-
   rb_define_method(cUM, "schedule", UM_schedule, 2);
   rb_define_method(cUM, "snooze", UM_snooze, 0);
   rb_define_method(cUM, "timeout", UM_timeout, 2);
@@ -1527,7 +1475,7 @@ void Init_UM(void) {
   rb_define_method(cUM, "close_async", UM_close_async, 1);
   rb_define_method(cUM, "open", UM_open, 2);
   rb_define_method(cUM, "read", UM_read, -1);
-  rb_define_method(cUM, "read_each", UM_read_each, 2);
+  rb_define_method(cUM, "read_each", UM_read_each, 1);
   rb_define_method(cUM, "sleep", UM_sleep, 1);
   rb_define_method(cUM, "periodically", UM_periodically, 1);
   rb_define_method(cUM, "write", UM_write, -1);
@@ -1554,11 +1502,10 @@ void Init_UM(void) {
   rb_define_method(cUM, "getsockopt", UM_getsockopt, 3);
   rb_define_method(cUM, "listen", UM_listen, 2);
   rb_define_method(cUM, "recv", UM_recv, 4);
-  rb_define_method(cUM, "recv_each", UM_recv_each, 3);
+  rb_define_method(cUM, "recv_each", UM_recv_each, 2);
   rb_define_method(cUM, "send", UM_send, 4);
   rb_define_method(cUM, "sendv", UM_sendv, -1);
 
-  rb_define_method(cUM, "send_bundle", UM_send_bundle, -1);
   rb_define_method(cUM, "setsockopt", UM_setsockopt, 4);
   rb_define_method(cUM, "socket", UM_socket, 4);
   rb_define_method(cUM, "shutdown", UM_shutdown, 2);
@@ -1595,7 +1542,6 @@ void Init_UM(void) {
   SYM_ops_transient           = ID2SYM(rb_intern("ops_transient"));
   SYM_time_total_cpu          = ID2SYM(rb_intern("time_total_cpu"));
   SYM_time_total_wait         = ID2SYM(rb_intern("time_total_wait"));
-  SYM_buffer_groups           = ID2SYM(rb_intern("buffer_groups"));
   SYM_buffers_allocated       = ID2SYM(rb_intern("buffers_allocated"));
   SYM_buffers_free            = ID2SYM(rb_intern("buffers_free"));
   SYM_segments_free           = ID2SYM(rb_intern("segments_free"));

data/ext/um/um_io.c

@@ -177,7 +177,6 @@ int io_get_more_segments_bp(struct um_io *io) {
 
         um_op_release(io->machine, io->op);
         io->op = NULL;
-        // io_multishot_op_start(io);
       }
       else {
         um_op_release(io->machine, io->op);

data/ext/um/um_op.c

@@ -20,7 +20,6 @@ const char * um_op_kind_name(enum um_op_kind kind) {
     case OP_RECV:               return "OP_RECV";
     case OP_RECVMSG:            return "OP_RECVMSG";
     case OP_SEND:               return "OP_SEND";
-    case OP_SEND_BUNDLE:        return "OP_SEND_BUNDLE";
     case OP_SENDMSG:            return "OP_SENDMSG";
     case OP_SENDV:              return "OP_SENDV";
     case OP_SOCKET:             return "OP_SOCKET";

data/ext/um/um_utils.c

@@ -115,92 +115,6 @@ inline int um_get_buffer_bytes_for_writing(VALUE buffer, const void **base, size
   return true;
 }
 
-int um_setup_buffer_ring(struct um *machine, unsigned size, unsigned count) {
-  if (machine->buffer_ring_count == BUFFER_RING_MAX_COUNT)
-    um_raise_internal_error("Cannot setup more than BUFFER_RING_MAX_COUNT buffer rings");
-
-  struct buf_ring_descriptor *desc = machine->buffer_rings + machine->buffer_ring_count;
-  desc->buf_count = count;
-  desc->buf_size = size;
-  desc->br_size = sizeof(struct io_uring_buf) * desc->buf_count;
-  desc->buf_mask = io_uring_buf_ring_mask(desc->buf_count);
-
-	void *mapped = mmap(
-    NULL, desc->br_size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, 0, 0
-  );
-  if (mapped == MAP_FAILED)
-    um_raise_internal_error("Failed to allocate buffer ring");
-
-  desc->br = (struct io_uring_buf_ring *)mapped;
-  io_uring_buf_ring_init(desc->br);
-
-  unsigned bg_id = machine->buffer_ring_count;
-  int ret;
-  desc->br = io_uring_setup_buf_ring(&machine->ring, count, bg_id, 0, &ret);
-  if (!desc->br) {
-    munmap(desc->br, desc->br_size);
-    rb_syserr_fail(-ret, strerror(-ret));
-  }
-
-  if (size > 0) {
-    if (posix_memalign(&desc->buf_base, 4096, desc->buf_count * desc->buf_size)) {
-      io_uring_free_buf_ring(&machine->ring, desc->br, desc->buf_count, bg_id);
-      um_raise_internal_error("Failed to allocate buffers");
-    }
-
-    char *ptr = desc->buf_base;
-    for (unsigned i = 0; i < desc->buf_count; i++) {
-	  	io_uring_buf_ring_add(desc->br, ptr, desc->buf_size, i, desc->buf_mask, i);
-      ptr += desc->buf_size;
-	  }
-	  io_uring_buf_ring_advance(desc->br, desc->buf_count);
-  }
-  machine->buffer_ring_count++;
-  return bg_id;
-}
-
-inline VALUE um_read_from_buffer_ring(struct um *machine, int bgid, __s32 result, __u32 flags) {
-  if (!result) return Qnil;
-
-  unsigned buf_idx = flags >> IORING_CQE_BUFFER_SHIFT;
-  struct buf_ring_descriptor *desc = machine->buffer_rings + bgid;
-  char *src = (char *)desc->buf_base + desc->buf_size * buf_idx;
-  // TODO: add support for UTF8
-  // buf = rd->utf8_encoding ? rb_utf8_str_new(src, cqe->res) : rb_str_new(src, cqe->res);
-  VALUE buf = rb_str_new(src, result);
-
-  // add buffer back to buffer ring
-  io_uring_buf_ring_add(
-    desc->br, src, desc->buf_size, buf_idx, desc->buf_mask, 0
-  );
-  io_uring_buf_ring_advance(desc->br, 1);
-
-  RB_GC_GUARD(buf);
-  return buf;
-}
-
-inline void um_add_strings_to_buffer_ring(struct um *machine, int bgid, VALUE strings) {
-  static ID ID_to_s = 0;
-
-  struct buf_ring_descriptor *desc = machine->buffer_rings + bgid;
-  ulong count = RARRAY_LEN(strings);
-  VALUE str = Qnil;
-  VALUE converted = Qnil;
-
-  for (ulong i = 0; i < count; i++) {
-    str = rb_ary_entry(strings, i);
-    if (TYPE(str) != T_STRING) {
-      if (!ID_to_s) ID_to_s = rb_intern("to_s");
-      if (NIL_P(converted)) converted = rb_ary_new();
-      str = rb_funcall(str, ID_to_s, 0);
-      rb_ary_push(converted, str);
-    }
-    io_uring_buf_ring_add(desc->br, RSTRING_PTR(str), RSTRING_LEN(str), i, desc->buf_mask, i);
-  }
-  RB_GC_GUARD(converted);
-  io_uring_buf_ring_advance(desc->br, count);
-}
-
 inline void um_raise_internal_error(const char *msg) {
   rb_raise(eUMError, "UringMachine error: %s", msg);
 }

data/lib/uringmachine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class UringMachine
-  VERSION = '0.32.0'
+  VERSION = '1.0.0'
 end

data/test/test_io.rb

@@ -33,7 +33,7 @@ class IOTest < IOBaseTest
     )
   end
 
-  def test_connection_basic_usage
+  def test_io_basic_usage
     assert_equal [0, 0, 0, 0, 0], buffer_metrics
     machine.write(@wfd, "foobar")
     machine.close(@wfd)
@@ -53,7 +53,7 @@ class IOTest < IOBaseTest
     assert_equal 0, machine.metrics[:ops_pending]
   end
 
-  def test_connection_clear
+  def test_io_clear
     rfd, wfd = UM.pipe
     conn = UM::IO.new(machine, rfd)
 
@@ -77,7 +77,7 @@ class IOTest < IOBaseTest
     machine.close(wfd) rescue nil
   end
 
-  def test_connection_big_read
+  def test_io_big_read
     s1, s2 = UM.socketpair(UM::AF_UNIX, UM::SOCK_STREAM, 0)
     conn = UM::IO.new(machine, s2)
 
@@ -96,7 +96,7 @@ class IOTest < IOBaseTest
     machine.join(f)
   end
 
-  def test_connection_buffer_reuse
+  def test_io_buffer_reuse
     s1, s2 = UM.socketpair(UM::AF_UNIX, UM::SOCK_STREAM, 0)
     conn = UM::IO.new(machine, s2)
 
@@ -131,7 +131,7 @@ class IOTest < IOBaseTest
     machine.join(f)
   end
 
-  def test_connection_read_line
+  def test_io_read_line
     machine.write(@wfd, "foo\nbar\r\nbaz")
     machine.close(@wfd)
 
@@ -145,7 +145,7 @@ class IOTest < IOBaseTest
     assert_equal "baz", conn.read(-6)
   end
 
-  def test_connection_read_line_segmented
+  def test_io_read_line_segmented
     machine.write(@wfd, "foo\n")
     assert_equal 'foo', conn.read_line(0)
 
@@ -163,7 +163,7 @@ class IOTest < IOBaseTest
     assert_nil conn.read_line(0)
   end
 
-  def test_connection_read_line_maxlen
+  def test_io_read_line_maxlen
     machine.write(@wfd, "foobar\r\n")
 
     assert_nil conn.read_line(3)
@@ -188,7 +188,7 @@ class IOTest < IOBaseTest
     assert_equal [16, 0, 256, 16384 * 16, 16384 * 16 - 17], buffer_metrics
   end
 
-  def test_connection_read
+  def test_io_read
     machine.write(@wfd, "foobarbazblahzzz")
     machine.close(@wfd)
 
@@ -198,7 +198,7 @@ class IOTest < IOBaseTest
     assert_nil conn.read(4)
   end
 
-  def test_connection_read_zero_len
+  def test_io_read_zero_len
     machine.write(@wfd, "foobar")
 
     assert_equal 'foobar', conn.read(0)
@@ -209,7 +209,7 @@ class IOTest < IOBaseTest
     assert_nil conn.read(0)
   end
 
-  def test_connection_read_negative_len
+  def test_io_read_negative_len
     machine.write(@wfd, "foobar")
 
     assert_equal 'foo', conn.read(-3)
@@ -221,7 +221,7 @@ class IOTest < IOBaseTest
     assert_nil conn.read(-3)
   end
 
-  def test_connection_read_to_delim
+  def test_io_read_to_delim
     machine.write(@wfd, "abc,def,ghi")
     machine.close(@wfd)
 
@@ -233,7 +233,7 @@ class IOTest < IOBaseTest
     assert_equal 'ghi', conn.read_to_delim(',', -3)
   end
 
-  def test_connection_read_to_delim_invalid_delim
+  def test_io_read_to_delim_invalid_delim
     machine.write(@wfd, "abc,def,ghi")
 
     assert_raises(ArgumentError) { conn.read_to_delim(:foo, 0) }
@@ -242,7 +242,7 @@ class IOTest < IOBaseTest
     assert_raises(UM::Error) { conn.read_to_delim('🙂', 0) }
   end
 
-  def test_connection_skip
+  def test_io_skip
     machine.write(@wfd, "foobarbaz")
 
     conn.skip(2)
@@ -252,7 +252,7 @@ class IOTest < IOBaseTest
     assert_equal 'az', conn.read(0)
   end
 
-  def test_connection_big_data
+  def test_io_big_data
     data = SecureRandom.random_bytes(300_000)
     fiber = machine.spin {
       machine.writev(@wfd, data)
@@ -273,7 +273,7 @@ class IOTest < IOBaseTest
     assert_equal data, received.join
   end
 
-  def test_connection_read_each
+  def test_io_read_each
     bufs = []
     f = machine.spin do
       bufs << :ready
@@ -323,7 +323,7 @@ class IOWriteTest < UMBaseTest
     super
   end
 
-  def test_connection_write_single_buf
+  def test_io_write_single_buf
     assert_equal 3, conn.write('foo')
 
     buf = +''
@@ -331,7 +331,7 @@ class IOWriteTest < UMBaseTest
     assert_equal 'foo', buf
   end
 
-  def test_connection_write_multi_buf
+  def test_io_write_multi_buf
     assert_equal 6, conn.write('foo', 'bar')
 
     buf = +''
@@ -339,7 +339,7 @@ class IOWriteTest < UMBaseTest
     assert_equal 'foobar', buf
   end
 
-  def test_connection_write_socket_mode
+  def test_io_write_socket_mode
     conn = machine.io(@s2, :socket)
 
     assert_equal 6, conn.write('foo', 'bar')
@@ -349,7 +349,7 @@ class IOWriteTest < UMBaseTest
     assert_equal 'foobar', buf
   end
 
-  def test_connection_write_ssl_mode
+  def test_io_write_ssl_mode
     ssl1 = OpenSSL::SSL::SSLSocket.new(IO.for_fd(@s1), Localhost::Authority.fetch.server_context)
     ssl1.sync_close = true
     ssl2 = OpenSSL::SSL::SSLSocket.new(IO.for_fd(@s2), OpenSSL::SSL::SSLContext.new)
@@ -380,7 +380,7 @@ class IOWriteTest < UMBaseTest
 end
 
 class IORespTest < IOBaseTest
-  def test_connection_resp_read
+  def test_io_resp_read
     machine.write(@wfd, "+foo bar\r\n")
     assert_equal "foo bar", conn.resp_read
 
@@ -443,7 +443,7 @@ class IORespTest < IOBaseTest
     assert_equal({ 'a' => 42, 'b' => ['foo', 'bar', 'baz'] }, conn.resp_read)
   end
 
-  def test_connection_resp_read_segmented
+  def test_io_resp_read_segmented
     machine.write(@wfd, "\n")
     assert_equal "", conn.read_line(0)
 
@@ -458,7 +458,7 @@ class IORespTest < IOBaseTest
     assert_equal "bazbug", conn.resp_read
   end
 
-  def test_connection_resp_write
+  def test_io_resp_write
     writer = machine.io(@wfd)
 
     writer.resp_write(nil);
@@ -489,7 +489,7 @@ class IORespTest < IOBaseTest
     assert_equal "%2\r\n$3\r\nfoo\r\n$3\r\nbar\r\n$3\r\nbaz\r\n:42\r\n", conn.read(-100)
   end
 
-  def test_connection_resp_encode
+  def test_io_resp_encode
     s = UM::IO
     assert_equal "_\r\n",             s.resp_encode(+'', nil)
     assert_equal "#t\r\n",            s.resp_encode(+'', true)
@@ -537,7 +537,7 @@ class IOStressTest < UMBaseTest
     end
   end
 
-  def test_connection_server_big_lines
+  def test_io_server_big_lines
     server_fibers = []
     server_fibers << machine.spin do
       machine.accept_each(@listen_fd) { |fd|
@@ -580,7 +580,7 @@ class IOStressTest < UMBaseTest
     assert_equal msg * client_count, @received.map { it + "\n" }.join
   end
 
-  def test_connection_server_http
+  def test_io_server_http
     server_fibers = []
     server_fibers << machine.spin do
       machine.accept_each(@listen_fd) { |fd|
@@ -621,7 +621,7 @@ class IOStressTest < UMBaseTest
 end
 
 class IODevRandomTest < UMBaseTest
-  def test_connection_dev_random_read_line
+  def test_io_dev_random_read_line
     fd = machine.open('/dev/random', UM::O_RDONLY)
     conn = UM::IO.new(machine, fd)
 
@@ -643,7 +643,7 @@ class IODevRandomTest < UMBaseTest
     n.times { acc << conn.read_line(0) }
   end
 
-  def test_connection_dev_random_read_line_concurrent
+  def test_io_dev_random_read_line_concurrent
     acc = []
     c = 1
     n = 100000
@@ -654,7 +654,7 @@ class IODevRandomTest < UMBaseTest
     assert_equal c * n, acc.size
   end
 
-  def test_connection_dev_random_read
+  def test_io_dev_random_read
     fd = machine.open('/dev/random', UM::O_RDONLY)
     conn = UM::IO.new(machine, fd)
 
@@ -677,7 +677,7 @@ class IODevRandomTest < UMBaseTest
 end
 
 class IOModeTest < UMBaseTest
-  def test_connection_default_mode
+  def test_io_default_mode
     r, w = UM.pipe
     conn = UM::IO.new(machine, r)
     assert_equal :fd, conn.mode
@@ -686,7 +686,7 @@ class IOModeTest < UMBaseTest
     machine.close(w) rescue nil
   end
 
-  def test_connection_default_mode_ssl
+  def test_io_default_mode_ssl
     authority = Localhost::Authority.fetch
     @server_ctx = authority.server_context
     sock1, sock2 = UNIXSocket.pair
@@ -699,7 +699,7 @@ class IOModeTest < UMBaseTest
     sock2&.close rescue nil
   end
 
-  def test_connection_socket_mode_non_socket
+  def test_io_socket_mode_non_socket
     r, w = UM.pipe
     machine.write(w, 'foobar')
     machine.close(w)
@@ -713,7 +713,7 @@ class IOModeTest < UMBaseTest
     machine.close(w) rescue nil
   end
 
-  def test_connection_socket_mode_socket
+  def test_io_socket_mode_socket
     r, w = UM.socketpair(UM::AF_UNIX, UM::SOCK_STREAM, 0)
     machine.write(w, 'foobar')
     machine.close(w)
@@ -727,7 +727,7 @@ class IOModeTest < UMBaseTest
     machine.close(w) rescue nil
   end
 
-  def test_connection_ssl_mode
+  def test_io_ssl_mode
     authority = Localhost::Authority.fetch
     @server_ctx = authority.server_context
     sock1, sock2 = UNIXSocket.pair
@@ -775,7 +775,7 @@ class IOModeTest < UMBaseTest
 end
 
 class IOByteCountsTest < IOBaseTest
-  def test_connection_byte_counts
+  def test_io_byte_counts
     machine.write(@wfd, "foobar")
 
     assert_equal 0, conn.consumed