puppet 6.29.0-universal-darwin → 7.0.0-universal-darwin

data/lib/puppet/util/windows/daemon.rb

@@ -0,0 +1,360 @@
+require 'puppet/ffi/windows'
+
+module Puppet::Util::Windows
+
+  # The Daemon class, based on the chef/win32-service implementation
+  class Daemon
+    include Puppet::FFI::Windows::Constants
+    extend Puppet::FFI::Windows::Constants
+
+    include Puppet::FFI::Windows::Structs
+    extend Puppet::FFI::Windows::Structs
+
+    include Puppet::FFI::Windows::Functions
+    extend Puppet::FFI::Windows::Functions
+
+    # Service is not running
+    STOPPED = SERVICE_STOPPED
+
+    # Service has received a start signal but is not yet running
+    START_PENDING = SERVICE_START_PENDING
+
+    # Service has received a stop signal but is not yet stopped
+    STOP_PENDING  = SERVICE_STOP_PENDING
+
+    # Service is running
+    RUNNING = SERVICE_RUNNING
+
+    # Service has received a signal to resume but is not yet running
+    CONTINUE_PENDING = SERVICE_CONTINUE_PENDING
+
+    # Service has received a signal to pause but is not yet paused
+    PAUSE_PENDING = SERVICE_PAUSE_PENDING
+
+    # Service is paused
+    PAUSED = SERVICE_PAUSED
+
+    # Service controls
+
+    # Notifies service that it should stop
+    CONTROL_STOP = SERVICE_CONTROL_STOP
+
+    # Notifies service that it should pause
+    CONTROL_PAUSE = SERVICE_CONTROL_PAUSE
+
+    # Notifies service that it should resume
+    CONTROL_CONTINUE = SERVICE_CONTROL_CONTINUE
+
+    # Notifies service that it should return its current status information
+    CONTROL_INTERROGATE = SERVICE_CONTROL_INTERROGATE
+
+    # Notifies a service that its parameters have changed
+    CONTROL_PARAMCHANGE = SERVICE_CONTROL_PARAMCHANGE
+
+    # Notifies a service that there is a new component for binding
+    CONTROL_NETBINDADD = SERVICE_CONTROL_NETBINDADD
+
+    # Notifies a service that a component for binding has been removed
+    CONTROL_NETBINDREMOVE = SERVICE_CONTROL_NETBINDREMOVE
+
+    # Notifies a service that a component for binding has been enabled
+    CONTROL_NETBINDENABLE = SERVICE_CONTROL_NETBINDENABLE
+
+    # Notifies a service that a component for binding has been disabled
+    CONTROL_NETBINDDISABLE = SERVICE_CONTROL_NETBINDDISABLE
+
+    IDLE = 0
+
+    # Misc
+    IDLE_CONTROL_CODE = 0
+    WAIT_OBJECT_0 = 0
+    WAIT_TIMEOUT = 0x00000102
+    WAIT_FAILED = 0xFFFFFFFF
+    NO_ERROR = 0
+
+    # Wraps SetServiceStatus.
+    SetTheServiceStatus = Proc.new do |dwCurrentState, dwWin32ExitCode, dwCheckPoint, dwWaitHint|
+      ss = SERVICE_STATUS.new  # Current status of the service.
+
+      # Disable control requests until the service is started.
+      if dwCurrentState == SERVICE_START_PENDING
+        ss[:dwControlsAccepted] = 0
+      else
+        ss[:dwControlsAccepted] =
+        SERVICE_ACCEPT_STOP|SERVICE_ACCEPT_SHUTDOWN|
+        SERVICE_ACCEPT_PAUSE_CONTINUE|SERVICE_ACCEPT_PARAMCHANGE
+      end
+
+      # Initialize ss structure.
+      ss[:dwServiceType]             = SERVICE_WIN32_OWN_PROCESS
+      ss[:dwServiceSpecificExitCode] = 0
+      ss[:dwCurrentState]            = dwCurrentState
+      ss[:dwWin32ExitCode]           = dwWin32ExitCode
+      ss[:dwCheckPoint]              = dwCheckPoint
+      ss[:dwWaitHint]                = dwWaitHint
+
+      @@dwServiceState = dwCurrentState
+
+      # Send status of the service to the Service Controller.
+      if !SetServiceStatus(@@ssh, ss)
+        SetEvent(@@hStopEvent)
+      end
+    end
+
+    ERROR_CALL_NOT_IMPLEMENTED = 0x78
+
+    # Handles control signals from the service control manager.
+    Service_Ctrl_ex = Proc.new do |dwCtrlCode, dwEventType, lpEventData, lpContext|
+      @@waiting_control_code = dwCtrlCode;
+      return_value = NO_ERROR
+
+      begin
+        dwState = SERVICE_RUNNING
+
+        case dwCtrlCode
+          when SERVICE_CONTROL_STOP
+            dwState = SERVICE_STOP_PENDING
+          when SERVICE_CONTROL_SHUTDOWN
+            dwState = SERVICE_STOP_PENDING
+          when SERVICE_CONTROL_PAUSE
+            dwState = SERVICE_PAUSED
+          when SERVICE_CONTROL_CONTINUE
+            dwState = SERVICE_RUNNING
+          #else
+            # TODO: Handle other control codes? Retain the current state?
+        end
+
+        # Set the status of the service except on interrogation.
+        unless dwCtrlCode == SERVICE_CONTROL_INTERROGATE
+          SetTheServiceStatus.call(dwState, NO_ERROR, 0, 0)
+        end
+
+        # Tell service_main thread to stop.
+        if dwCtrlCode == SERVICE_CONTROL_STOP || dwCtrlCode == SERVICE_CONTROL_SHUTDOWN
+          if SetEvent(@@hStopEvent) == 0
+            SetTheServiceStatus.call(SERVICE_STOPPED, FFI.errno, 0, 0)
+          end
+        end
+      rescue
+        return_value = ERROR_CALL_NOT_IMPLEMENTED
+      end
+
+      return_value
+    end
+
+    # Called by the service control manager after the call to StartServiceCtrlDispatcher.
+    Service_Main = FFI::Function.new(:void, [:ulong, :pointer], :blocking => false) do |dwArgc, lpszArgv|
+      begin
+        # Obtain the name of the service.
+        if lpszArgv.address != 0
+          argv = lpszArgv.get_array_of_string(0, dwArgc)
+          lpszServiceName = argv[0]
+        else
+          lpszServiceName = ''
+        end
+
+        # Args passed to Service.start
+        if(dwArgc > 1)
+          @@Argv = argv[1..-1]
+        else
+          @@Argv = nil
+        end
+
+        # Register the service ctrl handler.
+        @@ssh = RegisterServiceCtrlHandlerExW(
+          lpszServiceName,
+          Service_Ctrl_ex,
+          nil
+        )
+
+        # No service to stop, no service handle to notify, nothing to do but exit.
+        break if @@ssh == 0
+
+        # The service has started.
+        SetTheServiceStatus.call(SERVICE_RUNNING, NO_ERROR, 0, 0)
+
+        SetEvent(@@hStartEvent)
+
+        # Main loop for the service.
+        while(WaitForSingleObject(@@hStopEvent, 1000) != WAIT_OBJECT_0) do
+        end
+
+        # Main loop for the service.
+        while(WaitForSingleObject(@@hStopCompletedEvent, 1000) != WAIT_OBJECT_0) do
+        end
+      ensure
+        # Stop the service.
+        SetTheServiceStatus.call(SERVICE_STOPPED, NO_ERROR, 0, 0)
+      end
+    end
+
+    ThreadProc = FFI::Function.new(:ulong,[:pointer]) do |lpParameter|
+      ste = FFI::MemoryPointer.new(SERVICE_TABLE_ENTRYW, 2)
+
+      s = SERVICE_TABLE_ENTRYW.new(ste[0])
+      s[:lpServiceName] = FFI::MemoryPointer.from_string('')
+      s[:lpServiceProc] = lpParameter
+
+      s = SERVICE_TABLE_ENTRYW.new(ste[1])
+      s[:lpServiceName] = nil
+      s[:lpServiceProc] = nil
+
+      # No service to step, no service handle, no ruby exceptions, just terminate the thread..
+      if !StartServiceCtrlDispatcherW(ste)
+        return 1
+      end
+
+      return 0
+    end
+
+    # This is a shortcut for Daemon.new + Daemon#mainloop.
+    #
+    def self.mainloop
+      self.new.mainloop
+    end
+
+    # This is the method that actually puts your code into a loop and allows it
+    # to run as a service.  The code that is actually run while in the mainloop
+    # is what you defined in your own Daemon#service_main method.
+    #
+    def mainloop
+      @@waiting_control_code = IDLE_CONTROL_CODE
+      @@dwServiceState = 0
+
+      # Redirect STDIN, STDOUT and STDERR to the NUL device if they're still
+      # associated with a tty. This helps newbs avoid Errno::EBADF errors.
+      STDIN.reopen('NUL') if STDIN.isatty
+      STDOUT.reopen('NUL') if STDOUT.isatty
+      STDERR.reopen('NUL') if STDERR.isatty
+
+      # Calling init here so that init failures never even tries to start the
+      # service. Of course that means that init methods must be very quick
+      # because the SCM will be receiving no START_PENDING messages while
+      # init's running.
+      #
+      # TODO: Fix?
+      service_init() if respond_to?('service_init')
+
+      # Create the event to signal the service to start.
+      @@hStartEvent = CreateEventW(nil, 1, 0, nil)
+
+      if @@hStartEvent == 0
+        raise SystemCallError.new('CreateEvent', FFI.errno)
+      end
+
+      # Create the event to signal the service to stop.
+      @@hStopEvent = CreateEventW(nil, 1, 0, nil)
+
+      if @@hStopEvent == 0
+        raise SystemCallError.new('CreateEvent', FFI.errno)
+      end
+
+      # Create the event to signal the service that stop has completed
+      @@hStopCompletedEvent = CreateEventW(nil, 1, 0, nil)
+
+      if @@hStopCompletedEvent == 0
+        raise SystemCallError.new('CreateEvent', FFI.errno)
+      end
+
+      hThread = CreateThread(nil, 0, ThreadProc, Service_Main, 0, nil)
+
+      if hThread == 0
+        raise SystemCallError.new('CreateThread', FFI.errno)
+      end
+
+      events = FFI::MemoryPointer.new(:pointer, 2)
+      events.put_pointer(0, FFI::Pointer.new(hThread))
+      events.put_pointer(FFI::Pointer.size, FFI::Pointer.new(@@hStartEvent))
+
+      while ((index = WaitForMultipleObjects(2, events, 0, 1000)) == WAIT_TIMEOUT) do
+      end
+
+      if index == WAIT_FAILED
+        raise SystemCallError.new('WaitForMultipleObjects', FFI.errno)
+      end
+
+      # The thread exited, so the show is off.
+      if index == WAIT_OBJECT_0
+        raise "Service_Main thread exited abnormally"
+      end
+
+      thr = Thread.new do
+        begin
+          while(WaitForSingleObject(@@hStopEvent, 1000) == WAIT_TIMEOUT)
+            # Check to see if anything interesting has been signaled
+            case @@waiting_control_code
+              when SERVICE_CONTROL_PAUSE
+                service_pause() if respond_to?('service_pause')
+              when SERVICE_CONTROL_CONTINUE
+                service_resume() if respond_to?('service_resume')
+              when SERVICE_CONTROL_INTERROGATE
+                service_interrogate() if respond_to?('service_interrogate')
+              when SERVICE_CONTROL_SHUTDOWN
+                service_shutdown() if respond_to?('service_shutdown')
+              when SERVICE_CONTROL_PARAMCHANGE
+                service_paramchange() if respond_to?('service_paramchange')
+              when SERVICE_CONTROL_NETBINDADD
+                service_netbindadd() if respond_to?('service_netbindadd')
+              when SERVICE_CONTROL_NETBINDREMOVE
+                service_netbindremove() if respond_to?('service_netbindremove')
+              when SERVICE_CONTROL_NETBINDENABLE
+                service_netbindenable() if respond_to?('service_netbindenable')
+              when SERVICE_CONTROL_NETBINDDISABLE
+                service_netbinddisable() if respond_to?('service_netbinddisable')
+            end
+            @@waiting_control_code = IDLE_CONTROL_CODE
+          end
+
+          service_stop() if respond_to?('service_stop')
+        ensure
+          SetEvent(@@hStopCompletedEvent)
+        end
+      end
+
+      if respond_to?('service_main')
+        service_main(*@@Argv)
+      end
+
+      thr.join
+    end
+
+    # Returns the state of the service (as an constant integer) which can be any
+    # of the service status constants, e.g. RUNNING, PAUSED, etc.
+    #
+    # This method is typically used within your service_main method to setup the
+    # loop. For example:
+    #
+    #   class MyDaemon < Daemon
+    #     def service_main
+    #       while state == RUNNING || state == PAUSED || state == IDLE
+    #         # Your main loop here
+    #       end
+    #     end
+    #   end
+    #
+    # See the Daemon#running? method for an abstraction of the above code.
+    #
+    def state
+      @@dwServiceState
+    end
+
+    #
+    # Returns whether or not the service is in a running state, i.e. the service
+    # status is either RUNNING, PAUSED or IDLE.
+    #
+    # This is typically used within your service_main method to setup the main
+    # loop. For example:
+    #
+    #    class MyDaemon < Daemon
+    #       def service_main
+    #          while running?
+    #             # Your main loop here
+    #          end
+    #       end
+    #    end
+    #
+    def running?
+      [SERVICE_RUNNING, SERVICE_PAUSED, 0].include?(@@dwServiceState)
+    end
+  end
+end

