Implement Socket for win32

.github/workflows/win.yml

@@ -189,6 +189,9 @@ jobs:
       - name: Build stdlib specs executable
         run: |
           bin\crystal.exe build spec/std_spec.cr --exclude-warnings spec/std --exclude-warnings spec/compiler -Dwithout_openssl -Di_know_what_im_doing
+      - name: Run socket specs
+        run: |
+          .\std_spec.exe --verbose -e TCPSocket
       - name: Run stdlib specs
         run: |
           .\std_spec.exe

spec/std/socket/socket_spec.cr

@@ -1,9 +1,10 @@
 require "./spec_helper"
 require "../../support/tempfile"
+require "../../support/win32"
 
 describe Socket do
   describe ".unix" do
-    it "creates a unix socket" do
+    pending_win32 "creates a unix socket" do
       sock = Socket.unix
       sock.should be_a(Socket)
       sock.family.should eq(Socket::Family::UNIX)
@@ -14,7 +15,7 @@ describe Socket do
     end
   end
 
-  it ".accept" do
+  pending_win32 ".accept" do
     client_done = Channel(Nil).new
     server = Socket.new(Socket::Family::INET, Socket::Type::STREAM, Socket::Protocol::TCP)
 
@@ -54,7 +55,7 @@ describe Socket do
     expect_raises(IO::TimeoutError) { server.accept? }
   end
 
-  it "sends messages" do
+  pending_win32 "sends messages" do
     port = unused_local_port
     server = Socket.tcp(Socket::Family::INET)
     server.bind("127.0.0.1", port)
@@ -76,7 +77,7 @@ describe Socket do
     server.try &.close
   end
 
-  it "sends datagram over unix socket" do
+  pending_win32 "sends datagram over unix socket" do
     with_tempfile("datagram_unix") do |path|
       server = Socket.unix(Socket::Type::DGRAM)
       server.bind Socket::UNIXAddress.new(path)

spec/std/socket/tcp_server_spec.cr

@@ -1,4 +1,5 @@
 require "./spec_helper"
+require "../../support/win32"
 
 describe TCPServer do
   describe ".new" do
@@ -39,35 +40,35 @@ describe TCPServer do
         error = expect_raises(Socket::Addrinfo::Error) do
           TCPServer.new(address, -12)
         end
-        error.error_code.should eq({% if flag?(:linux) %}LibC::EAI_SERVICE{% else %}LibC::EAI_NONAME{% end %})
+        error.os_error.should eq({% if flag?(:linux) %}Errno.new(LibC::EAI_SERVICE){% elsif flag?(:win32) %}WinError::WSATYPE_NOT_FOUND{% else %}Errno.new(LibC::EAI_NONAME){% end %})
       end
 
       describe "reuse_port" do
-        it "raises when port is in use" do
+        pending_win32 "raises when port is in use" do
           TCPServer.open(address, 0) do |server|
             expect_raises(Socket::BindError, "Could not bind to '#{address}:#{server.local_address.port}': ") do
               TCPServer.open(address, server.local_address.port) { }
             end
           end
         end
 
-        it "raises when not binding with reuse_port" do
+        pending_win32 "raises when not binding with reuse_port" do
           TCPServer.open(address, 0, reuse_port: true) do |server|
             expect_raises(Socket::BindError) do
               TCPServer.open(address, server.local_address.port) { }
             end
           end
         end
 
-        it "raises when port is not ready to be reused" do
+        pending_win32 "raises when port is not ready to be reused" do
           TCPServer.open(address, 0) do |server|
             expect_raises(Socket::BindError) do
               TCPServer.open(address, server.local_address.port, reuse_port: true) { }
             end
           end
         end
 
-        it "binds to used port with reuse_port = true" do
+        pending_win32 "binds to used port with reuse_port = true" do
           TCPServer.open(address, 0, reuse_port: true) do |server|
             TCPServer.open(address, server.local_address.port, reuse_port: true) { }
           end
@@ -82,15 +83,17 @@ describe TCPServer do
       end
 
       it "raises when host doesn't exist" do
-        expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed: No address found") do
+        err = expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed") do
           TCPServer.new("doesnotexist.example.org.", 12345)
         end
+        err.os_error.should eq({% if flag?(:win32) %}WinError::WSAHOST_NOT_FOUND{% else %}Errno.new(LibC::EAI_NONAME){% end %})
       end
 
       it "raises (rather than segfault on darwin) when host doesn't exist and port is 0" do
-        expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed: No address found") do
+        err = expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed") do
           TCPServer.new("doesnotexist.example.org.", 0)
         end
+        err.os_error.should eq({% if flag?(:win32) %}WinError::WSAHOST_NOT_FOUND{% else %}Errno.new(LibC::EAI_NONAME){% end %})
       end
     end
 

spec/std/socket/tcp_socket_spec.cr

@@ -1,4 +1,5 @@
 require "./spec_helper"
+require "../../support/win32"
 
 describe TCPSocket do
   describe "#connect" do
@@ -18,7 +19,10 @@ describe TCPSocket do
             sock.local_address.port.should eq(port)
             sock.local_address.address.should eq(address)
 
-            client.remote_address.port.should eq(port)
+            # FIXME: This should work on win32
+            {% unless flag?(:win32) %}
+              client.remote_address.port.should eq(port)
+            {% end %}
             sock.remote_address.address.should eq address
           end
         end
@@ -36,7 +40,7 @@ describe TCPSocket do
         error = expect_raises(Socket::Addrinfo::Error) do
           TCPSocket.new(address, -12)
         end
