| Previous | Contents | Index |
Converts a security auditing event message from binary format to ASCII text.
SYS$FORMAT_AUDIT fmttyp ,audmsg ,[outlen] ,outbuf ,[width] ,[trmdsc] ,[routin] ,[fmtflg]
int sys$format_audit (unsigned int fmttyp, void *audmsg, unsigned short int *outlen, void *outbuf, unsigned short int *width, void *trmdsc, int (*routin)(__unknown_params), unsigned int fmtflg);
fmttyp
OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by value
Format for the message. The fmttyp argument is a value indicating whether the security audit message should be in brief format, which is one line of information, or full format. The default is full format. Refer to the HP OpenVMS System Manager's Manual for examples of formatted output.The following table defines the brief and full formats:
Value Meaning NSA$C_FORMAT_STYLE_BRIEF Use a brief format for the message. NSA$C_FORMAT_STYLE_FULL Use a full format for the message. audmsg
OpenVMS usage: char_string type: byte stream (unsigned) access: read only mechanism: by reference
Security auditing message to format. The audmsg argument is the address of a buffer containing the message that requires formatting.outlen
OpenVMS usage: word_unsigned type: word (unsigned) access: write only mechanism: by reference
Length of the formatted security audit message. The outlen argument is the address of the word receiving the final length of the ASCII message.outbuf
OpenVMS usage: char_string type: character-coded text string access: read only mechanism: by descriptor
Buffer holding the formatted message. The outbuf argument is the address of a descriptor pointing to the buffer receiving the message.width
OpenVMS usage: word_unsigned type: word (unsigned) access: read only mechanism: by reference
Maximum width of the formatted message. The width argument is the address of a word containing the line width value. The default is 80 columns.The width argument does not work consistently. In most cases, if you specify both the width argument and the full format style (NSA$C_FORMAT_STYLE_FULL), $FORMAT_AUDIT ignores the width argument. The minimum width is 80 columns; lower values do not limit the width to less than 80. If you specify a width greater than 80 columns, most lines are not joined to use the full width.
In most cases, you should avoid using the width argument.
trmdsc
OpenVMS usage: char_string type: character-coded text string access: read only mechanism: by descriptor
Line termination characters used in a full format message. The trmdsc argument is the address of a descriptor pointing to the line termination characters to insert within a line segment whenever the width is reached.routin
OpenVMS usage: procedure type: procedure value access: read only mechanism: by reference
Routine that writes a formatted line to the output buffer. The routin argument is the address of a routine called each time a line segment is formatted. The argument passed to the routine is the address of a character string descriptor for the line segment.When an application wants event messages in the brief format, $FORMAT_AUDIT calls the routine twice to format the first event message. The first time it is called, the routine passes a string containing the column titles for the message. The second and subsequent calls to the routine pass the formatted event message. By using this routine argument, a caller can gain control at various points in the processing of an audit event message.
fmtflg
OpenVMS usage: longword (unsigned) type: mask_longword access: read only mechanism: by value
Determines the formatting of certain kinds of audit messages. The fmtflg argument is a mask specifying whether sensitive information should be displayed or column titles built for messages in brief format. For example, the operating system uses bit 0 to suppress plain-text passwords from security alarm messages.The following table describes the significant bits:
Bit Value Description 0 1 Do not format sensitive information. 0 Format sensitive information. 1 1 Build a column title for messages in brief format. (You must specify a fmttyp of brief and a routin argument.) 0 Do not build column titles.
The Format Security Audit Event Message service converts a security auditing event message from binary format to ASCII text and can filter sensitive information. $FORMAT_AUDIT allows the caller to format a message in a multiple-line format or a single-line format and tailor the information for a display device of a specific width.$FORMAT_AUDIT is intended for utilities that need to format the security auditing event messages received from the audit server listener mailbox or the system security audit log file.
None
$FORMAT_AUDIT can cause a process to exceed its page-file quota (PGFLQUOTA) if it has to format a long auditing event message. The caller of $FORMAT_AUDIT can also receive quota violations from services that $FORMAT_AUDIT uses, such as $IDTOASC, $FAO, and $GETMSG.
$AUDIT_EVENT
SS$_NORMAL The service completed successfully. SS$_MSGNOTFND The service completed successfully; however, the message code cannot be found and a default message has been returned. SS$_ACCVIO The item list cannot be read by the caller, or the buffer length or buffer cannot be written by the caller. SS$_BADPARAM The item list contains an invalid identifier. SS$_BUFFEROVF The service completed successfully; however, the formatted output string overflowed the output buffer and has been truncated. SS$_INSFMEM The process dynamic memory is insufficient for opening the rights database. SS$_IVCHAN The format of the specified identifier is not valid. This condition value returned is not directly returned by $FORMAT_AUDIT. It is indirectly returned when $FORMAT_AUDIT in turn calls another service, such as an identifier translation or binary time translation service. SS$_IVIDENT The format of the specified identifier is invalid. SS$_NOSUCHID The specified identifier name does not exist in the rights database. This condition value returned is not directly returned by $FORMAT_AUDIT. It is indirectly returned when $FORMAT_AUDIT in turn calls another service, such as an identifier translation or binary time translation service.
The Free service unlocks all records that were previously locked for the record stream.Refer to the OpenVMS Record Management Services Reference Manual for additional information about this service.
On Alpha and Integrity server systems, releases a user capability, indicating to other processes that the resource is now available.This service accepts 64-bit addresses.
SYS$FREE_USER_CAPABILITY cap_num [,prev_num] [,flags]
int sys$free_user_capability (int *cap_num, struct _generic_64 *prev_mask, struct _generic_64 *flags);
cap_num
OpenVMS usage: longword type: longword (unsigned) access: read only mechanism: by 32- or 64-bit reference
Capability number to be released by the calling Kernel thread. This number can range from 1 to 16. The cap_num argument is the 32- or 64-bit address of the longword containing the user capability number.prev_mask
OpenVMS usage: mask_quadword type: quadword (unsigned) access: write only mechanism: by 32- or 64-bit reference
The previous user capability reservation mask before execution of this service call. The prev_mask argument is the 32- or 64-bit address of a quadword into which the service writes a quadword bit mask specifying the previously reserved user capabilities.flags
OpenVMS usage: mask_quadword type: quadword (unsigned) access: read only mechanism: by 32- or 64-bit reference
Options selected for the user capability reservation. The flags argument is a quadword bit vector wherein a bit corresponds to an option.Each option (bit) has a symbolic name, which the $CAPDEF macro defines. The flags argument is constructed by performing a logical OR operation using the symbolic names of each desired option.
At this time, all bits are reserved to HP and must be 0.
The Release a Reserved User Capability service releases a user capability back to the global pool, making it available for subsequent calls to $GET_USER_CAPABILITY. The state of all user capabilities in the system are kept in SCH$GQ_RESERVED_USER_CAPS; this service clears the bit position in that cell reflecting the capability number specified in cap_num.This service can also return the state of the global reservation bit mask prior to a release operation.
The caller must have both ALTPRI and WORLD privileges to call $FREE_USER_CAPABILITY to release a user capability. No privileges are required if $FREE_USER_CAPABILITY is called only to retrieve the current user capability reservation mask.
None
$GET_USER_CAPABILITY, $CPU_CAPABILITIES, $PROCESS_CAPABILITIES
SS$_NORMAL The service completed successfully. SS$_ACCVIO The service cannot access the locations specified by one or more arguments. SS$_INSFARG Fewer than the required number of arguments were specified, or no operation was specified. SS$_NOPRIV Insufficient privilege for the attempted operation. SS$_TOO_MANY_ARGS Too many arguments were presented to the system service. SS$_WASCLR The requested user capability was already released.
The Get service retrieves a record from a file.Refer to the OpenVMS Record Management Services Reference Manual for additional information about this service.
Returns information about the state of transactions.
SYS$GETDTI [efn] ,[flags] ,iosb ,[astadr] ,[astprm] ,[log_id] ,[contxt] ,search ,itmlst
int sys$getdti (unsigned int efn, unsigned int flags, struct _iosb *iosb, void (*astadr)(__unknown_params), int astprm, unsigned int log_id [4], unsigned int *contxt, void *search, void *itmlst);
efn
OpenVMS usage: ef_number type: longword (unsigned) access: read only mechanism: by value
Number of the event flag that is set when the service completes. If this argument is omitted, event flag 0 is used.flags
OpenVMS usage: mask_longword type: longword (unsigned) access: read only mechanism: by value
Flags specifying options for the service. The flags argument is a longword bit mask in which each bit corresponds to an option flag. The $DDTMDEF macro defines symbolic names for these option flags described in Table SYS-40. All undefined bits must be 0. If this argument is omitted, no flags are used.
Table SYS-40 $GETDTI Option Flags Flag Name Description DDTM$M_FULL_STATE Indicates that the $GETDTI call for a specified TID is not to complete until the ABORTED or COMMITTED state can be returned. Thus, if another node or coordinating resource manager must be contacted and it is currently unreachable, this service does not return until the node can be contacted. Indicates on a wildcard search that only transactions known to be in the ABORTED or COMMITTED states are to be returned. DDTM$M_SYNC Specifies successful synchronous completion by returning SS$_SYNCH. When SS$_SYNCH is returned, the AST routine is not called, the event flag is not set, and the I/O status block is not filled in. iosb
OpenVMS usage: io_status_block type: quadword (unsigned) access: write only mechanism: by reference
The I/O status block in which the completion status of the service is returned as a condition value. See the Condition Values Returned section.The following diagram shows the structure of the I/O status block:
| OpenVMS usage: | ast_procedure |
| type: | procedure entry mask |
| access: | call without stack unwinding |
| mechanism: | by reference |
| OpenVMS usage: | user_arg |
| type: | longword (unsigned) |
| access: | read only |
| mechanism: | by value |
| OpenVMS usage: | uid |
| type: | octaword (unsigned) |
| access: | read only |
| mechanism: | by reference |
If you do not specify the same log id used by the transaction manager to write transaction information, then $GETDTI will return an error.
If the log_id argument is specified as a zero UID, then $GETDTI will use the current active log for this node. If the specified transaction cannot be found in this log, then the returned state will be aborted. The log identifier can only be specified as zero when the DTI$_SEARCH_AS_NODE item is absent or results in a search that specifies the local node. Note that the log_id argument cannot be specified as a zero address.
To ensure smooth operation in a mixed-network environment, refer to the chapter entitled Managing DECdtm Services in the HP OpenVMS System Manager's Manual, for information on defining node names.
| OpenVMS usage: | contxt |
| type: | longword (unsigned) |
| access: | modify |
| mechanism: | by reference |
The search context is valid only after a successful call to $GETDTI and is invalidated by a subsequent call to $GETDTI.
The context is also used as input to $SETDTI after a successful call to $GETDTI. Calls to $SETDTI do not modify or invalidate the context.
| OpenVMS usage: | item_list_3 |
| type: | descriptor list |
| access: | read only |
| mechanism: | by reference |
The search argument is the address of a list of item descriptors, each of which describes a search item. The list of item descriptors is terminated by a longword of 0. Each item descriptor in the search item list acts as an input argument to $GETDTI and as such is only required to be read only.
The following diagram shows the format of a single item descriptor:
The following table describes the search item descriptor fields:
| Field | Description |
|---|---|
| Buffer length | A word containing a user-supplied integer specifying the length (in bytes) of a buffer from which $GETDTI is to read the information. The length of the buffer needed depends on the item code field of the search item descriptor. If the value of buffer length is too small, $GETDTI will return an error status. |
| Item code | A word containing a user-supplied symbolic code specifying the search item that $GETDTI is to use. The $DTIDEF macro defines these codes. Each item code is described in the Search Item Codes section below. |
| Buffer address | A longword containing the user-supplied address of the buffer from which $GETDTI reads the search information. |
| Return length address | This longword is not used in the search item list, because all search items are read-only. |
| OpenVMS usage: | item_list_3 |
| type: | descriptor list |
| access: | read only |
| mechanism: | by reference |
The following diagram shows the format of a single item descriptor:
The following table describes the itmlst item descriptor fields:
| Field | Description |
|---|---|
| Buffer length | A word containing a user-supplied integer specifying the length (in bytes) of the buffer where $GETDTI is to write the information. The length of the buffer needed depends on the item code field of the search item descriptor. If the value of buffer length is too small, $GETDTI truncates the data and returns the condition code value SS$_BUFFEROVF. |
| Item code | A word containing a user-supplied symbolic code specifying the search item that $GETDTI is to use. The $DTIDEF macro defines these codes. Each item code is described in the Itmlst Item Codes section. |
| Buffer address | A longword containing the user-supplied address of the buffer where $GETDTI is to write the information. |
| return length address | A longword containing the user-supplied address of a word where $GETDTI writes return length information. |
DTI$_SEARCH_AS_NODE
When you specify DTI$_SEARCH_AS_NODE, $GETDTI limits the get request to the specified node name. This can be used during cluster failover recovery processing to allow another node in the cluster to act on behalf of the failed node. The DTI$_SEARCH_AS_NODE item descriptor should point to an ASCII string containing a valid node name string.To ensure smooth operation in a mixed-network environment, refer to the chapter entitled Managing DECdtm Services in the HP OpenVMS System Manager's Manual, for information on defining node names.
DTI$_SEARCH_RESOLVED_STATE
When you specify DTI$_SEARCH_RESOLVED_STATE, the buffer address points to a transaction record that describes the search conditions for this $GETDTI call. The following fields are used from this transaction record and must be specified before $GETDTI can proceed. The $DTIDEF macro defines these fields.
| Item | Description |
|---|---|
| DTI$B_PART_NAME_LEN | A byte containing the length of the participant name field DTI$T_PART_NAME. |
| DTI$T_PART_NAME |
A character field containing DTI$B_PART_NAME_LEN characters that
specifies a resource manager name. When the resource manager name
string is supplied, a wildcard search can be specified. The left-most
characters supplied in this string will be matched against all resource
managers with the same leftmost characters. If the string entered has a
length of 0, all resource managers will be selected.
To ensure smooth operation in a mixed-network environment, refer to the chapter entitled Managing DECdtm Services in the HP OpenVMS System Manager's Manual, for information on defining node names. |
| DTI$T_PART_LOG_ID | Reserved by HP. |
| DTI$T_TID | A 16-byte field containing the transaction identifier. |
| Previous | Next | Contents | Index |