data/lib/puppet/util/windows/error.rb

@@ -1,4 +1,5 @@
 require 'puppet/util/windows'
+require 'puppet/error'
 
 # represents an error resulting from a Win32 error code
 class Puppet::Util::Windows::Error < Puppet::Error

data/lib/puppet/util/windows/eventlog.rb

@@ -46,8 +46,8 @@ class Puppet::Util::Windows::EventLog
   end
 
   # Report an event to this instance's event log handle. Accepts a string to
-  #   report (:data => <string>) and event type (:event_type => FixNum) and id
-  # (:event_id => FixNum) as returned by #to_native. The additional arguments to
+  #   report (:data => <string>) and event type (:event_type => Integer) and id
+  # (:event_id => Integer) as returned by #to_native. The additional arguments to
   # ReportEventW seen in this method aren't exposed - though ReportEventW
   # technically can accept multiple strings as well as raw binary data to log,
   # we accept a single string from Puppet::Util::Log
@@ -126,13 +126,8 @@ class Puppet::Util::Windows::EventLog
   def wide_string(str)
     # if given a nil string, assume caller wants to pass a nil pointer to win32
     return nil if str.nil?
-    # ruby (< 2.1) does not respect multibyte terminators, so it is possible
-    # for a string to contain a single trailing null byte, followed by garbage
-    # causing buffer overruns.
-    #
-    # See http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?revision=41920&view=revision
-    newstr = str + "\0".encode(str.encoding)
-    newstr.encode!('UTF-16LE')
+
+    str.encode('UTF-16LE')
   end
 
   # Private duplicate of Puppet::Util::Windows::ApiTypes::from_string_to_wide_string

