1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2023 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
#if os(macOS) || os(iOS) || os(tvOS) || os(watchOS) || os(Linux) || os(Android)
import SystemPackage
#if canImport(Darwin)
import Darwin
import CNIODarwin
#elseif canImport(Glibc)
import Glibc
import CNIOLinux
#elseif canImport(Musl)
import Musl
import CNIOLinux
#endif
@_spi(Testing)
public enum Syscall {
@_spi(Testing)
public static func stat(path: FilePath) -> Result<CInterop.Stat, Errno> {
return path.withPlatformString { platformPath in
var status = CInterop.Stat()
return valueOrErrno(retryOnInterrupt: false) {
system_stat(platformPath, &status)
}.map { _ in
status
}
}
}
@_spi(Testing)
public static func lstat(path: FilePath) -> Result<CInterop.Stat, Errno> {
return path.withPlatformString { platformPath in
var status = CInterop.Stat()
return valueOrErrno(retryOnInterrupt: false) {
system_lstat(platformPath, &status)
}.map { _ in
status
}
}
}
@_spi(Testing)
public static func mkdir(at path: FilePath, permissions: FilePermissions) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
path.withPlatformString { p in
system_mkdir(p, permissions.rawValue)
}
}
}
@_spi(Testing)
public static func rename(from old: FilePath, to new: FilePath) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
old.withPlatformString { oldPath in
new.withPlatformString { newPath in
system_rename(oldPath, newPath)
}
}
}
}
#if canImport(Darwin)
@_spi(Testing)
public static func rename(
from old: FilePath,
to new: FilePath,
options: RenameOptions
) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
old.withPlatformString { oldPath in
new.withPlatformString { newPath in
system_renamex_np(oldPath, newPath, options.rawValue)
}
}
}
}
@_spi(Testing)
public struct RenameOptions: OptionSet {
public var rawValue: CUnsignedInt
public init(rawValue: CUnsignedInt) {
self.rawValue = rawValue
}
public static var exclusive: Self {
return Self(rawValue: UInt32(bitPattern: RENAME_EXCL))
}
public static var swap: Self {
return Self(rawValue: UInt32(bitPattern: RENAME_SWAP))
}
}
#endif
#if canImport(Glibc) || canImport(Musl)
@_spi(Testing)
public static func rename(
from old: FilePath,
relativeTo oldFD: FileDescriptor,
to new: FilePath,
relativeTo newFD: FileDescriptor,
flags: RenameAtFlags
) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
old.withPlatformString { oldPath in
new.withPlatformString { newPath in
system_renameat2(
oldFD.rawValue,
oldPath,
newFD.rawValue,
newPath,
flags.rawValue
)
}
}
}
}
@_spi(Testing)
public struct RenameAtFlags: OptionSet {
public var rawValue: CUnsignedInt
public init(rawValue: CUnsignedInt) {
self.rawValue = rawValue
}
public static var exclusive: Self {
return Self(rawValue: CNIOLinux_RENAME_NOREPLACE)
}
public static var swap: Self {
return Self(rawValue: CNIOLinux_RENAME_EXCHANGE)
}
}
#endif
#if canImport(Glibc) || canImport(Musl)
@_spi(Testing)
public struct LinkAtFlags: OptionSet {
@_spi(Testing)
public var rawValue: CInt
@_spi(Testing)
public init(rawValue: CInt) {
self.rawValue = rawValue
}
@_spi(Testing)
public static var emptyPath: Self {
Self(rawValue: CNIOLinux_AT_EMPTY_PATH)
}
@_spi(Testing)
public static var followSymbolicLinks: Self {
Self(rawValue: AT_SYMLINK_FOLLOW)
}
}
@_spi(Testing)
public static func linkAt(
from source: FilePath,
relativeTo sourceFD: FileDescriptor,
to destination: FilePath,
relativeTo destinationFD: FileDescriptor,
flags: LinkAtFlags
) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
source.withPlatformString { src in
destination.withPlatformString { dst in
system_linkat(
sourceFD.rawValue,
src,
destinationFD.rawValue,
dst,
flags.rawValue
)
}
}
}
}
#endif
@_spi(Testing)
public static func link(
from source: FilePath,
to destination: FilePath
) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
source.withPlatformString { src in
destination.withPlatformString { dst in
system_link(src, dst)
}
}
}
}
@_spi(Testing)
public static func unlink(path: FilePath) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
path.withPlatformString { ptr in
system_unlink(ptr)
}
}
}
@_spi(Testing)
public static func symlink(
to destination: FilePath,
from source: FilePath
) -> Result<Void, Errno> {
return nothingOrErrno(retryOnInterrupt: false) {
source.withPlatformString { src in
destination.withPlatformString { dst in
system_symlink(dst, src)
}
}
}
}
@_spi(Testing)
public static func readlink(at path: FilePath) -> Result<FilePath, Errno> {
do {
let resolved = try path.withPlatformString { p in
try String(customUnsafeUninitializedCapacity: Int(CInterop.maxPathLength)) { pointer in
let result = pointer.withMemoryRebound(to: CInterop.PlatformChar.self) { ptr in
valueOrErrno(retryOnInterrupt: false) {
system_readlink(p, ptr.baseAddress!, ptr.count)
}
}
return try result.get()
}
}
return .success(FilePath(resolved))
} catch let error as Errno {
return .failure(error)
} catch {
// Shouldn't happen: we deal in Result types and only ever with Errno.
fatalError("Unexpected error '\(error)' caught")
}
}
#if canImport(Glibc) || canImport(Musl)
@_spi(Testing)
public static func sendfile(
to output: FileDescriptor,
from input: FileDescriptor,
offset: Int,
size: Int
) -> Result<Int, Errno> {
valueOrErrno(retryOnInterrupt: false) {
system_sendfile(output.rawValue, input.rawValue, off_t(offset), size)
}
}
#endif
}
@_spi(Testing)
public enum Libc {
static func readdir(
_ dir: CInterop.DirPointer
) -> Result<UnsafeMutablePointer<CInterop.DirEnt>?, Errno> {
optionalValueOrErrno(retryOnInterrupt: false) {
libc_readdir(dir)
}
}
static func closedir(
_ dir: CInterop.DirPointer
) -> Result<Void, Errno> {
nothingOrErrno(retryOnInterrupt: false) {
libc_closedir(dir)
}
}
#if canImport(Darwin)
@_spi(Testing)
public static func fcopyfile(
from source: FileDescriptor,
to destination: FileDescriptor,
state: copyfile_state_t?,
flags: copyfile_flags_t
) -> Result<Void, Errno> {
nothingOrErrno(retryOnInterrupt: false) {
libc_fcopyfile(source.rawValue, destination.rawValue, state, flags)
}
}
#endif
@_spi(Testing)
public static func remove(
_ path: FilePath
) -> Result<Void, Errno> {
nothingOrErrno(retryOnInterrupt: false) {
path.withPlatformString {
libc_remove($0)
}
}
}
static func getcwd() -> Result<FilePath, Errno> {
var buffer = [CInterop.PlatformChar](
repeating: 0,
count: Int(CInterop.maxPathLength)
)
return optionalValueOrErrno(retryOnInterrupt: false) {
buffer.withUnsafeMutableBufferPointer { pointer in
libc_getcwd(pointer.baseAddress!, pointer.count)
}
}.map { ptr in
// 'ptr' is just the input pointer, we should ignore it and just rely on the bytes
// in buffer.
//
// At this point 'ptr' must be non-nil, because if it were 'nil' we should be on the
// error path.
precondition(ptr != nil)
return FilePath(platformString: buffer)
}
}
#if !os(Android)
static func constr(_ name: CInt) -> Result<String, Errno> {
var buffer = [CInterop.PlatformChar](repeating: 0, count: 128)
repeat {
let result = valueOrErrno(retryOnInterrupt: false) {
buffer.withUnsafeMutableBufferPointer { pointer in
libc_confstr(name, pointer.baseAddress!, pointer.count)
}
}
switch result {
case let .success(length):
if length <= buffer.count {
return .success(String(cString: buffer))
} else {
// The buffer wasn't long enough. Double and try again.
buffer.append(contentsOf: repeatElement(0, count: buffer.capacity))
}
case let .failure(errno):
return .failure(errno)
}
} while true
}
#endif
static func ftsOpen(_ path: FilePath, options: FTSOpenOptions) -> Result<CInterop.FTSPointer, Errno> {
// 'fts_open' needs an unsafe mutable pointer to the C-string, `FilePath` doesn't offer this
// so copy out its bytes.
var pathBytes = path.withPlatformString { pointer in
// Length excludes the null terminator, so add it back.
let bufferPointer = UnsafeBufferPointer(start: pointer, count: path.length + 1)
return Array(bufferPointer)
}
return valueOrErrno {
pathBytes.withUnsafeMutableBufferPointer { pointer in
// The array must be terminated with a nil.
#if os(Android)
libc_fts_open([pointer.baseAddress!, unsafeBitCast(0, to: UnsafeMutablePointer<CInterop.PlatformChar>.self)], options.rawValue)
#else
libc_fts_open([pointer.baseAddress, nil], options.rawValue)
#endif
}
}
}
/// Options passed to 'fts_open'.
struct FTSOpenOptions: OptionSet {
var rawValue: CInt
/// Don't change directory while walking the filesystem hierarchy.
static var noChangeDir: Self { Self(rawValue: FTS_NOCHDIR) }
/// Return FTS entries for symbolic links rather than their targets.
static var physical: Self { Self(rawValue: FTS_PHYSICAL) }
/// Return FTS entries for the targets of symbolic links.
static var logical: Self { Self(rawValue: FTS_LOGICAL) }
}
static func ftsRead(
_ pointer: CInterop.FTSPointer
) -> Result<UnsafeMutablePointer<CInterop.FTSEnt>?, Errno> {
optionalValueOrErrno {
libc_fts_read(pointer)
}
}
static func ftsClose(
_ pointer: CInterop.FTSPointer
) -> Result<Void, Errno> {
nothingOrErrno {
libc_fts_close(pointer)
}
}
}
#endif
|