 |
FunctionThe vn_inactive disassociates a
vnode from the PFS's related inode.
Input parameter formatvn_inactive (Token_structure,
OSI_structure,
Audit_structure,
Return_value,
Return_code,
Reason_code)
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.
- Return_value
- Returned parameter
- Type:
- Integer
- Length:
- Fullword
The name of a fullword in which the vn_inactive
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_inactive service stores
the return code. The vn_inactive service returns Return_code only
if Return_value is -1. For a complete list of supported
return code values, see z/OS UNIX System Services Messages and Codes.
The vn_inactive service should support the following
error value: | Return_code |
Explanation |
|---|
| EIO |
An I/O error occurred while accessing the file. |
- Reason_code
- Returned parameter
- Type:
- Integer
- Length:
- Fullword
A fullword in which the vn_inactive service stores
the reason code. The vn_inactive 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_inactive processing
- Creating, referring to, and inactivating file vnodes provides an overview of file
inactivate processing.
- Specific processing notes
- If a transient error, such as an I/O error, is encountered, the
Return_value should be set to -1. In this case, the request is retried
later.
- If a permanent error that prevents the specified file or directory
from being used is encountered, Return_value should be set to zero.
In this case, all references to the file or directory are removed
from the LFS and the request is not retried. The PFS must not issue
a signal-enabled wait during inactivate processing. Waiting and posting provides an overview of wait and post processing.
- If a file's link count is zero, but its open count is not zero,
the PFS should ignore the open count and delete the file's data along
with the file. This may happen, for example, when an address space
is canceled right after vn_open finishes in the PFS, but before the
LFS regains control.
- Serialization provided by the LFS
- The vn_inactive operation is invoked with an exclusive latch held
on the file system containing the vnode.
- Security calls to be made by the PFS
- None
|
z/OS UNIX System Services File System Interface Reference
Copyright IBM Corporation 1990, 2014