data/lib/puppet/util/windows/file.rb

@@ -1,74 +1,15 @@
-require 'puppet/util/windows'
+require 'puppet/ffi/windows'
 
 module Puppet::Util::Windows::File
-  require 'ffi'
-  extend FFI::Library
   extend Puppet::Util::Windows::String
 
-  FILE_ATTRIBUTE_READONLY      = 0x00000001
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa379607(v=vs.85).aspx
-  # The right to use the object for synchronization. This enables a thread to
-  # wait until the object is in the signaled state. Some object types do not
-  # support this access right.
-  SYNCHRONIZE                 = 0x100000
-  # The right to delete the object.
-  DELETE                      = 0x00010000
-  # The right to read the information in the object's security descriptor, not including the information in the system access control list (SACL).
-  # READ_CONTROL              = 0x00020000
-  # The right to modify the discretionary access control list (DACL) in the object's security descriptor.
-  WRITE_DAC                   = 0x00040000
-  # The right to change the owner in the object's security descriptor.
-  WRITE_OWNER                 = 0x00080000
-
-  # Combines DELETE, READ_CONTROL, WRITE_DAC, and WRITE_OWNER access.
-  STANDARD_RIGHTS_REQUIRED    = 0xf0000
-  # Currently defined to equal READ_CONTROL.
-  STANDARD_RIGHTS_READ        = 0x20000
-  # Currently defined to equal READ_CONTROL.
-  STANDARD_RIGHTS_WRITE       = 0x20000
-  # Currently defined to equal READ_CONTROL.
-  STANDARD_RIGHTS_EXECUTE     = 0x20000
-  # Combines DELETE, READ_CONTROL, WRITE_DAC, WRITE_OWNER, and SYNCHRONIZE access.
-  STANDARD_RIGHTS_ALL         = 0x1F0000
-  SPECIFIC_RIGHTS_ALL         = 0xFFFF
-
-  FILE_READ_DATA               = 1
-  FILE_WRITE_DATA              = 2
-  FILE_APPEND_DATA             = 4
-  FILE_READ_EA                 = 8
-  FILE_WRITE_EA                = 16
-  FILE_EXECUTE                 = 32
-  FILE_DELETE_CHILD            = 64
-  FILE_READ_ATTRIBUTES         = 128
-  FILE_WRITE_ATTRIBUTES        = 256
-
-  FILE_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0x1FF
-
-  FILE_GENERIC_READ =
-     STANDARD_RIGHTS_READ |
-     FILE_READ_DATA |
-     FILE_READ_ATTRIBUTES |
-     FILE_READ_EA |
-     SYNCHRONIZE
-
-  FILE_GENERIC_WRITE =
-     STANDARD_RIGHTS_WRITE |
-     FILE_WRITE_DATA |
-     FILE_WRITE_ATTRIBUTES |
-     FILE_WRITE_EA |
-     FILE_APPEND_DATA |
-     SYNCHRONIZE
-
-  FILE_GENERIC_EXECUTE =
-     STANDARD_RIGHTS_EXECUTE |
-     FILE_READ_ATTRIBUTES |
-     FILE_EXECUTE |
-     SYNCHRONIZE
-
-  REPLACEFILE_WRITE_THROUGH         = 0x1
-  REPLACEFILE_IGNORE_MERGE_ERRORS   = 0x2
-  REPLACEFILE_IGNORE_ACL_ERRORS     = 0x3
+  include Puppet::FFI::Windows::Constants
+
+  extend Puppet::FFI::Windows::Structs
+  include Puppet::FFI::Windows::Structs
+
+  include Puppet::FFI::Windows::Functions
+  extend Puppet::FFI::Windows::Functions
 
   def replace_file(target, source)
     target_encoded = wide_string(target.to_s)
