|
|
|
Adds a new workgroup to the current list of workgroups.
Syntax
REC I32A @64A
AIFWGADD ( overall_status, itemnum_array, item_array,
RECA CA CA I32
itemstatus_array, workgroup_name, position, user_id );
Parameters
- overall_status
- record by reference (required)
Returns the overall status of the call. A zero indicates a successful
call. A negative value indicates an error in the overall call, not
specific to any particular item. A positive value indicates the last
element in itemstatus_array, signaling an error condition.
Record type: status_type
- itemnum_array
- 32-bit signed integer array by reference (required)
An array of integers where each element is an item number indicating the
operating system information to be added. New information must be
located in a data structure pointed to by the corresponding element in
item_array. If n item numbers are being passed, element n+1 must be a
zero to indicate the end of element list.
- item_array
- 64-bit address array by reference (required)
An array where each element is a 64-bit address pointing to a data
structure containg new information to be passed to the operating system.
Information and its required data type are defined by the item number
passed in the corresponding element in the itemnum_array.
Array type: globalanyptr
- itemstatus_array
- Record array by reference (required)
An array where each element returns the status of the operation
performed in the corresponding element in item_array. A zero indicates
a successful operation. A negative value indicates an error condition.
A positive value indicates a warning.
Array type: status_type
- workgroup_name
- 256-byte character array by reference (required)
Passes the name of the workgroup to be added. The workgroup name follows
the convention for CI variables and Job Control Words(JCW's) and can be
a maximum of 256 alphanumeric characters or underscores, where the first
character cannot be numeric. The user-specified name (including case) is
preserved. The workgroup_name is terminated by a NULL character
(ASCII 0).
Note that the following names are unavailable:
AS_Default, BS_Default, CS_Default, DS_Default, ES_Default, and
Natural_wg.
- position
- 256-byte character array by reference (optional)
Passes the name of the workgroup where the new workgroup is to be
inserted. The position is the name of an existing user-defined workgroup.
The new workgroup will be inserted before the existing workgroup. The
position specification is optional. If omitted, the new workgroup will
be appended after all user-defined workgroups. Default workgroups cannot
be specified in position parameter.
Default: Blanks
- user_id
- 32-bit signed integer by value (optional)
The user ID assigned to a vendor at the time of purchase of the
Architected Interface Facility: Operating System product. If it is not
passed, the caller must have previously called AIFACCESSON.
Default: 0
Operation Notes
AIFWGADD adds a new workgroup in the current list of workgroups. When
creating a new workgroup, it is necessary to specify one of the membership
criteria and the required scheduling characteristics of Base and Limit. The
rest of the membership criteria or scheduling characteristics can either be
specified or allowed to take their default values. Table 4-6 provides detailed
description of items. Tables 3-1 and 3-2 list the default values of membership
criteria and scheduling characteristics.
Workgroup membership criteria is used to determine the workgroup membership of
processes on the system. The determination is made at each process creation,
whenever one of the values on which membership can be based is changed (Logon,
Program, or Scheduling Queue), and whenever a system-wide scan is requested.
An addition of a new workgroup could effect the workgroup assignment of
existing processes. As a result, the Workload Manager will need to scan all
processes on the system and adjust their workgroup membership as necessary.
Workgroup Information Item Descriptions
The following table provides detailed descriptions of item numbers and
corresponding items associated with AIFWGADD.
Table 3-47 AIFWGADD Item Descriptions
| Item Number |
Item Name, Data Type, and Description |
| 19003 |
Logon/User specification (CA256);
Passes the logon category of the new workgroup. The logon membership
criteria specifies the job/session, user and account name (LOGON =
[job/sessionname,]username.accountname) of potential
workgroup members. The job/session name is optional, but if specified, the
logon must be enclosed in double quotes (" "). The user and account name
are required. Wildcarding is supported. Use the @ symbol to specify zero
or more alphanumeric characters. For example:
"SUSAN,MANAGER.SYS", GUEST.SYS, ACCNTING,@.SYS
The logon/user specification must be left justified and terminated by a
NULL character. "@,@.@" represents all logons on the system. |
| 19004 |
Program/File name (REC);
Passes the program file category of the specified workgroup. The program
membership criteria specifies the program files of potential workgroup
members. The filename must be a fully qualified MPE/iX file name or
absolute Hierarchichal File System (HFS) name. Wildcarding is supported.
Use the @ symbol to specify zero or more alphanumeric characters. Use the
# symbol to specify one numeric character. For example:
EDITOR.PUB.SYS, HPEDIT#.@.@
The name must be left-justified. The length of the item passed in must be
specified in the length field of the pathname_type record. @.@.@
represents all files on the system.
Record Type: pathname_type. The maximum size of n which is user-defined is
512. |
| 19005 |
Queue (CA20);
Passes the queue category of the specified workgroup. The queue membership
criteria specifies the queue attribute of potential workgroup members.
Five values are supported, AS, BS, CS, DS, and ES. For example:
CS, ES
The queue must be left justified and terminated by a NULL character. If a
queue criteria is not specified, it defaults to match any of the five
queues. |
| 19007 |
Base priority (I32);
Passes the base priority of the specified workgroup. This value is the
highest priority that any process which is a member of this workgroup can
have. Can be set for any user-defined workgroups. This priority can be
mapped to MPE V by the following formula:
(All formula values are decimal.)
MPEVPri = (32767 - MPE/iXPri) DIV 128
Base priority is a required item for addition of a new workgroup. |
| 19008 |
Limit priority (I32);
Passes the limit priority of the specified workgroup. This value is the
lowest priority that any process which is a member of this workgroup can
have. Can be set for any user-defined workgroups. This priority can be
mapped to MPE V by the following formula:
(All formula values are decimal.)
MPEVPri = (32767 - MPE/iXPri) DIV 128
Limit priority is a required item for addition of a new
workgroup. |
| 19009 |
Minimum Quantum (I32);
Passes the minimum number of milliseconds of CPU consumption that is used
to determine priority decay for processes within the specified workgroup.
Can be set for any user-defined workgroups.
Values for minimum quantum range from 0 to 32767 milliseconds. The default
value is 1 milliseconds for user-defined workgroups and CS_Default
workgroup. The default value for DS_Default and ES_Default workgroups is
2000. |
| 19010 |
Maximum Quantum (I32);
Passes the maximum number of milliseconds of CPU consumption that is used
to determine priority decay for processes within the specified workgroup.
Can be set for any user-defined workgroups.
Values for maximum quantum range from 0 to 32767 milliseconds. The default
value is 2000 milliseconds. |
| 19011 |
Timeslice (I32);
Passes the maximum amount of CPU time that can be consumed by a member of
the specified workgroup before being timesliced (yielding the CPU). This
value is accurate to 100-millisecond granularity and has a minimum value
of 100 milliseconds.
Values for timeslice range from 100 to 32700 and default value is 200
milliseconds for CS_Default, DS_Default, ES_Default and user-defined
workgroups. |
| 19012 |
Boost Property (I32);
Passes the boost property of the workgroup (decay or oscillate). Values
and their meanings are as follows:
|
| 19013 |
Maximum CPU Percentage (I32);
Passes the upper bound for the amount of CPU the processes in a workgroup
can consume relative to to other workgroups.
The value can range from 0% to 100%. The default value is 100%. The
maximum CPU percentage control may result in system idling if the
workgroup hits its maximum CPU percentage and there are no other users who
want CPU. |
| 19014 |
Minimum CPU Percentage (I32);
Passes the lower bound for the amount of CPU the processes in a workgroup
can consume relative to to other workgroups.
The value can range from 0% to 100%. The default value is 0%. Note that
CPU consumption of the workgroup may not precisely match the specified the
minimum CPU percentage if there is insufficient demand within the
workgroup. |
|
