Description

A cache structure is a coupling facility structure that enables high-performance sharing of cached data by applications in a sysplex. The IXLCACHE macro provides the means for applications in a sysplex to access and manipulate the data in a coupling facility cache structure.

The IXLCACHE macro has many REQUEST types. These requests enable the cache structure user to manage, manipulate, and share data with other connected users of the cache structure. Each request type is detailed in other topics. Be sure to read the IXLCACHE guidance information in z/OS MVS Programming: Sysplex Services Guide. The information presented here assumes you have done so. The following table tells you where to find the reference information for each request type:

Table 1. Request Types for IXLCACHE
Request Type	Description
CASTOUT_DATA	Read a data item from an entry in the cache structure to the storage areas specified by BUFFER or BUFLIST and/or ADJAREA. From these areas, the data can be written to permanent storage such as DASD. See IXLCACHE REQUEST=CASTOUT_DATA.
CASTOUT_DATALIST	Read data items from 1 to 8 entries in the cache structure to the storage areas specified by BUFFER,BUFLIST, DEIBAREA,and/or ADJAREA. From these areas, the data can be written to permanent storage such as DASD. See IXLCACHE REQUEST=CASTOUT_DATALIST.
CROSS_INVAL	Deregisters interest and invalidates the copies of a data item in the local cache buffers of users with registered interest in the data item other than the requesting user. See IXLCACHE REQUEST=CROSS_INVAL.
CROSS_INVALLIST	Deregisters interest and invalidates the copies of from 1 to 4096 data items in the local cache buffers of users with registered interest in the data item other than the requesting user. See IXLCACHE REQUEST=CROSS_INVALLIST.
DELETE_NAME	Delete one or more data items identified by NAME and NAMEMASK from the coupling facility cache structure (this frees directory and data entry resources and invalidates any registered users). See IXLCACHE REQUEST=DELETE_NAME.
DELETE_NAMELIST	Delete a set of data entries from the coupling facility cache structure. Each entry to be deleted is represented by a name block contained in the storage area specified by BUFFER or BUFLIST. See IXLCACHE REQUEST=DELETE_NAMELIST.
PROCESS_REFLIST	Process one or more cached data items to indicate that they are recently referenced. See IXLCACHE REQUEST=PROCESS_REFLIST.
READ_COCLASS	Read directory entry names and directory entry user data for the data items specified by NAME and NAMEMASK, and the cast-out class specified by COCLASS and store in BUFFER/BUFLIST area. See IXLCACHE REQUEST=READ_COCLASS.
READ_COSTATS	Retrieve statistical information for the specified cast-out classes. See IXLCACHE REQUEST=READ_COSTATS.
READ_DATA	Read a data item from a data entry in the coupling facility cache structure into the storage areas specified by BUFFER or BUFLIST and/or ADJAREA. See IXLCACHE REQUEST=READ_DATA.
READ_DIRINFO	Retrieve directory information from the coupling facility cache structure and store it in the storage area specified by BUFFER or BUFLIST. See IXLCACHE REQUEST=READ_DIRINFO.
READ_STGSTATS	Retrieve statistical information for a specified storage class and store it in the storage area specified by STGSTATS. See IXLCACHE REQUEST=READ_STGSTATS.
REG_NAMELIST	Create a directory entry and register interest in a list of up to 32 data items and store the resulting state information in the storage area specified by NSBAREA. See IXLCACHE REQUEST=REG_NAMELIST.
RESET_REFBIT	Reset the reference bit in the directory entries for the specified cached data items to indicate that the data items were not recently referenced and obtain a count of referenced items. See IXLCACHE REQUEST=RESET_REFBIT.
SET_RECLVCTR	Define and activate, or deactivate, a reclaiming vector for a specified storage class. See IXLCACHE REQUEST=SET_RECLVCTR.
UNLOCK_CASTOUT	Releases the cast-out lock for the data items named in BUFFER or BUFLIST. See IXLCACHE REQUEST=UNLOCK_CASTOUT.
UNLOCK_CO_NAME	Releases the cast-out lock for a single data item named in CUNBAREA. See IXLCACHE REQUEST=UNLOCK_CO_NAME.
WRITE_DATA	Write data from the storage areas specified by BUFFER or BUFLIST and/or ADJAREA to a data entry in the coupling facility cache structure. See IXLCACHE REQUEST=WRITE_DATA.
WRITE_DATALIST	Write data from a list of entries specified in either BUFFER or BUFLIST to data entries in the coupling facility cache structure. See IXLCACHE REQUEST=WRITE_DATALIST.