@@ -111,7 +52,6 @@ module Puppet::Util::Windows::File
   end
   module_function :symlink
 
-
   def exist?(path)
     path = path.to_str if path.respond_to?(:to_str) # support WatchedFile
     path = path.to_s # support String and Pathname
@@ -144,9 +84,6 @@ module Puppet::Util::Windows::File
   end
   module_function :exist?
 
-
-  INVALID_FILE_ATTRIBUTES = 0xFFFFFFFF #define INVALID_FILE_ATTRIBUTES (DWORD (-1))
-
   def get_attributes(file_name, raise_on_invalid = true)
     result = GetFileAttributesW(wide_string(file_name.to_s))
     if raise_on_invalid && result == INVALID_FILE_ATTRIBUTES
@@ -199,18 +136,6 @@ module Puppet::Util::Windows::File
         "#{flags_and_attributes.to_s(8)}, #{template_file_handle})")
   end
 
-  IO_REPARSE_TAG_MOUNT_POINT  = 0xA0000003
-  IO_REPARSE_TAG_HSM          = 0xC0000004
-  IO_REPARSE_TAG_HSM2         = 0x80000006
-  IO_REPARSE_TAG_SIS          = 0x80000007
-  IO_REPARSE_TAG_WIM          = 0x80000008
-  IO_REPARSE_TAG_CSV          = 0x80000009
-  IO_REPARSE_TAG_DFS          = 0x8000000A
-  IO_REPARSE_TAG_SYMLINK      = 0xA000000C
-  IO_REPARSE_TAG_DFSR         = 0x80000012
-  IO_REPARSE_TAG_DEDUP        = 0x80000013
-  IO_REPARSE_TAG_NFS          = 0x80000014
-
   def self.get_reparse_point_data(handle, &block)
     # must be multiple of 1024, min 10240
     FFI::MemoryPointer.new(MAXIMUM_REPARSE_DATA_BUFFER_SIZE) do |reparse_data_buffer_ptr|
