 |
HP OpenVMS System Services Reference Manual
The following table defines the p1 argument,
p2 argument, and p3 argument values
when specifying the CSH$_READ_QUANT function code:
| Argument |
Access |
Description |
|
p1
|
Read
|
Address of the buffer.
|
|
p2
|
Read
|
Address of the longword size of the buffer.
|
|
p3
|
---
|
Unused.
|
CSH$_SET_ATTN_AST
Enables attention asynchronous system traps (ASTs).
The following table defines the p1 argument,
p2 argument, and p3 argument values
when specifying the CSH$_SET_ATTN_AST function code:
| Argument |
Access |
Description |
|
p1
|
Read
|
Address of an AST routine.
|
|
p2
|
Read
|
Access mode to deliver AST.
|
|
p3
|
---
|
Unused.
|
CSH$_SET_CLASS
Places processes in classes with or without windfall capability. The
caller supplies a buffer consisting of CSHC blocks.
The format of the buffer is defined in the $CSHDEF macro. The following
table describes the information contained in the buffer:
| Buffer Field |
Definition |
|
CSHC$L_EPID
|
Process ID (PID) of the process to affect.
|
|
CSHC$W_CLASS
|
Class into which to place the process. Class 65535 (hexadecimal FFFF)
has a special interpretation: the associated process is not to be class
scheduled and will, therefore, never run out of class quantum. The
largest class number is 8191.
|
|
CSHC$W_WINDFALL
|
Determines whether the process is to share windfall. A value of 1
permits the process to share windfall; a value of 0 prevents the
process from sharing windfall. Values other than 0 and 1 are undefined
and can cause unpredictable behavior in future releases of the
operating system.
|
The following table defines the p1 argument,
p2 argument, and p3 argument values
when specifying the CSH$_SET_CLASS function code:
| Argument |
Access |
Description |
|
p1
|
Read
|
Address of the buffer.
|
|
p2
|
Read
|
Address of the longword size of the buffer.
|
|
p3
|
Read
|
Address of the longword size of the entry used. Should be CSHC$K_LENGTH
or equivalent.
|
CSH$_SET_NEW
Indicates to the class scheduler that the next READ_NEW will return
information about the calling process. This function should be used
only in executive or kernel mode.
The following table defines the p1 argument,
p2 argument, and p3 argument values
when specifying the CSH$_SET_NEW function code:
| Argument |
Access |
Description |
|
p1
|
---
|
Unused.
|
|
p2
|
Read
|
PID (by value).
|
|
p3
|
---
|
Unused.
|
CSH$_SET_QUANT
Establishes class quantum and enables class scheduling. The caller
supplies a buffer that allocates CPU ticks to classes, one longword per
class, starting with class number 0. Class-scheduled processes will
have their quantum deducted from the appropriate longword, and will be
removed from execution if class quantum is decremented to 0.
The following table defines the p1 argument,
p2 argument, and p3 argument values
when specifying the CSH$_SET_QUANT function code:
| Argument |
Access |
Description |
|
p1
|
Read
|
Address of the buffer.
|
|
p2
|
Read
|
Address of the longword size of buffer.
|
|
p3
|
---
|
Unused.
|
CSH$_SET_TIMEOUT
Establishes a nonstandard timeout. If the application does not issue a
CSH$_SET_QUANT within the timeout period, all class scheduling is
stopped and processes are returned to normal scheduling. The default
value, 30 seconds, should be suitable for most circumstances.
The following table defines the p1 argument,
p2 argument, and p3 argument values
when specifying the CSH$_SET_TIMEOUT function code:
| Argument |
Access |
Description |
|
p1
|
---
|
Unused.
|
|
p2
|
Read
|
Time in seconds (by value).
|
|
p3
|
---
|
Unused.
|
Description
The Affect Process Scheduling service is used by class scheduler
processes to affect scheduling.
Use the func argument to specify which action $SCHED
is to perform.
For more information about class scheduling, see the HP OpenVMS Programming Concepts Manual.
Required Access or Privileges
ALTPRI is required to affect processes. Group access is required to
affect processes in the same UIC group. World access is required to
affect processes in different UIC groups. SYSPRV is required to set the
timeout value.
Required Quota
None
Related Services
$GETJPI, $GETJPIW, $SETPRI
Condition Values Returned
|
SS$_NORMAL
|
Service completed successfully.
|
|
SS$_ACCVIO
|
Buffer, length, or size locations not writeable.
|
|
SS$_BADPARAM
|
Specified a class higher than currently defined, or an element size of
0 was specified.
|
|
SS$_BUFFEROVF
|
Buffer is too small, only some data transferred.
|
|
SS$_INCLASS
|
Returned if a process (specified by the input PID) already belongs to a
scheduling class. This can happen if the process was previously class
scheduled at login through the class scheduler permanent database file,
or by issuing the command, SET PROCESS/SCHEDULING_CLASS="class_name".
|
|
SS$_INSFMEM
|
System dynamic memory is insufficient to complete the service.
|
|
SS$_NOSUCHUSER
|
Supplied PID is not valid.
|
$SEARCH
The Search service scans a directory file and fills in various NAM
block fields. This service should be preceded by the Parse service, in
order to initialize the NAM block appropriately.
For additional information about this service, see the OpenVMS Record Management Services Reference Manual.
$SETAST
Enables or disables the delivery of asynchronous system traps (ASTs)
for the access mode from which the service call was issued.
Format
SYS$SETAST enbflg
C Prototype
int sys$setast (char enbflg);
Argument
enbflg
| OpenVMS usage: |
boolean |
| type: |
byte (unsigned) |
| access: |
read only |
| mechanism: |
by value |
Value specifying whether ASTs are to be enabled. The
enbflg argument is a byte containing this value. The
value 1 enables AST delivery for the calling access mode; the value 0
disables AST delivery.
Description
The Set AST Enable service enables or disables the delivery of ASTs for
the access mode from which the service call was issued.
Required Access or Privileges
When an image is executing in user mode, ASTs are always enabled for
more privileged access modes. If ASTs are disabled for a more
privileged access mode, the operating system cannot deliver ASTs for
less privileged access modes until ASTs are enabled once again for the
more privileged access mode. Therefore, a process that has disabled
ASTs for a more privileged access mode must reenable ASTs for that mode
before returning to a less privileged access mode.
Required Quota
None
Related Services
$DCLAST, $SETPRA
Condition Values Returned
|
SS$_WASCLR
|
The service completed successfully. AST delivery was previously
disabled for the calling access mode.
|
|
SS$_WASSET
|
The service completed successfully. AST delivery was previously enabled
for the calling access mode.
|
$SETCLUEVT
Establishes a request for notification when an OpenVMS Cluster
configuration event occurs.
Format
SYS$SETCLUEVT event ,astadr ,[astprm] ,[acmode] ,[handle]
C Prototype
int sys$setcluevt (unsigned int event, void
(*astadr)(__unknown_params), int astprm, unsigned int acmode, struct
_generic_64 *handle);
Arguments
event
| OpenVMS usage: |
event_code |
| type: |
longword (unsigned) |
| access: |
read only |
| mechanism: |
by value |
Event code indicating the type of cluster configuration event for which
an AST is to be delivered. The event argument is a
value indicating which type of event is of interest.
Each event type has a symbolic name. The $CLUEVTDEF macro defines the
following symbolic names:
| Symbolic Name |
Description |
|
CLUEVT$C_ADD
|
One or more OpenVMS nodes have been added to the OpenVMS Cluster system.
|
|
CLUEVT$C_REMOVE
|
One or more OpenVMS nodes have been removed from the OpenVMS Cluster
system.
|
astadr
| OpenVMS usage: |
ast_procedure |
| type: |
procedure value |
| access: |
call without stack unwinding |
| mechanism: |
by reference |
Notification AST routine to receive control after a change in OpenVMS
Cluster configuration occurs.
astprm
| OpenVMS usage: |
user_arg |
| type: |
longword (unsigned) |
| access: |
read only |
| mechanism: |
by value |
Optional AST parameter to be passed to the AST service routine. The
astprm argument is a longword value containing the AST
parameter.
acmode
| OpenVMS usage: |
access_mode |
| type: |
longword (unsigned) |
| access: |
read only |
| mechanism: |
by value |
Optional access mode at which the configuration event AST is to
execute. The acmode argument is a longword containing
the access mode.
Each access mode has a symbolic name. The $PSLDEF macro defines the
following symbols for the four access modes:
| Symbol |
Access Mode |
|
PSL$C_KERNEL
|
Kernel
|
|
PSL$C_EXEC
|
Executive
|
|
PSL$C_SUPER
|
Supervisor
|
|
PSL$C_USER
|
User
|
The value of the access mode must not be more privileged than the
access mode of the caller.
handle
| OpenVMS usage: |
identifier |
| type: |
quadword (unsigned) |
| access: |
write only |
| mechanism: |
by reference |
Optional identifier to receive a value that uniquely identifies this
AST request. $SETCLUEVT sets this handle to a unique value so that it
can later be used to identify the request in the $CLRCLUEVT and
$TSTCLUEVT services.
Description
The Set Cluster Event service establishes a request for notification
when a cluster configuration event occurs. The service establishes only
one AST notification for a configuration event. To receive AST
notification for all cluster configuration events, the $SETCLUEVT
service must be reissued within the notification AST routine.
The service will verify that the input parameters specify a valid
request, allocate appropriate data structures to hold the request, and
enqueue the request for notification.
You must specify an event type and an AST address. You can specify an
AST parameter, the access mode, and an address into which to place the
handle of this request.
Errors will be returned in the following cases:
- If quotas are exceeded, an error identifying the specific quota
will be returned. It is important to note that this routine will return
an error and will not retry an attempt to get quota if quota is
exhausted on the first attempt. See the Condition Values Returned
section for types of errors that can be returned.
- If the astadr argument is omitted, SS$_BADPARAM
will be returned.
- If the event argument is omitted or incorrectly
specified, SS$_BADPARAM will be returned.
- If the access mode parameter is more privileged than the mode of
the caller, the mode of the caller will be used.
- If specified, the handle argument must be readable
and writable from the mode of the caller. SS$_ACCVIO is returned if
this is not the case.
Required Access or Privileges
None
Required Quota
None
Related Services
$CLRCLUEVT, $TSTCLUEVT
Condition Values Returned
|
SS$_NORMAL
|
The service completed successfully.
|
|
SS$_ACCVIO
|
Unable to process parameters for improper use.
|
|
SS$_BADPARAM
|
The event was improperly specified.
|
|
SS$_EXASTLM
|
The process exceeded its quota for outstanding AST requests.
|
|
SS$_INSFMEM
|
The system dynamic memory is insufficient to complete the service.
|
$SETDDIR
Allows you to read and change the default directory string for the
process. Do not include any device or file name strings in the default
directory string; include only the [DIR] syntax. Modify the device
portion of the current default directory location through the
specification of the SYS$DISK logical name. Redefine this logical name
using either the $CRELNM edtsystem service or the LIB$SET_LOGICAL RTL
routine.
Format
SYS$SETDDIR [new-dir-addr] ,[length-addr] ,[cur-dir-addr]
C Prototype
int sys$setddir (void *newdiraddr, unsigned short int *lengthaddr, void
*curdiraddr);
Arguments
new-dir-addr
| OpenVMS usage: |
char_string |
| type: |
character-coded text string |
| access: |
read only |
| mechanism: |
by descriptor--fixed-length string descriptor |
A descriptor of the new default directory. The
new-dir-addr argument is the address of the descriptor
that points to the buffer containing the new directory specification
that RMS will use to set the new process-default directory. If the
default directory is not to be changed, the value of the
new-dir-addr argument should be 0.
length-addr
| OpenVMS usage: |
word_unsigned |
| type: |
word (unsigned) |
| access: |
write only |
| mechanism: |
by reference |
A word that is to receive the length of the current default directory.
The length-addr argument is the address of the word
that will receive the length. If you do not want this value returned,
specify the value 0.
cur-dir-addr
| OpenVMS usage: |
char_string |
| type: |
character-coded text string |
| access: |
write only |
| mechanism: |
by descriptor--fixed-length string descriptor |
A descriptor of a buffer that is to receive the current default
directory string. The cur-dir-addr argument is the
address of the descriptor that points to the buffer area that is to
receive the current directory string.
Description
The Set Default Directory service allows you to read and change the
default directory string for the process. You should restore the
previous default directory string to its original state unless you want
the changed default directory string to last beyond the exit of your
image. The new directory name string is checked for correct syntax.
There is no predefined macro of the form $SETDDIR_G or $SETDDIR_S to
call this service.
On Alpha and Integrity server systems, the Set Default Directory
service attempts to replace the default directory string with a DID
abbreviation if the length of the resulting default directory exceeds
255 characters. If this happens, then in addition to the normal syntax
check, the entire path to that specification, including the device, is
verified and must exist for the call to succeed.
Required Access or Privileges
None
Required Quota
None
Related Services
$ALLOC, $ASSIGN, $BRKTHRU, $BRKTHRUW, $CANCEL, $CREMBX, $DALLOC,
$DASSGN, $DELMBX, $DEVICE_SCAN, $DISMOU, $GETDVI, $GETDVIW, $GETMSG,
$GETQUI, $GETQUIW, $INIT_VOL, $MOUNT, $PUTMSG, $QIO, $QIOW, $SNDERR,
$SNDJBC, $SNDJBCW, $SNDOPR
Condition Values Returned
|
RMS$_NORMAL
|
The service completed successfully.
|
|
RMS$_DIR
|
The directory name contains an error.
|
|
RMS$_IAL
|
The argument list is invalid.
|
$SETDFPROT
Allows you to read and write the default file protection for the
process.
Format
SYS$SETDFPROT [new-def-prot-addr] ,[cur-def-prot-addr]
C Prototype
int sys$setdfprot (unsigned short int *newdefprotaddr, unsigned short
int *curdefprotaddr);
Arguments
new-def-prot-addr
| OpenVMS usage: |
file_protection |
| type: |
word (unsigned) |
| access: |
read only |
| mechanism: |
by reference |
A word that specifies the new default file protection specification.
The new-def-prot-addr argument is the address of the
word that specifies the desired protection. If you do not want the
process-default file protection to be changed, specify the value 0.
cur-def-prot-addr
| OpenVMS usage: |
file_protection |
| type: |
word (unsigned) |
| access: |
write only |
| mechanism: |
by reference |
A word that is to receive the current default file protection
specification. The cur-def-prot-addr argument is the
address of the word that receives the current process-default
protection. If you do not want the current default file protection,
specify the value 0.
Description
The Set Default File Protection service allows you to read and write
the default file protection for the process. You should restore the old
default file protection specification unless you want the changed
default to last beyond the exit of your image.
There is no predefined macro of the form $SETDEFPROT_G or $SETDEFPROT_S
to call this service.
Required Access or Privileges
None
Required Quota
None
Related Services
$ALLOC, $ASSIGN, $BRKTHRU, $BRKTHRUW, $CANCEL, $CREMBX, $DALLOC,
$DASSGN, $DELMBX, $DEVICE_SCAN, $DISMOU, $GETDVI, $GETDVIW, $GETMSG,
$GETQUI, $GETQUIW, $GET_SECURITY, $INIT_VOL, $MOUNT, $PUTMSG, $QIO,
$QIOW, $SET_SECURITY, $SNDERR, $SNDJBC, $SNDJBCW, $SNDOPR
Condition Values Returned
|
RMS$_NORMAL
|
The service completed successfully.
|
|
RMS$_IAL
|
The argument list is invalid.
|
|
