mruby-io_uring

io_uring for mruby (WIP)

Requirements

This requires at least Linux 5.6

Installation

You have to install liburing with development headers first. Then add

conf.gem mgem: 'mruby-io-uring'

to your build_config.rb

Supported functions

At the moment the following functions are implemented.

io_uring_queue_init
io_uring_get_sqe
io_uring_submit
io_uring_prep_socket
io_uring_prep_accept
io_uring_prep_recv
io_uring_prep_splice
io_uring_prep_send
io_uring_prep_shutdown
io_uring_prep_close
io_uring_prep_poll_add
io_uring_wait_cqe_timeout

Here is an example on how to use them (requires mruby-phr for http parsing)

body = "hallo\n"
headers = "HTTP/1.1 200 OK\r\nConnection: keep-alive\r\nContent-Type: text/plain\r\nContent-Length: #{body.bytesize}\r\n\r\n"
response = "#{headers}#{body}"
uring = IO::Uring.new
server = TCPServer.new(12345)
server.listen(4096)
uring.prep_accept(server)

phr = Phr.new

while true
  uring.wait do |userdata|
    raise userdata.errno if userdata.errno
    case userdata.type
    when :accept
      puts "Remote Address: #{userdata.to_tcpsocket.remote_address.inspect}"
      puts "Socket        : #{userdata.res}"
      uring.prep_recv(userdata.res)
      uring.prep_accept(userdata.socket)
      #userdata.res  is the accepted socket
      #userdata.socket is the socket passed to prep_accept, aka the server socket.
    when :recv
      next if userdata.res == 0
      ret = phr.parse_request(userdata.buf)
      case ret
      when :incomplete, :parser_error
        uring.prep_close(userdata.socket)
        phr.reset
        next
      when Integer
        puts "HTTP Method   : #{phr.method}"
        puts "HTTP Version  : 1.#{phr.minor_version}"
        puts "HTTP Path     : #{phr.path}"
        puts "HTTP Headers  : #{phr.headers.inspect}"
        puts "HTTP Body     : #{userdata.buf.byteslice(ret..-1).inspect}"
      end
      phr.reset
      uring.prep_send(userdata.socket, response)
    when :send
      uring.prep_close(userdata.socket)
    end
  end
end

uring.wait accepts a timeout as a float value, if a timeout occurs false is returned.

You can also use uring.wait without a block. It returns an array which you can then iterate over.

Every instanced IO::Uring prep method accepts a sqe parameter as the last one, you can get a sqe by calling uring.sqe

uring.prep_send(socket, response, 0, uring.sqe)

you can access a sqes flags by calling sqe.flags and sqe.flags=

LICENSE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0