@@ -276,7 +201,6 @@ module Puppet::Util::Windows::File
     out_buffer
   end
 
-  FILE_ATTRIBUTE_REPARSE_POINT = 0x400
   def reparse_point?(file_name)
     attributes = get_attributes(file_name, false)
 
@@ -291,16 +215,6 @@ module Puppet::Util::Windows::File
   end
   module_function :symlink?
 
-  GENERIC_READ                  = 0x80000000
-  GENERIC_WRITE                 = 0x40000000
-  GENERIC_EXECUTE               = 0x20000000
-  GENERIC_ALL                   = 0x10000000
-  FILE_SHARE_READ               = 1
-  FILE_SHARE_WRITE              = 2
-  OPEN_EXISTING                 = 3
-  FILE_FLAG_OPEN_REPARSE_POINT  = 0x00200000
-  FILE_FLAG_BACKUP_SEMANTICS    = 0x02000000
-
   def self.open_symlink(link_name)
     begin
       yield handle = create_file(
@@ -329,9 +243,6 @@ module Puppet::Util::Windows::File
   end
   module_function :readlink
 
-  ERROR_FILE_NOT_FOUND = 2
-  ERROR_PATH_NOT_FOUND = 3
-
   def get_long_pathname(path)
     converted = ''
     FFI::Pointer.from_string_to_wide_string(path) do |path_ptr|
@@ -411,9 +322,6 @@ module Puppet::Util::Windows::File
   end
   module_function :lstat
 
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364571(v=vs.85).aspx
-  FSCTL_GET_REPARSE_POINT = 0x900a8
-
   def self.resolve_symlink(handle)
     path = nil
     get_reparse_point_data(handle) do |reparse_data|
@@ -444,146 +352,4 @@ module Puppet::Util::Windows::File
     symlink
   end
   private_class_method :symlink_reparse_point?
-
-  ffi_convention :stdcall
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa365512(v=vs.85).aspx
-  # BOOL WINAPI ReplaceFile(
-  #   _In_        LPCTSTR lpReplacedFileName,
-  #   _In_        LPCTSTR lpReplacementFileName,
-  #   _In_opt_    LPCTSTR lpBackupFileName,
-  #   _In_        DWORD dwReplaceFlags - 0x1 REPLACEFILE_WRITE_THROUGH,
-  #                                      0x2 REPLACEFILE_IGNORE_MERGE_ERRORS,
-  #                                      0x4 REPLACEFILE_IGNORE_ACL_ERRORS
-  #   _Reserved_  LPVOID lpExclude,
-  #   _Reserved_  LPVOID lpReserved
-  # );
-  ffi_lib :kernel32
-  attach_function_private :ReplaceFileW,
-    [:lpcwstr, :lpcwstr, :lpcwstr, :dword, :lpvoid, :lpvoid], :win32_bool
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa365240(v=vs.85).aspx
-  # BOOL WINAPI MoveFileEx(
-  #   _In_      LPCTSTR lpExistingFileName,
-  #   _In_opt_  LPCTSTR lpNewFileName,
-  #   _In_      DWORD dwFlags
-  # );
-  ffi_lib :kernel32
-  attach_function_private :MoveFileExW,
-    [:lpcwstr, :lpcwstr, :dword], :win32_bool
-
-  # BOOLEAN WINAPI CreateSymbolicLink(
-  #   _In_  LPTSTR lpSymlinkFileName, - symbolic link to be created
-  #   _In_  LPTSTR lpTargetFileName, - name of target for symbolic link
-  #   _In_  DWORD dwFlags - 0x0 target is a file, 0x1 target is a directory
-  # );
-  # rescue on Windows < 6.0 so that code doesn't explode
-  begin
-    ffi_lib :kernel32
-    attach_function_private :CreateSymbolicLinkW,
-      [:lpwstr, :lpwstr, :dword], :boolean
-  rescue LoadError
-  end
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364944(v=vs.85).aspx
-  # DWORD WINAPI GetFileAttributes(
-  #   _In_  LPCTSTR lpFileName
-  # );
-  ffi_lib :kernel32
-  attach_function_private :GetFileAttributesW,
-    [:lpcwstr], :dword
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa365535(v=vs.85).aspx
-  # BOOL WINAPI SetFileAttributes(
-  #   _In_  LPCTSTR lpFileName,
-  #   _In_  DWORD dwFileAttributes
-  # );
-  ffi_lib :kernel32
-  attach_function_private :SetFileAttributesW,
-    [:lpcwstr, :dword], :win32_bool
-
-  # HANDLE WINAPI CreateFile(
-  #   _In_      LPCTSTR lpFileName,
-  #   _In_      DWORD dwDesiredAccess,
-  #   _In_      DWORD dwShareMode,
-  #   _In_opt_  LPSECURITY_ATTRIBUTES lpSecurityAttributes,
-  #   _In_      DWORD dwCreationDisposition,
-  #   _In_      DWORD dwFlagsAndAttributes,
-  #   _In_opt_  HANDLE hTemplateFile
-  # );
-  ffi_lib :kernel32
-  attach_function_private :CreateFileW,
-    [:lpcwstr, :dword, :dword, :pointer, :dword, :dword, :handle], :handle
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa363216(v=vs.85).aspx
-  # BOOL WINAPI DeviceIoControl(
-  #   _In_         HANDLE hDevice,
-  #   _In_         DWORD dwIoControlCode,
-  #   _In_opt_     LPVOID lpInBuffer,
-  #   _In_         DWORD nInBufferSize,
-  #   _Out_opt_    LPVOID lpOutBuffer,
-  #   _In_         DWORD nOutBufferSize,
-  #   _Out_opt_    LPDWORD lpBytesReturned,
-  #   _Inout_opt_  LPOVERLAPPED lpOverlapped
-  # );
-  ffi_lib :kernel32
-  attach_function_private :DeviceIoControl,
-    [:handle, :dword, :lpvoid, :dword, :lpvoid, :dword, :lpdword, :pointer], :win32_bool
-
-  MAXIMUM_REPARSE_DATA_BUFFER_SIZE = 16384
-
-  # SYMLINK_REPARSE_DATA_BUFFER
-  # https://msdn.microsoft.com/en-us/library/cc232006.aspx
-  # https://msdn.microsoft.com/en-us/library/windows/hardware/ff552012(v=vs.85).aspx
-  # struct is always MAXIMUM_REPARSE_DATA_BUFFER_SIZE bytes
-  class SYMLINK_REPARSE_DATA_BUFFER < FFI::Struct
-    layout :ReparseTag, :win32_ulong,
-           :ReparseDataLength, :ushort,
-           :Reserved, :ushort,
-           :SubstituteNameOffset, :ushort,
-           :SubstituteNameLength, :ushort,
-           :PrintNameOffset, :ushort,
-           :PrintNameLength, :ushort,
-           :Flags, :win32_ulong,
-           # max less above fields dword / uint 4 bytes, ushort 2 bytes
-           # technically a WCHAR buffer, but we care about size in bytes here
-           :PathBuffer, [:byte, MAXIMUM_REPARSE_DATA_BUFFER_SIZE - 20]
-  end
-
-  # MOUNT_POINT_REPARSE_DATA_BUFFER
-  # https://msdn.microsoft.com/en-us/library/cc232007.aspx
-  # https://msdn.microsoft.com/en-us/library/windows/hardware/ff552012(v=vs.85).aspx
-  # struct is always MAXIMUM_REPARSE_DATA_BUFFER_SIZE bytes
-  class MOUNT_POINT_REPARSE_DATA_BUFFER < FFI::Struct
-    layout :ReparseTag, :win32_ulong,
-           :ReparseDataLength, :ushort,
-           :Reserved, :ushort,
-           :SubstituteNameOffset, :ushort,
-           :SubstituteNameLength, :ushort,
-           :PrintNameOffset, :ushort,
-           :PrintNameLength, :ushort,
-           # max less above fields dword / uint 4 bytes, ushort 2 bytes
-           # technically a WCHAR buffer, but we care about size in bytes here
-           :PathBuffer, [:byte, MAXIMUM_REPARSE_DATA_BUFFER_SIZE - 16]
-  end
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364980(v=vs.85).aspx
-  # DWORD WINAPI GetLongPathName(
-  #   _In_  LPCTSTR lpszShortPath,
-  #   _Out_ LPTSTR  lpszLongPath,
-  #   _In_  DWORD   cchBuffer
-  # );
-  ffi_lib :kernel32
-  attach_function_private :GetLongPathNameW,
-    [:lpcwstr, :lpwstr, :dword], :dword
-
-  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa364989(v=vs.85).aspx
-  # DWORD WINAPI GetShortPathName(
-  #   _In_  LPCTSTR lpszLongPath,
-  #   _Out_ LPTSTR  lpszShortPath,
-  #   _In_  DWORD   cchBuffer
-  # );
-  ffi_lib :kernel32
-  attach_function_private :GetShortPathNameW,
-    [:lpcwstr, :lpwstr, :dword], :dword
 end