File: FileSystemError%2BSyscall.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (1070 lines) | stat: -rw-r--r-- 34,759 bytes parent folder | download
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
//===----------------------------------------------------------------------===//
//
// 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
#elseif canImport(Glibc)
import Glibc
#elseif canImport(Musl)
import Musl
#endif

extension FileSystemError {
    /// Creates a ``FileSystemError`` by constructing a ``SystemCallError`` as the cause.
    internal init(
        code: Code,
        message: String,
        systemCall: String,
        errno: Errno,
        location: SourceLocation
    ) {
        self.init(
            code: code,
            message: message,
            cause: SystemCallError(systemCall: systemCall, errno: errno),
            location: location
        )
    }
}

extension FileSystemError {
    /// Create a file system error appropriate for the `stat`/`lstat`/`fstat` system calls.
    @_spi(Testing)
    public static func stat(
        _ name: String,
        errno: Errno,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String

        // See: 'man 2 fstat'
        switch errno {
        case .badFileDescriptor:
            code = .closed
            message = "Unable to get information about '\(path)', the file is closed."
        default:
            code = .unknown
            message = "Unable to get information about '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: name,
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public static func fchmod(
        operation: SystemFileHandle.UpdatePermissionsOperation,
        operand: FilePermissions,
        permissions: FilePermissions,
        errno: Errno,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let message: String
        let code: FileSystemError.Code

        // See: 'man 2 fchmod'
        switch errno {
        case .badFileDescriptor:
            code = .closed
            message = "Could not \(operation) permissions '\(operand)', '\(path)' is closed."

        case .invalidArgument:
            // Permissions are invalid so display the raw value in octal.
            let rawPermissions = String(permissions.rawValue, radix: 0o10)
            let op: String
            switch operation {
            case .set:
                op = "set"
            case .add:
                op = "added"
            case .remove:
                op = "removed"
            }
            code = .invalidArgument
            message = """
                Invalid permissions ('\(rawPermissions)') could not be \(op) for file '\(path)'.
                """

        case .notPermitted:
            code = .permissionDenied
            message = """
                Not permitted to \(operation) permissions '\(operand)' for file '\(path)', \
                the effective user ID does not match the owner of the file and the effective \
                user ID is not the super-user.
                """

        default:
            code = .unknown
            message = "Could not \(operation) permissions '\(operand)' to '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "fchmod",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func flistxattr(errno: Errno, path: FilePath, location: SourceLocation) -> Self {
        let code: FileSystemError.Code
        let message: String

        switch errno {
        case .badFileDescriptor:
            code = .closed
            message = "Could not list extended attributes, '\(path)' is closed."

        case .notSupported:
            code = .unsupported
            message = "Extended attributes are disabled or not supported by the filesystem."

        case .notPermitted:
            code = .unsupported
            message = "Extended attributes are not supported by '\(path)'."

        case .permissionDenied:
            code = .permissionDenied
            message = "Not permitted to list extended attributes for '\(path)'."

        default:
            code = .unknown
            message = "Could not to list extended attributes for '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "flistxattr",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func fgetxattr(
        attribute name: String,
        errno: Errno,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String

        switch errno {
        case .badFileDescriptor:
            code = .closed
            message = """
                Could not get value for extended attribute ('\(name)'), '\(path)' is closed.
                """
        case .notSupported:
            code = .unsupported
            message = "Extended attributes are disabled or not supported by the filesystem."
        #if canImport(Darwin)
        case .fileNameTooLong:
            code = .invalidArgument
            message = """
                Length of UTF-8 extended attribute name (\(name.utf8.count)) is greater \
                than the limit (\(XATTR_MAXNAMELEN)). Use a shorter attribute name.
                """
        #endif
        default:
            code = .unknown
            message = "Could not get value for extended attribute ('\(name)') for '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "fgetxattr",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func fsetxattr(
        attribute name: String,
        errno: Errno,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String

        // See: 'man 2 fsetxattr'
        switch errno {
        case .badFileDescriptor:
            code = .closed
            message = """
                Could not set value for extended attribute ('\(name)'), '\(path)' is closed.
                """

        case .notSupported:
            code = .unsupported
            message = """
                Extended attributes are disabled or not supported by the filesystem.
                """

        #if canImport(Darwin)
        case .fileNameTooLong:
            code = .invalidArgument
            message = """
                Length of UTF-8 extended attribute name (\(name.utf8.count)) is greater \
                than the limit limit (\(XATTR_MAXNAMELEN)). Use a shorter attribute \
                name.
                """
        #endif

        case .invalidArgument:
            code = .invalidArgument
            message = """
                Extended attribute name ('\(name)') must be a valid UTF-8 string.
                """
        default:
            code = .unknown
            message = """
                Could not set value for extended attribute ('\(name)') for '\(path)'.
                """
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "fsetxattr",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func fremovexattr(
        attribute name: String,
        errno: Errno,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String

        // See: 'man 2 fremovexattr'
        switch errno {
        case .badFileDescriptor:
            code = .closed
            message = "Could not remove extended attribute ('\(name)'), '\(path)' is closed."

        case .notSupported:
            code = .unsupported
            message = "Extended attributes are disabled or not supported by the filesystem."

        #if canImport(Darwin)
        case .fileNameTooLong:
            code = .invalidArgument
            message = """
                Length of UTF-8 extended attribute name (\(name.utf8.count)) is greater \
                than the limit (\(XATTR_MAXNAMELEN)). Use a shorter attribute name.
                """
        #endif

        default:
            code = .unknown
            message = "Could not remove extended attribute ('\(name)') from '\(path)'"
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "fremovexattr",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func fsync(
        errno: Errno,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String

        switch errno {
        case .badFileDescriptor:
            code = .closed
            message = "Could not synchronize file, '\(path)' is closed."
        case .ioError:
            code = .io
            message = "An I/O error occurred while synchronizing '\(path)'."
        default:
            code = .unknown
            message = "Could not synchronize file '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "fsync",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func dup(error: Error, path: FilePath, location: SourceLocation) -> Self {
        let code: FileSystemError.Code
        let message: String
        let cause: Error

        if let errno = error as? Errno {
            switch errno {
            case .badFileDescriptor:
                code = .closed
                message = "Unable to duplicate descriptor of closed handle for '\(path)'."
            default:
                code = .unknown
                message = "Unable to duplicate descriptor of handle for '\(path)'."
            }
            cause = SystemCallError(systemCall: "dup", errno: errno)
        } else {
            code = .unknown
            message = "Unable to duplicate descriptor of handle for '\(path)'."
            cause = error
        }

        return FileSystemError(
            code: code,
            message: message,
            cause: cause,
            location: location
        )
    }

    @_spi(Testing)
    public static func ftruncate(error: Error, path: FilePath, location: SourceLocation) -> Self {
        let code: FileSystemError.Code
        let message: String
        let cause: Error

        if let errno = error as? Errno {
            switch errno {
            case .badFileDescriptor:
                code = .closed
                message = "Can't resize '\(path)', it's closed."
            case .fileTooLarge:
                code = .invalidArgument
                message = "The requested size for '\(path)' is too large."
            case .invalidArgument:
                code = .invalidArgument
                message = "The requested size for '\(path)' is negative, therefore invalid."
            default:
                code = .unknown
                message = "Unable to resize '\(path)'."
            }
            cause = SystemCallError(systemCall: "ftruncate", errno: errno)
        } else {
            code = .unknown
            message = "Unable to resize '\(path)'."
            cause = error
        }

        return FileSystemError(
            code: code,
            message: message,
            cause: cause,
            location: location
        )
    }

    @_spi(Testing)
    public static func close(error: Error, path: FilePath, location: SourceLocation) -> Self {
        let code: FileSystemError.Code
        let message: String
        let cause: Error

        // See: 'man 2 close'
        if let errno = error as? Errno {
            switch errno {
            case .badFileDescriptor:
                code = .closed
                message = "File already closed or file descriptor was invalid ('\(path)')."
            case .ioError:
                code = .io
                message = "I/O error during close, some writes to '\(path)' may have failed."
            default:
                code = .unknown
                message = "Error closing file '\(path)'."
            }
            cause = SystemCallError(systemCall: "close", errno: errno)
        } else {
            code = .unknown
            message = "Error closing file '\(path)'."
            cause = error
        }

        return FileSystemError(
            code: code,
            message: message,
            cause: cause,
            location: location
        )
    }

    @_spi(Testing)
    public enum ReadSyscall: String {
        case read
        case pread
    }

    @_spi(Testing)
    public static func read(
        usingSyscall syscall: ReadSyscall,
        error: Error,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String
        let cause: Error

        // We expect an Errno as 'swift-system' uses result types under-the-hood,
        // but don't require that in case something changes.
        if let errno = error as? Errno {
            switch errno {
            case .badFileDescriptor:
                code = .closed
                message = "Could not read from closed file '\(path)'."
            case .ioError:
                code = .io
                message = """
                    Could not read from file ('\(path)'); an I/O error occurred while reading \
                    from the file system.
                    """
            case .illegalSeek:
                code = .unsupported
                message = "File is not seekable: '\(path)'."
            default:
                code = .unknown
                message = "Could not read from file '\(path)'."
            }
            cause = SystemCallError(systemCall: syscall.rawValue, errno: errno)
        } else {
            code = .unknown
            message = "Could not read from file '\(path)'."
            cause = error
        }

        return FileSystemError(
            code: code,
            message: message,
            cause: cause,
            location: location
        )
    }

    @_spi(Testing)
    public enum WriteSyscall: String {
        case write
        case pwrite
    }

    @_spi(Testing)
    public static func write(
        usingSyscall syscall: WriteSyscall,
        error: Error,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String
        let cause: Error

        // We expect an Errno as 'swift-system' uses result types under-the-hood,
        // but don't require that in case something changes.
        if let errno = error as? Errno {
            switch errno {
            case .badFileDescriptor:
                code = .closed
                message = "Could not write to closed file '\(path)'."
            case .ioError:
                code = .io
                message = """
                    Could not write to file ('\(path)'); an I/O error occurred while writing to \
                    the file system.
                    """
            case .illegalSeek:
                code = .unsupported
                message = "File is not seekable: '\(path)'."
            default:
                code = .unknown
                message = "Could not write to file."
            }
            cause = SystemCallError(systemCall: syscall.rawValue, errno: errno)
        } else {
            code = .unknown
            message = "Could not write to file."
            cause = error
        }

        return FileSystemError(
            code: code,
            message: message,
            cause: cause,
            location: location
        )
    }

    @_spi(Testing)
    public static func fdopendir(errno: Errno, path: FilePath, location: SourceLocation) -> Self {
        return FileSystemError(
            code: .unknown,
            message: "Unable to open directory stream for '\(path)'.",
            systemCall: "fdopendir",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func readdir(errno: Errno, path: FilePath, location: SourceLocation) -> Self {
        return FileSystemError(
            code: .unknown,
            message: "Unable to read directory stream for '\(path)'.",
            systemCall: "readdir",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func ftsRead(errno: Errno, path: FilePath, location: SourceLocation) -> Self {
        return FileSystemError(
            code: .unknown,
            message: "Unable to read FTS stream for '\(path)'.",
            systemCall: "fts_read",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func open(
        _ name: String,
        error: Error,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String
        let cause: Error

        if let errno = error as? Errno {
            switch errno {
            case .badFileDescriptor:
                code = .closed
                message = "Unable to open file at path '\(path)', the descriptor is closed."
            case .permissionDenied:
                code = .permissionDenied
                message = "Unable to open file at path '\(path)', permissions denied."
            case .fileExists:
                code = .fileAlreadyExists
                message = """
                    Unable to create file at path '\(path)', no existing file options were set \
                    which implies that no file should exist but a file already exists at the \
                    specified path.
                    """
            case .ioError:
                code = .io
                message = """
                    Unable to create file at path '\(path)', an I/O error occurred while \
                    creating the file.
                    """
            case .tooManyOpenFiles:
                code = .unavailable
                message = """
                    Unable to open file at path '\(path)', too many file descriptors are open.
                    """
            case .noSuchFileOrDirectory:
                code = .notFound
                message = """
                    Unable to open or create file at path '\(path)', either a component of the \
                    path did not exist or the named file to be opened did not exist.
                    """
            case .notDirectory:
                code = .notFound
                message = """
                    Unable to open or create file at path '\(path)', an intermediate component of \
                    the path was not a directory.
                    """
            case .tooManySymbolicLinkLevels:
                code = .invalidArgument
                message = """
                    Can't open file at path '\(path)', the target is a symbolic link and \
                    'followSymbolicLinks' was set to 'false'.
                    """
            default:
                code = .unknown
                message = "Unable to open file at path '\(path)'."
            }
            cause = SystemCallError(systemCall: name, errno: errno)
        } else {
            code = .unknown
            message = "Unable to open file at path '\(path)'."
            cause = error
        }

        return FileSystemError(code: code, message: message, cause: cause, location: location)
    }

    @_spi(Testing)
    public static func mkdir(errno: Errno, path: FilePath, location: SourceLocation) -> Self {
        let code: Code
        let message: String

        switch errno {
        case .permissionDenied:
            code = .permissionDenied
            message = """
                Insufficient permissions to create a directory at '\(path)'. Search permissions \
                denied for a component of the path or write permission denied for the parent \
                directory.
                """
        case .isDirectory:
            code = .invalidArgument
            message = "Can't create directory, '\(path)' is the root directory."
        case .fileExists:
            code = .fileAlreadyExists
            message = "Can't create directory, the pathname '\(path)' already exists."
        case .notDirectory:
            code = .invalidArgument
            message = "Can't create directory, a component of '\(path)' is not a directory."
        case .noSuchFileOrDirectory:
            code = .invalidArgument
            message = """
                Can't create directory, a component of '\(path)' does not exist. Ensure all \
                parent directories exist or set 'withIntermediateDirectories' to 'true' when \
                calling 'createDirectory(at:withIntermediateDirectories:permissions)'.
                """
        case .ioError:
            code = .io
            message = "An I/O error occurred when the directory at '\(path)'."
        default:
            code = .unknown
            message = ""
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "mkdir",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func rename(
        errno: Errno,
        oldName: FilePath,
        newName: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: Code
        let message: String

        switch errno {
        case .permissionDenied:
            code = .permissionDenied
            message = """
                Insufficient permissions to rename '\(oldName)' to '\(newName)'. Search \
                permissions were denied on a component of either path, or write permissions were \
                denied on the parent directory of either path.
                """
        case .fileExists:
            code = .fileAlreadyExists
            message = "Can't rename '\(oldName)' to '\(newName)' as it already exists."
        case .invalidArgument:
            code = .invalidArgument
            if oldName == "." || oldName == ".." {
                message = """
                    Can't rename '\(oldName)' to '\(newName)', '.' and '..' can't be renamed.
                    """
            } else {
                message = """
                    Can't rename '\(oldName)', it may be a parent directory of '\(newName)'.
                    """
            }
        case .noSuchFileOrDirectory:
            code = .notFound
            message = """
                Can't rename '\(oldName)' to '\(newName)', a component of '\(oldName)' does \
                not exist.
                """
        case .ioError:
            code = .io
            message = """
                Can't rename '\(oldName)' to '\(newName)', an I/O error occurred while making \
                or updating a directory entry.
                """
        default:
            code = .unknown
            message = "Can't rename '\(oldName)' to '\(newName)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "rename",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func remove(errno: Errno, path: FilePath, location: SourceLocation) -> Self {
        let code: Code
        let message: String

        switch errno {
        case .permissionDenied:
            code = .permissionDenied
            message = """
                Insufficient permissions to remove '\(path)'. Search permissions denied \
                on a component of the path or write permission denied on the directory \
                containing the item to be removed.
                """
        case .notPermitted:
            code = .permissionDenied
            message = """
                Insufficient permission to remove '\(path)', the effective user ID of the \
                process is not permitted to remove the file.
                """
        case .resourceBusy:
            code = .unavailable
            message = """
                Can't remove '\(path)', it may be being used by another process or is the mount \
                point for a mounted file system.
                """
        case .ioError:
            code = .io
            message = """
                Can't remove '\(path)', an I/O error occurred while deleting its directory entry.
                """
        default:
            code = .unknown
            message = "Can't remove '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "remove",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func symlink(
        errno: Errno,
        link: FilePath,
        target: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: Code
        let message: String

        switch errno {
        case .permissionDenied:
            code = .permissionDenied
            message = """
                Can't create symbolic link '\(link)' to '\(target)', write access to the \
                directory containing the link was denied or one of the directories in its path \
                denied search permissions.
                """
        case .notPermitted:
            code = .permissionDenied
            message = """
                Can't create symbolic link '\(link)' to '\(target)', the file system \
                containing '\(link)' doesn't support the creation of symbolic links.
                """
        case .fileExists:
            code = .fileAlreadyExists
            message = """
                Can't create symbolic link '\(link)' to '\(target)', '\(link)' already exists.
                """
        case .noSuchFileOrDirectory:
            code = .invalidArgument
            message = """
                Can't create symbolic link '\(link)' to '\(target)', a component of '\(link)' \
                does not exist or is a dangling symbolic link.
                """
        case .notDirectory:
            code = .invalidArgument
            message = """
                Can't create symbolic link '\(link)' to '\(target)', a component of '\(link)' \
                is not a directory.
                """
        case .ioError:
            code = .io
            message = """
                Can't create symbolic link '\(link)' to '\(target)', an I/O error occurred.
                """
        default:
            code = .unknown
            message = "Can't create symbolic link '\(link)' to '\(target)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "symlink",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func readlink(errno: Errno, path: FilePath, location: SourceLocation) -> Self {
        let code: Code
        let message: String

        switch errno {
        case .permissionDenied:
            code = .permissionDenied
            message = """
                Can't read symbolic link at '\(path)'; search permission was denied for a \
                component in its prefix.
                """
        case .invalidArgument:
            code = .invalidArgument
            message = """
                Can't read '\(path)'; it is not a symbolic link.
                """
        case .ioError:
            code = .io
            message = """
                Can't read symbolic link at '\(path)'; an I/O error occurred.
                """
        case .noSuchFileOrDirectory:
            code = .notFound
            message = """
                Can't read symbolic link, no file exists at '\(path)'.
                """
        default:
            code = .unknown
            message = "Can't read symbolic link at '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "readlink",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func link(
        errno: Errno,
        from sourcePath: FilePath,
        to destinationPath: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String

        // See: 'man 2 link'
        switch errno {
        case .fileExists:
            code = .fileAlreadyExists
            message = """
                Can't link '\(sourcePath)' to '\(destinationPath)', a file already exists \
                at '\(destinationPath)'.
                """
        case .ioError:
            code = .io
            message = "I/O error while linking '\(sourcePath)' to '\(destinationPath)'."
        default:
            code = .unknown
            message = "Error linking '\(sourcePath)' to '\(destinationPath)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            cause: SystemCallError(systemCall: "linkat", errno: errno),
            location: location
        )
    }

    @_spi(Testing)
    public static func unlink(
        errno: Errno,
        path: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: FileSystemError.Code
        let message: String

        // See: 'man 2 unlink'
        switch errno {
        case .permissionDenied:
            code = .permissionDenied
            message = """
                Search permission denied for a component of the path ('\(path)') or write \
                permission denied on the directory containing the link to be removed.
                """
        case .ioError:
            code = .io
            message = "I/O error while unlinking '\(path)'."
        case .noSuchFileOrDirectory:
            code = .notFound
            message = "The named file ('\(path)') doesn't exist."
        case .notPermitted:
            code = .permissionDenied
            message = "Insufficient permissions to unlink '\(path)'."
        default:
            code = .unknown
            message = "Error unlinking '\(path)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            cause: SystemCallError(systemCall: "unlink", errno: errno),
            location: location
        )
    }

    @_spi(Testing)
    public static func getcwd(errno: Errno, location: SourceLocation) -> Self {
        return FileSystemError(
            code: .unavailable,
            message: "Can't get current working directory.",
            systemCall: "getcwd",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func confstr(name: String, errno: Errno, location: SourceLocation) -> Self {
        return FileSystemError(
            code: .unavailable,
            message: "Can't get configuration value for '\(name)'.",
            systemCall: "confstr",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func fcopyfile(
        errno: Errno,
        from sourcePath: FilePath,
        to destinationPath: FilePath,
        location: SourceLocation
    ) -> Self {
        let code: Code
        let message: String

        switch errno {
        case .notSupported:
            code = .invalidArgument
            message = """
                Can't copy file from '\(sourcePath)' to '\(destinationPath)', the item to copy is \
                not a directory, symbolic link or regular file.
                """
        case .permissionDenied:
            code = .permissionDenied
            message = """
                Can't copy file, search permission was denied for a component of the path \
                prefix for the source ('\(sourcePath)') or destination ('\(destinationPath)'), \
                or write permission was denied for a component of the path prefix for the source.
                """
        case .invalidArgument:
            code = .invalidArgument
            message = """
                Can't copy file from '\(sourcePath)' to '\(destinationPath)', the destination \
                path already exists.
                """
        default:
            code = .unknown
            message = "Can't copy file from '\(sourcePath)' to '\(destinationPath)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "fcopyfile",
            errno: errno,
            location: location
        )
    }

    @_spi(Testing)
    public static func sendfile(
        errno: Errno,
        from sourcePath: FilePath,
        to destinationPath: FilePath,
        location: SourceLocation
    ) -> FileSystemError {
        let code: FileSystemError.Code
        let message: String

        switch errno {
        case .ioError:
            code = .io
            message = """
                An I/O error occurred while reading from '\(sourcePath)', can't copy to \
                '\(destinationPath)'.
                """
        case .noMemory:
            code = .io
            message = """
                Insufficient memory to read from '\(sourcePath)', can't copy to \
                '\(destinationPath)'.
                """
        default:
            code = .unknown
            message = "Can't copy file from '\(sourcePath)' to '\(destinationPath)'."
        }

        return FileSystemError(
            code: code,
            message: message,
            systemCall: "sendfile",
            errno: errno,
            location: location
        )
    }
}

#endif