Move syscalls into Syscalls.swift

Author: rauhul

Sources/System/FileStatus/FileStatus.swift

@@ -8,6 +8,7 @@
 */
 
 #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
+import Darwin
 
 // FIXME: Document
 @frozen

Sources/System/FileStatus/FileStatusOperations.swift

@@ -31,6 +31,21 @@ extension FileDescriptor {
 
 // @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
 extension FilePath {
+  /// Obtain information about the file pointed to by the FilePath.
+  ///
+  /// - Parameters:
+  ///   - followSymlinks: Whether to follow symlinks.
+  ///     The default is `true`.
+  ///   - retryOnInterrupt: Whether to retry the read operation
+  ///     if it throws ``Errno/interrupted``.
+  ///     The default is `true`.
+  ///     Pass `false` to try only once and throw an error upon interruption.
+  /// - Returns: A `FileStatus` for the file pointed to by FilePath.
+  ///
+  /// Read, write or execute permission of the pointed to file is not required,
+  /// but all intermediate directories must be searchable.
+  ///
+  /// The corresponding C functions are `stat` and `lstat`.
   @_alwaysEmitIntoClient
   public func stat(
     followSymlinks: Bool = true,
@@ -48,7 +63,7 @@ extension FilePath {
     retryOnInterrupt: Bool
   ) -> Result<FileStatus, Errno> {
     var result = CInterop.Stat()
-    let _stat = followSymlinks ? SystemPackage._stat : _lstat
+    let _stat = followSymlinks ? system_stat : system_lstat
     return  withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
         _stat(ptr, &result)
@@ -67,7 +82,7 @@ extension FileDescriptor {
   internal func fstat(retryOnInterrupt: Bool = true) throws -> FileStatus {
     var result = CInterop.Stat()
     try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-      _fstat(self.rawValue, &result)
+      system_fstat(self.rawValue, &result)
     }.get()
     return FileStatus(rawValue: result)
   }
@@ -76,7 +91,7 @@ extension FileDescriptor {
     var result = CInterop.Stat()
     try path.withPlatformString { ptr in
       try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        _fstatat(self.rawValue, ptr, &result, fcntrl.rawValue)
+        system_fstatat(self.rawValue, ptr, &result, fcntrl.rawValue)
       }.get()
     }
     return FileStatus(rawValue: result)
@@ -113,7 +128,7 @@ extension FilePath {
     followSymlinks: Bool,
     retryOnInterrupt: Bool
   ) -> Result<Void, Errno> {
-    let _chmod = followSymlinks ? SystemPackage._chmod : _lchmod
+    let _chmod = followSymlinks ? system_chmod : system_lchmod
     return withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
         _chmod(ptr, permissions.rawValue)
@@ -126,15 +141,15 @@ extension FilePath {
 extension FileDescriptor {
   internal func fchmod(permissions: FilePermissions, retryOnInterrupt: Bool = true) throws {
     try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-      _fchmod(self.rawValue, permissions.rawValue)
+      system_fchmod(self.rawValue, permissions.rawValue)
     }.get()
   }
 
   // valid flags: AT_SYMLINK_NOFOLLOW | AT_REALDEV | AT_FDONLY
   internal func fchmodat(path: FilePath, permissions: FilePermissions, fcntrl: FileDescriptor.ControlFlags, retryOnInterrupt: Bool = true) throws {
     try path.withPlatformString { ptr in
       try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        _fchmodat(self.rawValue, ptr, permissions.rawValue, fcntrl.rawValue)
+        system_fchmodat(self.rawValue, ptr, permissions.rawValue, fcntrl.rawValue)
       }.get()
     }
   }
@@ -171,7 +186,7 @@ extension FilePath {
     followSymlinks: Bool,
     retryOnInterrupt: Bool
   ) -> Result<Void, Errno> {
-    let _chown = followSymlinks ? SystemPackage._chown : _lchown
+    let _chown = followSymlinks ? system_chown : system_lchown
     return withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
         _chown(ptr, userId, groupId)
@@ -184,14 +199,14 @@ extension FilePath {
 extension FileDescriptor {
   internal func fchown(userId: CInterop.UserId, groupId: CInterop.GroupId, retryOnInterrupt: Bool = true) throws {
     try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-      _fchown(self.rawValue, userId, groupId)
+      system_fchown(self.rawValue, userId, groupId)
     }.get()
   }
 
   internal func fchownat(path: FilePath, userId: CInterop.UserId, groupId: CInterop.GroupId, fcntrl: FileDescriptor.ControlFlags, retryOnInterrupt: Bool = true) throws {
     try path.withPlatformString { ptr in
       try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        _fchownat(self.rawValue, ptr, userId, groupId, fcntrl.rawValue)
+        system_fchownat(self.rawValue, ptr, userId, groupId, fcntrl.rawValue)
       }.get()
     }
   }
@@ -225,7 +240,7 @@ extension FilePath {
     followSymlinks: Bool,
     retryOnInterrupt: Bool
   ) -> Result<Void, Errno> {
-    let _chflags = followSymlinks ? SystemPackage._chflags : _lchflags
+    let _chflags = followSymlinks ? system_chflags : system_lchflags
     return withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
         _chflags(ptr, flags.rawValue)
@@ -238,15 +253,15 @@ extension FilePath {
 extension FileDescriptor {
   internal func fchflags(flags: FileFlags, retryOnInterrupt: Bool = true) throws {
     try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-      _fchflags(self.rawValue, flags.rawValue)
+      system_fchflags(self.rawValue, flags.rawValue)
     }.get()
   }
 
 #if os(FreeBSD)
   internal func chflagsat(path: FilePath, flags: FileFlags, fcntrl: FileDescriptorControlFlags, retryOnInterrupt: Bool = true) throws {
     try path.withPlatformString { ptr in
       try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        _chflagsat(self.rawValue, ptr, flags.rawValue, fcntrl.rawValue)
+        system_chflagsat(self.rawValue, ptr, flags.rawValue, fcntrl.rawValue)
       }.get()
     }
   }
@@ -255,23 +270,22 @@ extension FileDescriptor {
 
 // MARK: - umask
 
-// FIXME: document, shape
-/// The umask() routine sets the process's file mode creation mask to cmask and
-/// returns the previous value of the mask.  The 9 low-order access permission
-/// bits of cmask are used by system calls, including open(2), mkdir(2),
-/// mkfifo(2), and mknod(2) to turn off corresponding bits requested in file
-/// mode.  (See chmod(2)).  This clearing allows each user to restrict the
-/// default access to his files.
+// FIXME: umask document, shape
+/// The umask() routine sets the process's file mode creation mask to newMask
+/// and returns the previous value of the mask. The bits of newMask are used by
+/// system calls, including open(2), mkdir(2), mkfifo(2), and mknod(2) to turn
+/// off corresponding bits requested in file mode. (See chmod(2)). This clearing
+/// allows each user to restrict the default access to their files.
 ///
 /// The default mask value is `S_IWGRP` | `S_IWOTH` (022, write access for the
-/// owner only).  Child processes inherit the mask of the calling process.
-@_alwaysEmitIntoClient
-public func umask(newMask: FilePermissions) -> FilePermissions {
-  let mode = _umask(newMask.rawValue)
-  return FileMode(rawValue: mode).permissions
-}
+/// owner only). Child processes inherit the mask of the calling process.
+// @_alwaysEmitIntoClient
+// public func umask(newMask: FilePermissions) -> FilePermissions {
+//   let oldMode = system_umask(newMask.rawValue)
+//   return FileMode(rawValue: oldMode).permissions
+// }
 
-// [ ] mode_t umask(mode_t)
+// [x] mode_t umask(mode_t)
 
 // MARK: - mkfifo, mknod, mkdir
 
@@ -300,7 +314,7 @@ extension FilePath {
   ) -> Result<Void, Errno> {
     withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        SystemPackage._mkfifo(ptr, permissions.rawValue)
+        system_mkfifo(ptr, permissions.rawValue)
       }
     }
   }
@@ -326,7 +340,7 @@ extension FilePath {
   ) -> Result<Void, Errno> {
     withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        SystemPackage._mknod(ptr, permissions.rawValue, device)
+        system_mknod(ptr, permissions.rawValue, device)
       }
     }
   }
@@ -349,7 +363,7 @@ extension FilePath {
   ) -> Result<Void, Errno> {
     withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        SystemPackage._mkdir(ptr, permissions.rawValue)
+        system_mkdir(ptr, permissions.rawValue)
       }
     }
   }
@@ -359,7 +373,7 @@ extension FileDescriptor {
   internal func mkdirat(path: FilePath, permissions: FilePermissions, retryOnInterrupt: Bool = true) throws {
     try path.withPlatformString { ptr in
       try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        _mkdirat(self.rawValue, ptr, permissions.rawValue)
+        system_mkdirat(self.rawValue, ptr, permissions.rawValue)
       }.get()
     }
   }
@@ -376,7 +390,7 @@ extension FileDescriptor {
   internal func futimens(accessTime: TimeSpecification, modificationTime: TimeSpecification, retryOnInterrupt: Bool = true) throws {
     let times = [accessTime.rawValue, modificationTime.rawValue]
     try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-      _futimens(self.rawValue, times)
+      system_futimens(self.rawValue, times)
     }.get()
   }
 
@@ -385,7 +399,7 @@ extension FileDescriptor {
     let times = [accessTime.rawValue, modificationTime.rawValue]
     try path.withPlatformString { ptr in
       try nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        _utimensat(self.rawValue, ptr, times, fcntrl.rawValue)
+        system_utimensat(self.rawValue, ptr, times, fcntrl.rawValue)
       }.get()
     }
   }

Sources/System/Internals/Constants.swift

@@ -638,100 +638,3 @@ internal var _UTIME_NOW: Int { Int(UTIME_NOW) }
 @_alwaysEmitIntoClient
 internal var _UTIME_OMIT: Int { Int(UTIME_OMIT) }
 #endif
-
-// MARK: - Stat.h Functions
-#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-@_alwaysEmitIntoClient
-internal let _stat = stat
-
-@_alwaysEmitIntoClient
-internal let _lstat = lstat
-
-@_alwaysEmitIntoClient
-internal let _fstat = fstat
-
-@_alwaysEmitIntoClient
-internal let _fstatat = fstatat
-
-@_alwaysEmitIntoClient
-internal let _statx_np = statx_np
-
-@_alwaysEmitIntoClient
-internal let _fstatx_np = fstatx_np
-
-@_alwaysEmitIntoClient
-internal let _lstatx_np = lstatx_np
-
-@_alwaysEmitIntoClient
-internal let _chmod = chmod
-
-@_alwaysEmitIntoClient
-internal let _lchmod = lchmod
-
-@_alwaysEmitIntoClient
-internal let _fchmod = fchmod
-
-@_alwaysEmitIntoClient
-internal let _fchmodat = fchmodat
-
-@_alwaysEmitIntoClient
-internal let _chmodx_np = chmodx_np
-
-@_alwaysEmitIntoClient
-internal let _fchmodx_np = fchmodx_np
-
-@_alwaysEmitIntoClient
-internal let _chown = chown
-
-@_alwaysEmitIntoClient
-internal let _lchown = lchown
-
-@_alwaysEmitIntoClient
-internal let _fchown = fchown
-
-@_alwaysEmitIntoClient
-internal let _fchownat = fchownat
-
-@_alwaysEmitIntoClient
-internal let _chflags = chflags
-
-@_alwaysEmitIntoClient
-internal let _lchflags = lchflags
-
-@_alwaysEmitIntoClient
-internal let _fchflags = fchflags
-
-#if os(FreeBSD)
-@_alwaysEmitIntoClient
-internal let _fchflagsat = fchflagsat
-#endif
-
-@_alwaysEmitIntoClient
-internal let _umask = Darwin.umask
-
-@_alwaysEmitIntoClient
-internal let _mkfifo = mkfifo
-
-@_alwaysEmitIntoClient
-internal let _mkfifox_np = mkfifox_np
-
-@_alwaysEmitIntoClient
-internal let _mknod = mknod
-
-@_alwaysEmitIntoClient
-internal let _mkdir = mkdir
-
-@_alwaysEmitIntoClient
-internal let _mkdirat = mkdirat
-
-@_alwaysEmitIntoClient
-internal let _mkdirx_np = mkdirx_np
-
-@available(macOS 10.13, *)
-@_alwaysEmitIntoClient
-internal let _futimens = futimens
-
-@available(macOS 10.13, *)
-@_alwaysEmitIntoClient
-internal let _utimensat = utimensat
-#endif

Sources/System/Internals/Mocking.swift

@@ -192,6 +192,13 @@ internal func _mockOffT(
 ) -> _COffT {
   _COffT(mockImpl(name: name, path: path, args))
 }
+
+internal func _mockModeT(
+  name: String = #function, _ args: AnyHashable...
+) -> CInterop.Mode {
+  CInterop.Mode(mockImpl(name: name, path: nil, args))
+}
+
 #endif // ENABLE_MOCKING
 
 // Force paths to be treated as Windows syntactically if `enabled` is