-
Notifications
You must be signed in to change notification settings - Fork 82
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
NFS3 demo server #205
Open
weissi
wants to merge
1
commit into
apple:main
Choose a base branch
from
weissi:jw-nfs3demo
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
NFS3 demo server #205
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the SwiftNIO open source project | ||
| // | ||
| // Copyright (c) 2021-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 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import Logging | ||
| import NIOCore | ||
|
|
||
| final class CloseOnErrorHandler: ChannelInboundHandler { | ||
| typealias InboundIn = Never | ||
|
|
||
| private let logger: Logger | ||
|
|
||
| init(logger: Logger) { | ||
| self.logger = logger | ||
| } | ||
|
|
||
| func errorCaught(context: ChannelHandlerContext, error: Error) { | ||
| self.logger.warning("encountered error, closing NFS connection", metadata: ["error": "\(error)"]) | ||
| context.close(promise: nil) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,302 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the SwiftNIO open source project | ||
| // | ||
| // Copyright (c) 2021-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 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import NIOCore | ||
| import NIONFS3 | ||
| import Logging | ||
|
|
||
| final class DummyFS: NFS3FileSystemNoAuth { | ||
| struct ChildEntry { | ||
| var name: String | ||
| var index: Int | ||
| } | ||
|
|
||
| struct InodeEntry { | ||
| var type: NFS3FileType | ||
| var children: [ChildEntry] | ||
| } | ||
|
|
||
| private var files: [InodeEntry] = [] | ||
| private var root: Int = 7 | ||
| private let fileContent: ByteBuffer = { | ||
| var buffer = ByteBuffer(repeating: UInt8(ascii: "E"), count: 1 * 1024 * 1024) | ||
| buffer.setInteger(UInt8(ascii: "H"), at: 0) | ||
| buffer.setInteger(UInt8(ascii: "L"), at: buffer.writerIndex - 3) | ||
| buffer.setInteger(UInt8(ascii: "L"), at: buffer.writerIndex - 2) | ||
| buffer.setInteger(UInt8(ascii: "O"), at: buffer.writerIndex - 1) | ||
| return buffer | ||
| }() | ||
|
|
||
| init() { | ||
| // 0 doesn't exist? | ||
| self.files.append(.init(type: .regular, children: [])) | ||
|
|
||
| let idDirFileA = self.files.count | ||
| self.files.append(.init(type: .regular, children: [])) | ||
|
|
||
| let idDirFileB = self.files.count | ||
| self.files.append(.init(type: .regular, children: [])) | ||
|
|
||
| let idDirFileC = self.files.count | ||
| self.files.append(.init(type: .regular, children: [])) | ||
|
|
||
| let idDirFileD = self.files.count | ||
| self.files.append(.init(type: .regular, children: [])) | ||
|
|
||
| let idDirFileE = self.files.count | ||
| self.files.append(.init(type: .regular, children: [])) | ||
|
|
||
| let idDirFileF = self.files.count | ||
| self.files.append(.init(type: .regular, children: [])) | ||
|
|
||
| let idDir = self.files.count | ||
| self.files.append( | ||
| .init( | ||
| type: .directory, | ||
| children: [ | ||
| .init(name: ".", index: idDir), | ||
| .init(name: "file", index: idDirFileA), | ||
| .init(name: "file1", index: idDirFileB), | ||
| .init(name: "file2", index: idDirFileC), | ||
| .init(name: "file3", index: idDirFileD), | ||
| .init(name: "file4", index: idDirFileE), | ||
| .init(name: "file5", index: idDirFileF), | ||
| ])) | ||
|
|
||
| let idRoot = self.files.count | ||
| self.files.append( | ||
| .init( | ||
| type: .directory, | ||
| children: [ | ||
| .init(name: ".", index: idRoot), | ||
| .init(name: "dir", index: idDir), | ||
| ])) | ||
|
|
||
| self.files[idDir].children.append(.init(name: "..", index: idRoot)) | ||
| self.files[idRoot].children.append(.init(name: "..", index: idRoot)) | ||
|
|
||
| self.root = idRoot | ||
| } | ||
|
|
||
| func mount(_ call: MountCallMount, logger: Logger, promise: EventLoopPromise<MountReplyMount>) { | ||
| promise.succeed(.init(result: .okay(.init(fileHandle: NFS3FileHandle(UInt64(self.root)))))) | ||
| } | ||
|
|
||
| func unmount(_ call: MountCallUnmount, logger: Logger, promise: EventLoopPromise<MountReplyUnmount>) { | ||
| promise.succeed(.init()) | ||
| } | ||
|
|
||
| func getattr(_ call: NFS3CallGetAttr, logger: Logger, promise: EventLoopPromise<NFS3ReplyGetAttr>) { | ||
| if let result = self.getFile(call.fileHandle) { | ||
| promise.succeed(.init(result: .okay(.init(attributes: result)))) | ||
| } else { | ||
| promise.succeed(.init(result: .fail(.errorBADHANDLE, NFS3Nothing()))) | ||
| } | ||
| } | ||
|
|
||
| func lookup(fileName: String, inDirectory dirHandle: NFS3FileHandle) -> (NFS3FileHandle, NFS3FileAttr)? { | ||
| guard let dirEntry = self.getEntry(fileHandle: dirHandle) else { | ||
| return nil | ||
| } | ||
|
|
||
| guard let index = self.files[dirEntry.0].children.first(where: { $0.name == fileName })?.index else { | ||
| return nil | ||
| } | ||
| let fileHandle = NFS3FileHandle(UInt64(index)) | ||
|
|
||
| return (fileHandle, self.getFile(fileHandle)!) | ||
| } | ||
|
|
||
| func getEntry(index: Int) -> InodeEntry? { | ||
| guard index >= 0 && index < self.files.count else { | ||
| return nil | ||
| } | ||
| return self.files[index] | ||
| } | ||
|
|
||
| func getEntry(fileHandle: NFS3FileHandle) -> (Int, InodeEntry)? { | ||
| return UInt64(fileHandle).flatMap { | ||
| Int(exactly: $0) | ||
| }.flatMap { index in | ||
| self.getEntry(index: index).map { | ||
| (index, $0) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func getFile(_ fileHandle: NFS3FileHandle) -> NFS3FileAttr? { | ||
| guard let entry = self.getEntry(fileHandle: fileHandle) else { | ||
| return nil | ||
| } | ||
|
|
||
| return .init( | ||
| type: entry.1.type, | ||
| mode: 0o777, | ||
| nlink: 1, | ||
| uid: 1, | ||
| gid: 1, | ||
| size: NFS3Size(rawValue: 1 * 1024 * 1024), | ||
| used: 1, | ||
| rdev: 1, | ||
| fsid: 1, | ||
| fileid: NFS3FileID(rawValue: UInt64(entry.0)), | ||
| atime: .init(seconds: 0, nanoseconds: 0), | ||
| mtime: .init(seconds: 0, nanoseconds: 0), | ||
| ctime: .init(seconds: 0, nanoseconds: 0)) | ||
| } | ||
|
|
||
| func fsinfo(_ call: NFS3CallFSInfo, logger: Logger, promise: EventLoopPromise<NFS3ReplyFSInfo>) { | ||
| promise.succeed( | ||
| NFS3ReplyFSInfo( | ||
| result: .okay( | ||
| .init( | ||
| attributes: nil, | ||
| rtmax: 1_000_000, | ||
| rtpref: 128_000, | ||
| rtmult: 4096, | ||
| wtmax: 1_000_000, | ||
| wtpref: 128_000, | ||
| wtmult: 4096, | ||
| dtpref: 128_000, | ||
| maxFileSize: NFS3Size(rawValue: UInt64(Int.max)), | ||
| timeDelta: NFS3Time(seconds: 0, nanoseconds: 0), | ||
| properties: .default)))) | ||
| } | ||
|
|
||
| func pathconf(_ call: NFS3CallPathConf, logger: Logger, promise: EventLoopPromise<NFS3ReplyPathConf>) { | ||
| promise.succeed( | ||
| .init( | ||
| result: .okay( | ||
| .init( | ||
| attributes: nil, | ||
| linkMax: 1_000_000, | ||
| nameMax: 4096, | ||
| noTrunc: false, | ||
| chownRestricted: false, | ||
| caseInsensitive: false, | ||
| casePreserving: true)))) | ||
| } | ||
|
|
||
| func fsstat(_ call: NFS3CallFSStat, logger: Logger, promise: EventLoopPromise<NFS3ReplyFSStat>) { | ||
| promise.succeed( | ||
| .init( | ||
| result: .okay( | ||
| .init( | ||
| attributes: nil, | ||
| tbytes: 0x100_0000_0000, | ||
| fbytes: 0, | ||
| abytes: 0, | ||
| tfiles: 0x1000_0000, | ||
| ffiles: 0, | ||
| afiles: 0, | ||
| invarsec: 0)))) | ||
| } | ||
|
|
||
| func access(_ call: NFS3CallAccess, logger: Logger, promise: EventLoopPromise<NFS3ReplyAccess>) { | ||
| promise.succeed(.init(result: .okay(.init(dirAttributes: nil, access: .allReadOnly)))) | ||
| } | ||
|
|
||
| func lookup(_ call: NFS3CallLookup, logger: Logger, promise: EventLoopPromise<NFS3ReplyLookup>) { | ||
| if let entry = self.lookup(fileName: call.name, inDirectory: call.dir) { | ||
| promise.succeed( | ||
| .init( | ||
| result: .okay( | ||
| .init( | ||
| fileHandle: entry.0, | ||
| attributes: entry.1, | ||
| dirAttributes: nil)))) | ||
| } else { | ||
| promise.succeed(.init(result: .fail(.errorNOENT, .init(dirAttributes: nil)))) | ||
|
|
||
| } | ||
| } | ||
|
|
||
| func readdirplus(_ call: NFS3CallReadDirPlus, logger: Logger, promise: EventLoopPromise<NFS3ReplyReadDirPlus>) { | ||
| if let entry = self.getEntry(fileHandle: call.fileHandle) { | ||
| var entries: [NFS3ReplyReadDirPlus.Entry] = [] | ||
| for fileIndex in entry.1.children.enumerated().dropFirst(Int(min(UInt64(Int.max), | ||
| call.cookie.rawValue))) { | ||
| entries.append( | ||
| .init( | ||
| fileID: NFS3FileID(rawValue: UInt64(fileIndex.element.index)), | ||
| fileName: fileIndex.element.name, | ||
| cookie: NFS3Cookie(rawValue: UInt64(fileIndex.offset)), | ||
| nameAttributes: nil, | ||
| nameHandle: nil)) | ||
| } | ||
| promise.succeed( | ||
| .init( | ||
| result: .okay( | ||
| .init( | ||
| dirAttributes: nil, | ||
| cookieVerifier: call.cookieVerifier, | ||
| entries: entries, | ||
| eof: true)))) | ||
| } else { | ||
| promise.succeed(.init(result: .fail(.errorNOENT, .init(dirAttributes: nil)))) | ||
|
|
||
| } | ||
| } | ||
|
|
||
| func read(_ call: NFS3CallRead, logger: Logger, promise: EventLoopPromise<NFS3ReplyRead>) { | ||
| if let file = self.getFile(call.fileHandle) { | ||
| if file.type == .regular { | ||
| var slice = self.fileContent | ||
| guard call.offset.rawValue <= UInt64(Int.max) else { | ||
| promise.succeed(.init(result: .fail(.errorFBIG, .init(attributes: nil)))) | ||
| return | ||
| } | ||
| let offsetLegal = slice.readSlice(length: Int(call.offset.rawValue)) != nil | ||
| if offsetLegal { | ||
| let actualSlice = slice.readSlice(length: min(slice.readableBytes, Int(call.count.rawValue)))! | ||
| let isEOF = slice.readableBytes == 0 | ||
|
|
||
| promise.succeed( | ||
| .init( | ||
| result: .okay( | ||
| .init( | ||
| attributes: nil, | ||
| count: NFS3Count(rawValue: UInt32(actualSlice.readableBytes)), | ||
| eof: isEOF, | ||
| data: actualSlice)))) | ||
| } else { | ||
| promise.succeed( | ||
| .init( | ||
| result: .okay( | ||
| .init( | ||
| attributes: nil, | ||
| count: 0, | ||
| eof: true, | ||
| data: ByteBuffer())))) | ||
| } | ||
| } else { | ||
| promise.succeed(.init(result: .fail(.errorISDIR, .init(attributes: nil)))) | ||
| } | ||
| } else { | ||
| promise.succeed(.init(result: .fail(.errorNOENT, .init(attributes: nil)))) | ||
| } | ||
| } | ||
|
|
||
| func readlink(_ call: NFS3CallReadlink, logger: Logger, promise: EventLoopPromise<NFS3ReplyReadlink>) { | ||
| promise.succeed(.init(result: .fail(.errorNOENT, .init(symlinkAttributes: nil)))) | ||
| } | ||
|
|
||
| func setattr(_ call: NFS3CallSetattr, logger: Logger, promise: EventLoopPromise<NFS3ReplySetattr>) { | ||
| promise.succeed(.init(result: .fail(.errorROFS, .init(wcc: .init(before: nil, after: nil))))) | ||
| } | ||
|
|
||
| func shutdown(promise: EventLoopPromise<Void>) { | ||
| promise.succeed(()) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally we'd avoid the swift-log dependency here. Any reason we can't
print?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use the logger to carry metadata through. So if you get an error in your file system, you can log and you'll get the precise connection etc associated. For production that's important and given that I had the code I left it here too because I thought the swift-log dependency wouldn't be too bad.
But I can take it out, lose the metadata propagation and just use
print(...)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's definitely not too bad, and I could be talked out of this, but in general keeping the dependency tree small is kinda nice. No strong feelings though, happy for someone to try to talk me out of it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar position but the other way around. Happy either way really ;)