-        error.error_code.should eq({% if flag?(:linux) %}LibC::EAI_SERVICE{% else %}LibC::EAI_NONAME{% end %})
+        error.os_error.should eq({% if flag?(:win32) %}WinError::WSATYPE_NOT_FOUND{% elsif flag?(:linux) %}Errno.new(LibC::EAI_SERVICE){% else %}Errno.new(LibC::EAI_NONAME){% end %})
       end
 
       it "raises when port is zero" do
@@ -58,15 +62,17 @@ describe TCPSocket do
       end
 
       it "raises when host doesn't exist" do
-        expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed: No address found") do
+        error = expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed") do
           TCPSocket.new("doesnotexist.example.org.", 12345)
         end
+        error.os_error.should eq({% if flag?(:win32) %}WinError::WSAHOST_NOT_FOUND{% else %}Errno.new(LibC::EAI_NONAME){% end %})
       end
 
       it "raises (rather than segfault on darwin) when host doesn't exist and port is 0" do
-        expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed: No address found") do
+        error = expect_raises(Socket::Error, "Hostname lookup for doesnotexist.example.org. failed") do
           TCPSocket.new("doesnotexist.example.org.", 0)
         end
+        error.os_error.should eq({% if flag?(:win32) %}WinError::WSAHOST_NOT_FOUND{% else %}Errno.new(LibC::EAI_NONAME){% end %})
       end
     end
 
@@ -81,7 +87,7 @@ describe TCPSocket do
     end
   end
 
-  it "sync from server" do
+  pending_win32 "sync from server" do
     port = unused_local_port
 
     TCPServer.open("::", port) do |server|
@@ -100,7 +106,7 @@ describe TCPSocket do
     end
   end
 
-  it "settings" do
+  pending_win32 "settings" do
     port = unused_local_port
 
     TCPServer.open("::", port) do |server|

spec/std/socket/udp_socket_spec.cr

@@ -61,14 +61,18 @@ describe UDPSocket do
 
       client.send("laus deo semper")
 
-      bytes_read, client_addr = server.receive(buffer.to_slice[0, 4])
-      message = String.new(buffer.to_slice[0, bytes_read])
-      message.should eq("laus")
+      # WSA errors with WSAEMSGSIZE if the buffer is not large enough to receive the message
+      {% unless flag?(:win32) %}
+        bytes_read, client_addr = server.receive(buffer.to_slice[0, 4])
+        message = String.new(buffer.to_slice[0, bytes_read])
+        message.should eq("laus")
+      {% end %}
 
       client.close
       server.close
     end
 
+    {% unless flag?(:win32) %}
     if {{ flag?(:darwin) }} && family == Socket::Family::INET6
       # Darwin is failing to join IPv6 multicast groups on older versions.
       # However this is known to work on macOS Mojave with Darwin 18.2.0.
@@ -150,6 +154,7 @@ describe UDPSocket do
         expect_raises(IO::Error, "Closed stream") { udp.receive }
       end
     end
+    {% end %}
   end
 
   {% if flag?(:linux) %}

spec/win32_std_spec.cr

@@ -183,10 +183,10 @@ require "./std/set_spec.cr"
 require "./std/slice_spec.cr"
 require "./std/socket/address_spec.cr"
 require "./std/socket/addrinfo_spec.cr"
-# require "./std/socket/socket_spec.cr" (failed codegen)
-# require "./std/socket/tcp_server_spec.cr" (failed codegen)
-# require "./std/socket/tcp_socket_spec.cr" (failed codegen)
-# require "./std/socket/udp_socket_spec.cr" (failed codegen)
+require "./std/socket/socket_spec.cr"
+require "./std/socket/tcp_server_spec.cr"
+require "./std/socket/tcp_socket_spec.cr"
+require "./std/socket/udp_socket_spec.cr"
 # require "./std/socket/unix_server_spec.cr" (failed codegen)
 # require "./std/socket/unix_socket_spec.cr" (failed codegen)
 require "./std/spec/context_spec.cr"

src/crystal/system/socket.cr

@@ -78,6 +78,8 @@ end
 
 {% if flag?(:unix) %}
   require "./unix/socket"
+{% elsif flag?(:win32) %}
+  require "./win32/socket"
 {% else %}
   {% raise "No Crystal::System::Socket implementation available" %}
 {% end %}

src/crystal/system/win32/event_loop_iocp.cr

@@ -1,8 +1,37 @@
+require "c/ioapiset"
 require "crystal/system/print_error"
 
 module Crystal::EventLoop
   @@queue = Deque(Fiber).new
 
+  # Returns the base IO Completion Port
+  class_getter iocp : LibC::HANDLE do
+    create_completion_port(LibC::INVALID_HANDLE_VALUE, nil)
+  end
+
+  def self.create_completion_port(handle : LibC::HANDLE, parent : LibC::HANDLE? = iocp)
+    iocp = LibC.CreateIoCompletionPort(handle, parent, nil, 0)
+    if iocp.null?
+      raise IO::Error.from_winerror("CreateIoCompletionPort")
+    end
+    iocp
+  end
+
+  # This is a temporary stub as a stand in for fiber swapping required for concurrency
+  def self.wait_completion(timeout = nil)
+    result = LibC.GetQueuedCompletionStatusEx(iocp, out io_entry, 1, out removed, timeout, false)
+    if result == 0
+      error = WinError.value
+      if timeout && error.wait_timeout?
+        return false
+      else
+        raise IO::Error.from_os_error("GetQueuedCompletionStatusEx", error)
+      end
+    end
+
+    true
+  end
+
   # Runs the event loop.
   def self.run_once : Nil
     next_fiber = @@queue.pop?