Function

The vn_rmdir operation removes a directory. The directory must be empty.

Environment on entry and exit

See Environment for PFS operations.

Parameters

Token_structure

Supplied parameter

Type:

TOKSTR

Length:

Specified by TOKSTR.ts_hdr.cblen.

The Token_structure represents the file (vnode) that is being operated on. It contains the PFS's initialization token, mount token, and the file token. Refer to LFS/PFS control block structure for a discussion of this structure, and to the TOKSTR typedef in BPXYPFSI in Interface structures for C language servers and clients for its mapping.

OSI_structure

Supplied and returned parameter

Type:

OSI

Length:

Specified by OSI.osi_hdr.cblen.

The OSI_structure contains information that is used by the OSI operations that may be called by the PFS. See OSI services for more information.

It also contains MVS-specific information that needs to be passed to the PFS, including SMF accounting fields, a work area, a recovery area, and an optional pointer to an output ATTR structure. For more details on the OSI structure, see The OSI structure.

This area is mapped by the OSI typedef in BPXYPFSI in Interface structures for C language servers and clients.

Audit_structure

Supplied parameter

Type:

CRED

Length:

Specified by CRED.cred_hdr.cblen.

The Audit_structure contains information that is used by the security product for access checks and auditing. It is passed to most SAF routines that are invoked by the PFS.

Refer to Security responsibilities and considerations for a discussion of security processing, and to the CRED typedef in BPXYPFSI in Interface structures for C language servers and clients for the mapping of this structure.

Directory_name_length

Supplied parameter

Type:

Integer

Length:

Fullword

A fullword that contains the length of Directory_name. The name is between 1 and 255 bytes long.

Directory_name

Supplied parameter

Type:

String

Length:

Specified by Directory_name_length

An area, of length Directory_name_length, that contains the name of the directory that is to be deleted. This name contains no nulls.

Return_value

Returned parameter

Type:

Integer

Length:

Fullword

A fullword in which the vn_rmdir service returns the results of the operation, as one of the following:

Return_value

Meaning

-1

The operation was not successful. The Return_code and Reason_Code values must be filled in by the PFS when Return_value is -1.

0

The operation was successful.

Return_code

Returned parameter

Type:

Integer

Length:

Fullword

A fullword in which the vn_rmdir service stores the return code. The vn_rmdir service returns Return_code only if Return_value is -1. See z/OS UNIX System Services Messages and Codes for a complete list of supported return code values.

The vn_rmdir service should support at least the following error values:

Return_code	Explanation
ENAMETOOLONG	The value of Directory_name_length exceeds the length that is supported by this PFS.
ENOENT	The directory name is marked for deletion.
ENOTEMPTY	The directory contains entries other than . and ..
EROFS	The file system is mounted read-only.

Reason_code

Returned parameter

Type:

Integer

Length:

Fullword

A fullword in which the vn_rmdir service stores the reason code. The vn_rmdir service returns Reason_code only if Return_value is -1. Reason_code further qualifies the Return_code value. These reason codes are documented by the PFS.

Implementation notes

Overview of vn_rmdir processing

Deleting files provides an overview of file deletion processing.

Specific processing notes

• The system data fields of the Token_structure contain the PFS's file token for the file that is being removed.
• The directory that is specified by Directory_name must be empty except for the "." and ".." entries.
• If the directory is successfully removed, the change and modification times for the parent directory must be updated.
• The deletion of the directory is recorded for audit purposes now, but the actual deletion of the object and the inode is done when the vnode is inactivated.
• Vn_readdir of a removed directory returns zero entries.
• New files must not be created under a directory that is removed.
• For more information about the semantics of this operation for a POSIX-conforming PFS, refer to the rmdir() function in the POSIX .1 standard (IEEE Std 1003.1-1990).

Serialization provided by the LFS

The vn_rmdir operation is invoked with an exclusive latch held on the vnode of the directory name that is to be removed, and on the directory that contains that directory name.

Security calls to be made by the PFS

The PFS is expected to invoke SAF's Check Access callable service to verify that the user has write permission to the directory, and invoke the audit callable service to record the deletion of the directory file.

SAF's Check2Owners service is called whenever the sticky bit is on in the parent directory.

Related services

• vn_remove — Remove a link to a file
• vn_mkdir — Create a directory