feat: 🎸 improve handling of file OPEN flags

Author: streamich

src/nfs/v4/Nfsv4Decoder.ts

@@ -1,6 +1,6 @@
 import {Reader} from '@jsonjoy.com/buffers/lib/Reader';
 import {XdrDecoder} from '../../xdr/XdrDecoder';
-import {Nfsv4Op, Nfsv4CbOp, Nfsv4FType, Nfsv4DelegType, Nfsv4Stat} from './constants';
+import {Nfsv4Op, Nfsv4CbOp, Nfsv4FType, Nfsv4DelegType, Nfsv4Stat, Nfsv4CreateMode, Nfsv4OpenFlags} from './constants';
 import {Nfsv4DecodingError} from './errors';
 import * as msg from './messages';
 import * as structs from './structs';
@@ -343,6 +343,32 @@ export class Nfsv4Decoder {
     }
   }
 
+  private readOpenHow(): structs.Nfsv4OpenHow {
+    const xdr = this.xdr;
+    const opentype = xdr.readUnsignedInt();
+    if (opentype === Nfsv4OpenFlags.OPEN4_NOCREATE) return new structs.Nfsv4OpenHow(opentype);
+    const mode = xdr.readUnsignedInt();
+    switch (mode) {
+      case Nfsv4CreateMode.UNCHECKED4:
+      case Nfsv4CreateMode.GUARDED4: {
+        const createattrs = this.readFattr();
+        return new structs.Nfsv4OpenHow(
+          opentype,
+          new structs.Nfsv4CreateHow(mode, new structs.Nfsv4CreateAttrs(createattrs)),
+        );
+      }
+      case Nfsv4CreateMode.EXCLUSIVE4: {
+        const createverf = this.readVerifier();
+        return new structs.Nfsv4OpenHow(
+          opentype,
+          new structs.Nfsv4CreateHow(mode, new structs.Nfsv4CreateVerf(createverf)),
+        );
+      }
+      default:
+        throw new Nfsv4DecodingError(`Unknown create mode: ${mode}`);
+    }
+  }
+
   private readOpenDelegation(): structs.Nfsv4OpenDelegation {
     const xdr = this.xdr;
     const delegationType = xdr.readUnsignedInt() as Nfsv4DelegType;
@@ -652,7 +678,7 @@ export class Nfsv4Decoder {
     const shareAccess = xdr.readUnsignedInt();
     const shareDeny = xdr.readUnsignedInt();
     const owner = this.readOpenOwner();
-    const openhow = xdr.readUnsignedInt();
+    const openhow = this.readOpenHow();
     const claim = this.readOpenClaim();
     return new msg.Nfsv4OpenRequest(seqid, shareAccess, shareDeny, owner, openhow, claim);
   }

src/nfs/v4/__tests__/roundtrip.spec.ts

@@ -337,7 +337,7 @@ describe('roundtrip all NFSv4 operations', () => {
       const {encoder, decoder} = makeCodec();
       const owner = new structs.Nfsv4OpenOwner(BigInt(11), new Uint8Array([11]));
       const claim = new structs.Nfsv4OpenClaim(0, new structs.Nfsv4OpenClaimNull(''));
-      const req = new msg.Nfsv4OpenRequest(1, 2, 3, owner, 0, claim);
+      const req = new msg.Nfsv4OpenRequest(1, 2, 3, owner, new structs.Nfsv4OpenHow(0), claim);
       const creq = new msg.Nfsv4CompoundRequest('', 0, [req]);
       const encoded = encoder.encodeCompound(creq, true);
       const decoded = decoder.decodeCompound(new Reader(encoded), true) as msg.Nfsv4CompoundRequest;

src/nfs/v4/builder.ts

@@ -1,7 +1,7 @@
 import {attrNumsToBitmap} from './attributes';
 import * as msg from './messages';
 import * as structs from './structs';
-import {Nfsv4FType} from './constants';
+import {Nfsv4CreateMode, Nfsv4FType, Nfsv4OpenFlags} from './constants';
 
 /**
  * Static builder helpers for NFS v4 operations.
@@ -252,15 +252,15 @@ export const nfs = {
    * @param shareAccess - Share access mode (OPEN4_SHARE_ACCESS_*)
    * @param shareDeny - Share deny mode (OPEN4_SHARE_DENY_*)
    * @param owner - Open owner (clientid + owner bytes)
-   * @param openhow - Open mode (0 for OPEN4_NOCREATE)
+   * @param openhow - Open how structure (use OpenHow helper)
    * @param claim - Open claim (use OpenClaim helper)
    */
   OPEN(
     seqid: number,
     shareAccess: number,
     shareDeny: number,
     owner: structs.Nfsv4OpenOwner,
-    openhow: number,
+    openhow: structs.Nfsv4OpenHow,
     claim: structs.Nfsv4OpenClaim,
   ): msg.Nfsv4OpenRequest {
     return new msg.Nfsv4OpenRequest(seqid, shareAccess, shareDeny, owner, openhow, claim);
@@ -455,6 +455,42 @@ export const nfs = {
     return new structs.Nfsv4OpenClaim(0, new structs.Nfsv4OpenClaimNull(filename));
   },
 
+  /**
+   * Create Nfsv4OpenHow for OPEN4_NOCREATE (open existing file).
+   */
+  OpenHowNoCreate(): structs.Nfsv4OpenHow {
+    return new structs.Nfsv4OpenHow(Nfsv4OpenFlags.OPEN4_NOCREATE);
+  },
+
+  /**
+   * Create Nfsv4OpenHow for OPEN4_CREATE with UNCHECKED4 mode.
+   * @param createattrs - Optional file attributes to set on create
+   */
+  OpenHowCreateUnchecked(createattrs?: structs.Nfsv4Fattr): structs.Nfsv4OpenHow {
+    const attrs = createattrs || new structs.Nfsv4Fattr(new structs.Nfsv4Bitmap([]), new Uint8Array(0));
+    const how = new structs.Nfsv4CreateHow(Nfsv4CreateMode.UNCHECKED4, new structs.Nfsv4CreateAttrs(attrs));
+    return new structs.Nfsv4OpenHow(Nfsv4OpenFlags.OPEN4_CREATE, how);
+  },
+
+  /**
+   * Create Nfsv4OpenHow for OPEN4_CREATE with GUARDED4 mode.
+   * @param createattrs - Optional file attributes to set on create
+   */
+  OpenHowCreateGuarded(createattrs?: structs.Nfsv4Fattr): structs.Nfsv4OpenHow {
+    const attrs = createattrs || new structs.Nfsv4Fattr(new structs.Nfsv4Bitmap([]), new Uint8Array(0));
+    const how = new structs.Nfsv4CreateHow(Nfsv4CreateMode.GUARDED4, new structs.Nfsv4CreateAttrs(attrs));
+    return new structs.Nfsv4OpenHow(Nfsv4OpenFlags.OPEN4_CREATE, how);
+  },
+
+  /**
+   * Create Nfsv4OpenHow for OPEN4_CREATE with EXCLUSIVE4 mode.
+   * @param verifier - 8-byte verifier for exclusive create
+   */
+  OpenHowCreateExclusive(verifier: structs.Nfsv4Verifier): structs.Nfsv4OpenHow {
+    const how = new structs.Nfsv4CreateHow(Nfsv4CreateMode.EXCLUSIVE4, new structs.Nfsv4CreateVerf(verifier));
+    return new structs.Nfsv4OpenHow(Nfsv4OpenFlags.OPEN4_CREATE, how);
+  },
+
   /**
    * Create Nfsv4LockOwner (lock owner identifier).
    * @param clientid - Client ID

src/nfs/v4/client/Nfsv4FsClient.ts

@@ -86,7 +86,14 @@ export class Nfsv4FsClient implements NfsFsClient {
     const openOwner = nfs.OpenOwner(BigInt(1), new Uint8Array([1, 2, 3, 4]));
     const claim = nfs.OpenClaimNull(filename);
     operations.push(
-      nfs.OPEN(0, Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ, Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE, openOwner, 0, claim),
+      nfs.OPEN(
+        0,
+        Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ,
+        Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
+        openOwner,
+        nfs.OpenHowNoCreate(),
+        claim,
+      ),
     );
     const openResponse = await this.fs.compound(operations);
     if (openResponse.status !== Nfsv4Stat.NFS4_OK) {
@@ -146,7 +153,7 @@ export class Nfsv4FsClient implements NfsFsClient {
         Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_WRITE,
         Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
         openOwner,
-        Nfsv4OpenFlags.OPEN4_CREATE,
+        nfs.OpenHowCreateUnchecked(),
         claim,
       ),
     );
@@ -397,7 +404,14 @@ export class Nfsv4FsClient implements NfsFsClient {
     const openOwner = nfs.OpenOwner(BigInt(1), new Uint8Array([1, 2, 3, 4]));
     const claim = nfs.OpenClaimNull(filename);
     operations.push(
-      nfs.OPEN(0, Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_WRITE, Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE, openOwner, 0, claim),
+      nfs.OPEN(
+        0,
+        Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_WRITE,
+        Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
+        openOwner,
+        nfs.OpenHowNoCreate(),
+        claim,
+      ),
     );
     const attrNums = [Nfsv4Attr.FATTR4_SIZE];
     const attrMask = this.attrNumsToBitmap(attrNums);
@@ -831,7 +845,9 @@ export class Nfsv4FsClient implements NfsFsClient {
           break;
       }
     }
-    operations.push(nfs.OPEN(openFlags, access, Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE, openOwner, 0, claim));
+    operations.push(
+      nfs.OPEN(openFlags, access, Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE, openOwner, nfs.OpenHowNoCreate(), claim),
+    );
     const openResponse = await this.fs.compound(operations);
     if (openResponse.status !== Nfsv4Stat.NFS4_OK) {
       throw new Error(`Failed to open file: ${openResponse.status}`);

src/nfs/v4/format.ts

@@ -606,13 +606,17 @@ export const formatNfsv4Request = (req: msg.Nfsv4Request, tab: string = ''): str
   } else if (req instanceof msg.Nfsv4NverifyRequest) {
     return 'NVERIFY' + printTree(tab, [(tab) => `attrs = ${formatNfsv4Bitmap(req.objAttributes.attrmask)}`]);
   } else if (req instanceof msg.Nfsv4OpenRequest) {
-    return (
-      'OPEN' +
-      printTree(tab, [
-        (tab) => `seqid = ${req.seqid}`,
-        (tab) => `claim = ${formatNfsv4OpenClaimType(req.claim.claimType)}`,
-      ])
-    );
+    const items: Array<(tab: string) => string> = [
+      (tab) => `seqid = ${req.seqid}`,
+      (tab) => `shareAccess = ${formatNfsv4OpenAccess(req.shareAccess)}`,
+      (tab) => `shareDeny = ${formatNfsv4OpenDeny(req.shareDeny)}`,
+      (tab) => `opentype = ${formatNfsv4OpenFlags(req.openhow.opentype)}`,
+    ];
+    if (req.openhow.how) {
+      items.push((tab) => `createmode = ${formatNfsv4CreateMode(req.openhow.how!.mode)}`);
+    }
+    items.push((tab) => `claim = ${formatNfsv4OpenClaimType(req.claim.claimType)}`);
+    return 'OPEN' + printTree(tab, items);
   } else if (req instanceof msg.Nfsv4OpenattrRequest) {
     return 'OPENATTR' + printTree(tab, [(tab) => `createdir = ${req.createdir}`]);
   } else if (req instanceof msg.Nfsv4OpenConfirmRequest) {

src/nfs/v4/messages.ts

@@ -553,7 +553,7 @@ export class Nfsv4OpenRequest implements XdrType {
     public readonly shareAccess: number,
     public readonly shareDeny: number,
     public readonly owner: structs.Nfsv4OpenOwner,
-    public readonly openhow: number,
+    public readonly openhow: structs.Nfsv4OpenHow,
     public readonly claim: structs.Nfsv4OpenClaim,
   ) {}
 
@@ -563,7 +563,7 @@ export class Nfsv4OpenRequest implements XdrType {
     xdr.writeUnsignedInt(this.shareAccess);
     xdr.writeUnsignedInt(this.shareDeny);
     this.owner.encode(xdr);
-    xdr.writeUnsignedInt(this.openhow);
+    this.openhow.encode(xdr);
     this.claim.encode(xdr);
   }
 }

src/nfs/v4/server/operations/node/Nfsv4OperationsNode.ts

@@ -11,6 +11,7 @@ import {
   Nfsv4LockType,
   Nfsv4OpenFlags,
   Nfsv4FType,
+  Nfsv4CreateMode,
 } from '../../../constants';
 import {Nfsv4OperationCtx, Nfsv4Operations} from '../Nfsv4Operations';
 import * as msg from '../../../messages';
@@ -582,6 +583,8 @@ export class Nfsv4OperationsNode implements Nfsv4Operations {
     const claimNull = request.claim.claim as struct.Nfsv4OpenClaimNull;
     const filename = claimNull.file;
     const filePath = NodePath.join(currentPathAbsolute, filename);
+    const opentype = request.openhow.opentype;
+    const isCreate = opentype === Nfsv4OpenFlags.OPEN4_CREATE;
     let fileExists = false;
     try {
       const stats = await this.promises.lstat(filePath);
@@ -591,7 +594,7 @@ export class Nfsv4OperationsNode implements Nfsv4Operations {
       fileExists = true;
     } catch (err) {
       if (isErrCode('ENOENT', err)) {
-        if (request.openhow !== Nfsv4OpenFlags.OPEN4_CREATE) {
+        if (!isCreate) {
           return new msg.Nfsv4OpenResponse(Nfsv4Stat.NFS4ERR_NOENT);
         }
       } else {
@@ -605,8 +608,12 @@ export class Nfsv4OperationsNode implements Nfsv4Operations {
     let flags = 0;
     const isWrite = (request.shareAccess & Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_WRITE) !== 0;
     const isRead = (request.shareAccess & Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ) !== 0;
-    if (request.openhow === 1) {
+    if (isCreate) {
       flags = this.fs.constants.O_CREAT;
+      const createHow = request.openhow.how;
+      if (createHow && createHow.mode === Nfsv4CreateMode.EXCLUSIVE4) {
+        flags |= this.fs.constants.O_EXCL;
+      }
     }
     if (isRead && isWrite) {
       flags |= this.fs.constants.O_RDWR;

src/nfs/v4/server/operations/node/__tests__/CLOSE.spec.ts

@@ -14,7 +14,7 @@ describe('CLOSE operation', () => {
       Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ,
       Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
       openOwner,
-      0,
+      nfs.OpenHowNoCreate(),
       claim,
     );
     const openResponse = await client.compound([nfs.PUTROOTFH(), openReq]);
@@ -41,7 +41,7 @@ describe('CLOSE operation', () => {
       Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ,
       Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
       openOwner,
-      0,
+      nfs.OpenHowNoCreate(),
       claim,
     );
     const openResponse = await client.compound([nfs.PUTROOTFH(), openReq]);
@@ -65,7 +65,7 @@ describe('CLOSE operation', () => {
       Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ,
       Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
       openOwner,
-      0,
+      nfs.OpenHowNoCreate(),
       claim,
     );
     const openResponse = await client.compound([nfs.PUTROOTFH(), openReq]);
@@ -87,7 +87,7 @@ describe('CLOSE operation', () => {
       Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ,
       Nfsv4OpenDeny.OPEN4_SHARE_DENY_WRITE,
       openOwner1,
-      0,
+      nfs.OpenHowNoCreate(),
       claim1,
     );
     const openResponse1 = await client.compound([nfs.PUTROOTFH(), openReq1]);
@@ -101,7 +101,7 @@ describe('CLOSE operation', () => {
       Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_WRITE,
       Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
       openOwner2,
-      0,
+      nfs.OpenHowNoCreate(),
       claim2,
     );
     const openResponse2 = await client.compound([nfs.PUTROOTFH(), openReq2]);
@@ -127,7 +127,7 @@ describe('CLOSE operation', () => {
         Nfsv4OpenAccess.OPEN4_SHARE_ACCESS_READ,
         Nfsv4OpenDeny.OPEN4_SHARE_DENY_NONE,
         openOwner,
-        0,
+        nfs.OpenHowNoCreate(),
         claim,
       );
       const openResponse = await client.compound([nfs.PUTROOTFH(), openReq]);

src/nfs/v4/server/operations/node/__tests__/COMMIT.spec.ts

@@ -8,7 +8,10 @@ describe('COMMIT operation', () => {
     const {client, stop, vol} = await setupNfsClientServerTestbed();
     const openOwner = nfs.OpenOwner(BigInt(1), new Uint8Array([1]));
     const claim = nfs.OpenClaimNull('file.txt');
-    const openRes = await client.compound([nfs.PUTROOTFH(), nfs.OPEN(0, 2, 0, openOwner, 0, claim)]);
+    const openRes = await client.compound([
+      nfs.PUTROOTFH(),
+      nfs.OPEN(0, 2, 0, openOwner, nfs.OpenHowNoCreate(), claim),
+    ]);
     const stateid = (openRes.resarray[1] as any).resok.stateid;
     const data = new Uint8Array(Buffer.from('COMMITTED'));
     const writeReq = nfs.WRITE(stateid, BigInt(0), Nfsv4StableHow.UNSTABLE4, data);