This document describes the steps necessary for installing the Adabas components for EntireX. These steps are necessary if you do not already have Adabas installed at your site and you want to use SVC communication.
This section describes the installation of the Adabas router (ADASVC). The router uses cross-memory services for communication between the Adabas nucleus and the Adabas users.
The Adabas z/OS cross-memory communications service comprises two modules:
the Adabas router (ADASVC); and
the Adabas subsystem initialization routine (ADASIR).
ADASIR, executed either during IPL or by the Adabas SVC installation program (ADASIP), initializes the router’s operating environment, particularly the ID table.
ADASVC installation can be either temporary or permanent:
The Adabas SVC can be installed temporarily by executing ADASIP. The SVC is then available only until the next IPL.
Note:
Once installed, the Adabas SVC can be re-installed
temporarily using the ADASIP REPLACE option. However, no Adabas nucleus can be
active during this procedure.
Note:
It is necessary to cycle CICS after executing ADASIP to
initialize the SVC.
The Adabas SVC is installed permanently using regular operating systems procedures. The SVC then requires an IPL to become active.
Typically, the Adabas SVC is first installed temporarily using ADASIP. This makes Adabas available immediately without the need to wait for an IPL. Meanwhile, preparations are usually made for permanent installation at the next IPL.
Adabas 8 includes a new Adabas SVC. This SVC is fully backward compatible.
However, you cannot use the Adabas SVC from previous Adabas releases with Adabas 8 databases. If you attempt to do this, the Adabas 8 database will not initialize successfully.
Adabas levels are known by their VRS specifications: Version, Release, and SM level. SM level is not a factor in determining compatibility.
With Adabas 8.2 and later versions, the SVC includes performance improvements and improved error recovery routines. Note that the new SVC uses more efficient operating system interfaces, in particular when posting the user at command completion. This shifts work from SRB-mode routines to TCB-mode routines and also between the user's program and the Adabas nucleus. Take this into account when analyzing Adabas 8 SVC performance. With the new SVC, SRB-mode overhead is largely eliminated and TCB-mode overhead is somewhat increased, but the net result is an overall improvement in SVC performance.
The Adabas 8.2 (and later) SVC requires that the Adabas nucleus, as well as other MPM servers (such as Entire Net-Work and the Natural Global Buffer Pool), be authorized to prevent inappropriate use of critical ADASVC functions. This APF authorization prevents unauthorized use of the ADASVC 0-call. Software AG recommends strongly that you run APF-authorized because of the security risks you can incur if you do not. However, upon request, Software AG does have a zap you can apply that eliminates this requirement. To determine what this zap number is, review the ZAPOPT member in the Adabas source library for a zap entitled "Remove requirement for APF authorization". If you choose not to have Adabas in an APF-authorized library, modules ADASIP, ADASIR and ADASVC must be copied to an APF-authorized library. Member JCLAPF in the MVSJOBS dataset has sample JCL that invokes z/OS utility IEBCOPY to copy them.
Note:
Some add-on products require APF authorization to use
restricted z/OS services. APF authorization is still required in these cases.
There are two authorization mechanisms: System Authorization Facility (SAF) and APF authorization. SAF is the z/OS standard interface to security products such as RACF, ACF2, and Top Secret. APF is the z/OS facility that allows programs from designated libraries to access restricted z/OS functions.
The SAF authorization check occurs first. It requests read access
to an entity in the FACILITY class or an alternative class specified via
ADASIP or ADASIR parameters when
installing the SVC. Refer to the discussion of
ADASIP
and ADASIR parameters.
ADABAS.SVCsss.IDddddd
The sss is the Adabas SVC number and ddddd is the DBID with leading zeros.
If the nucleus is using Adabas Cluster Services or Adabas Parallel Services, the entity has an additional level:
ADABAS.SVCsss.IDddddd.Nucnnnnn
The nnnnn is the value assigned by the ADARUN NUCID parameter with leading zeros.
The SAF security administrator can assign permissions to entities of this form with a wide range of specificity using a flexible array of patterning and wildcard characters. In general, it should not be necessary to enumerate each possible combination of SVC, DBID, and NUCID.
There are three possible outcomes to the SAF check: permission is explicitly granted, permission is explicitly denied, or the entity may be unknown to SAF. When the entity is unknown, APF authorization is required.
| APF Authorization Status | SAF Allow | SAF Deny | Unknown to SAF |
|---|---|---|---|
| APF authorized | Allow | ABEND U494 | Allow |
| Not APF authorized | Allow | ABEND U494 | ABEND U494 |
The ADASAF add-on product can also restrict access to a DBID/SVC combination (but not an Adabas Cluster Services or Adabas Parallel Services nucleus ID). ADASAF uses a different resource class and arranges the subfields in resource entities differently. You may choose to use either SAF mechanism, both, or neither. To maintain their existing behavior, current ADASAF users should not create ADABAS.SVC* resource profiles in the FACILITY class and need not change anything in their existing ADASAV configuration.
APF authorization requires that all libraries in the JOBLIB and STEPLIB concatenations have entries in the z/OS APF list. Systems programming staff typically administer the APF list.
Regardless of the installation procedure selected, an available SVC table entry must be allocated to the Adabas router (ADASVC). SVC table entries are defined in the member IEASVCxx of SYS1.PARMLIB.
The SVC table entry in the operating system for an ADASVC must contain the following information:
| Offset | Label | Description |
|---|---|---|
| 0 | SVCEP | SVC entry point address. |
| 4 | SVCATTR1 |
Must indicate type 2 SVC (flag bit SVCTP2 set—X’80’) or type 3 or 4 SVC (flag bits SVCTP34 set—X’C0’): ADASIR changes a type 1, 5, or 6 SVC to type 2. May indicate that APF-authorization is needed for this SVC (flag bit SVCAPF set—X’08’): if set, all targets and users must be APF-authorized. |
| 6 | SVCLOCKS | Must contain all zeros. ADASIR sets SVCLOCKS to zeros. |
The subsystem name contained in the four-character field SUBSYS at ADASVC offset X’28’ (the default is “ADAB”) must be the same as that specified in the IEFSSNxx member of SYS1.PARMLIB. If the name is not the same, ADASIR ends with an ADAS12 message and condition code 2, and Adabas is not usable.
If the Adabas SVC is to reside in the fixed LPA, add an entry to an IEAFIXxx member of SYS1.PARMLIB.
The Adabas SVC should be initialized with ADASIP/ADASIR in order to guarantee full functioning of all Adabas nuclei.
Sample jobs may be found in the MVSJOBS dataset from the Adabas installation tape.
to perform temporary router installation:
If the Adabas load library is not APF-authorized, customize sample job JCL APF to copy ADASIP, ADASIR and ADASVC into an APF-authorized library as authorized modules.
Execute ADASIP to install the SVC.
Customize and run the job ADASIP to dynamically add the Adabas SVC without an IPL.
Sample jobs may be found in the MVSJOBS dataset from the Adabas installation tape.
to perform permanent router installation:
If the Adabas library is not APF-authorized, customize sample job JCLAPF to copy ADASIP to an APF-authorized library.
Customize job JCLSVC step COPY to copy ADASVC to SYS1.LPALIB (or another library concatenated with it by SYS1.PARMLIB member LPALSTxx). Standard practice is to rename it according to z/OS SVC naming rules. For example, type 3/4 SVCs are named IGC00nnn, where nnn is the SVC number expressed as signed decimal digits. A signed decimal is a number ends in either of the following ways:
When the last digit of the SVC routine's load module name is a number from 1 - 9, specify a name that ends with the EBCDIC character (A-I) that corresponds with the last digit. For example, the name for type 3/4 SVC 249 is IGC0024I.
When the last digit of the SVC routine's load module name is zero, specify for the last character of the name the display representation of hexadecimal C0; in EBCDIC this is the left brace ({) character.
z/OS allows the type 3/4 naming convention to be overridden by the entry in SYS1.PARMLIB member IEASVCxx. The load module name specified in the IEASVCxx entry takes precedence. For example, if you have only one instance of ADASVC in the LPA libraries you may specify that name in IEASVCxx and leave the actual load module name unchanged.
If you wish to associate a subsystem name other than the default ADAB with ADASVC, customize sample job JCLSVC step SUBSYS to invoke IBM utility IMASPZAP to set the desired 4-character subsystem name.
Add a subsystem entry to SYS1.PARMLIB member IEFSSNxx for the subsystem name associated with the SVC. Customize and run the job JCLUPDT to add a new subsystem definition entry in the correct format.
Or:
Make the update with an on-line editor.
Customize sample job JCLSIR to copy ADASIR to SYS1.LINKLIB or a library concatenated with it by SYS1.PARMLIB member LKNLSTxx.
Note:
ADASIR is not reentrant, and therefore should not be
linked into SYS1.LPALIB or a library concatenated with it by SYS1.PARMLIB
member LKNLSTxx.
IPL z/OS with the CLPA option to install and initialize the Adabas communication environment.
ADASIP performs the following functions:
acquires memory in the specified CSA subpool for the Adabas SVC and a subsystem communication vector table (SSCT)
loads the Adabas SVC into the acquired CSA space
modifies the subsystem name at ADASVC offset +x’28’
modifies the SVC table entry as required by the Adabas SVC
optionally deletes an SSCT for the same subsystem name from the SSCT chain
adds the new SSCT to the SSCT chain
invokes the ADASIR program
releases CSA acquired by a previously installed SVC
If any error is detected, ADASIP backs out all completed activities and terminates operation with a user abend specifying the error.
When reinstalling an instance of ADASVC using an SVC number that is currently being used by ADASVC, the subsystem name must be the same as the one currently being used. This helps avoid a configuration that may not function correctly. For more information, read SVC Integrity Validation.
A Version 8 ADASIP/ADASIR can be used to install a Version 7 Adabas SVC, but the Version 8 SVC requires the Version 8 ADASIP/ADASIR. Software AG recommends using Version 8 to install all supported releases of the SVC. If an earlier version of ADASIP/ADASIR is used to replace an SVC installed with a later version, some areas of common storage may not be released.
If you choose not to have Adabas in an APF-authorized library, modules ADASIP, ADASIR and ADASVC must be copied to an APF-authorized library. Member JCLAPF in the MVSJOBS dataset has sample JCL that invokes IEBCOPY to copy them.
ADASIP parameters have the following syntax:
CONSNAME=c,IDTSPL=i,LEAVE=l,NRIDTES=n,REPLACE=r,SUBSYS=su, SVCNR=svcn,SVCSPL=svcs,RCLASS=class,FORCE=force
—where
| c | is the console name to which operator messages are written. If omitted, messages are issued using ROUTCDE=2, Master Console Information. |
| i | is the ID table subpool: see the ADASIR IDTSPL parameter for details. |
| l | indicates whether ADASIR should display message ADAS11 or ADAS12 on the operator console: see the ADASIR LEAVE parameter for details. |
| n | is the number of ID table entries: see the ADASIR NRIDTES parameter for details. |
| r | indicates whether or not an existing SSCT for the same subsystem name is to be replaced. Y for yes or N for no (N is the default). Use this option to replace any type of Adabas SVC (for example, when installing a new SVC version). |
| su | is the subsystem name. This parameter is required. . Each instance of the Adabas SVC must have a unique subsystem name. |
| svcn | is the Adabas SVC number: see the ADASIR SVCNR parameter for details. |
| svcs | is the Adabas SVC and SSCT subpool: 228 for fixed CSA or 241 for pageable CSA (default: 241). |
| class | is the System Authorizatin Facility (SAF) class name used to test authorization to start a target (default FACILITY). |
| force | allows certain possible errors to be
detected while validating parameters to be overridden. Use Y for
overriding or N for no overriding (N is the
default).
|
The following are valid ADASIP parameter abbreviations:
| Parameter | Abbreviation |
|---|---|
| CONSNAME= | C= |
| IDTSPL= | I= |
| LEAVE= | L= |
| NRIDTES= | N= |
| REPLACE= | R= |
| SUBSYS= | SU= |
| SVCNR= | SVCN= |
| SVCSPL= | SVCS= |
| RCLASS= | RC= |
| FORCE= | F= |
All parameters are optional except SUBSYS and SVCNR. If specified, the parameters IDTSPL,LEAVE, NRIDTES, SUBSYS, SVCNR, and RCLASS
are passed to ADASIR without being verified.
JCL similar to the following should be used to execute ADASIP:
// EXEC PGM=ADASIP,PARM=parameters //STEPLIB DD ... //SVCLIB DD ... //SIRLIB DD ...
There is a sample job in member JCLSIP of the MVSJOBS dataset.
The data set defined by the STEPLIB DD statement must be an APF-authorized library containing the APF-authorized program ADASIP. Since ADASIP is neither reentrant nor refreshable, the data set cannot be SYS1.LPALIB.
The data set defined by the SVCLIB DD statement must be an APF-authorized library containing the Adabas SVC with either the name or alias ADASVC.
The data set defined by the SIRLIB DD statement must contain the ADASIR program. Since ADASIR is neither reentrant nor refreshable, the data set may not be SYS1.LPALIB.
ADASIP terminates with a U0481 abend if the parameter input is incorrectly specified.
The ADASIP parameters may not fit on a single JCL statement and may be broken up into segments using continuation JCL statements. The IBM job control convention for continuing the PARM parameter is:
// EXEC PGM=ADASIP,PARM=(’parameters ....’, // ’parameters’)
Note these restrictions:
Enclose the entire PARM string in parentheses.
Place each segment of the PARM string in single quotes.
Break the PARM string before a comma that follows a parameter.
A comma is required after the end-quote on a line that is to be continued.
Start the continuation line within columns 4-16.
A comma is not permitted between the last parameter and the end-quote on the line to be continued because JCL automatically inserts a comma between parameters when concatenating continuation strings:
// ...PARM=(’CONSID=3’, // ’SUBSYS=ADAB’, // ’SVCNR=249’)
—results in an equivalent line of
CONSID=3,SUBSYS=ADAB,SVCNR=249
The ADASIR program is invoked
by the ADASIP program to install the Adabas SVC temporarily, or
by z/OS to install the Adabas SVC permanently.
ADASIR receives control during either master scheduler initialization or ADASIP execution. The operator is prompted for any value that has been incorrectly zapped or assembled (refer to the Adabas Messages and Codes for specific message descriptions). If an error is found during the processing of parameters specified in the IEFSSNxx member or passed by ADASIP, the operator is prompted for all of the values.
If the SVC table entry is incorrect, ADASIR prompts the operator for permission to change the entry (if SVCTAB=P, the default, is specified). If any errors are detected, they must be corrected and either another IPL must be done or ADASIP must be rerun before the Adabas SVC can be used.
ADASIR parameters have the following syntax:
IDTSPL=i,LEAVE=l,NRIDTES=n,SVCNR=svcn,SVCTAB=svct,RCLASS=class
| Variable | Description |
|---|---|
| i | The ID table subpool: 228 for fixed CSA or 241 (the default) for pageable CSA. |
| l | Indicates whether message ADAS11 or ADAS12 is to be displayed on the operator console: Y for yes or N (the default) for no. |
| n | The ID table entry count, which can range from 1 to a maximum specified at offset X’146’ in the CSECT IEAVESVT of the z/OS nucleus (see section Requirements for Cross-Memory Services). |
| svcn | The Adabas SVC number (200-255). |
| svct | Indicates whether or not the operator should be prompted for permission to update the SVC table entry. Enter P (the default) to receive a prompt, or N for no prompt. P is recommended if a possibility exists that the SVC table entry will not be what ADASIR expects. |
| class | is the System Authorizatin Facility (SAF) class name used to test authorization to start a target (default FACILITY). |
The following are valid abbreviations for ADASIR parameters:
| Parameter | Abbreviation |
|---|---|
| IDTSPL= | I= |
| LEAVE= | L= |
| NRIDTES= | N= |
| SVCNR= | SVCN= |
| SVCTAB= | SVCT= |
| RCLASS= | RC= |
Customize sample job JCLSIR to copy ADASIR to SYS1.LINKLIB or a library concatenated with it by SYS1.PARMLIB member LKNLSTxx.
Note:
ADASIR is not reentrant, and therefore should not be placed
into SYS1.LPALIB or a library concatenated with it by SYS1.PARMLIB member
LKNLSTxx.
To prepare for permanent SVC installation, an entry must be made in either a new or existing member having the name IEFSSNxx in SYS1.PARMLIB. This entry is an 80-character record with the following format:
SUBSYS SUBNAME(cccc) CONSNAME(consname) INITRTN(ADASIR) INITPARM(’parameters’) comments
—where
| cccc | The 1- to 4-character subsystem name. This name and the name specified in the Adabas SVC at offset X’28’ must be the same. The name provided in the SVC is ADAB; any other name must first be zapped into the SVC before being specified for cccc. |
| consname | The name of the console to which ADASIR will direct any messages. If omitted messages will be issued with ROUTCDE=2, Master Console Information. |
| ’parameters’ | ADASIR parameters. If there is more than one parameter, values must be enclosed in single quotation marks and a comma placed between the parameters. |
| comments | Comments are optional and must be preceded by at least one space. |
If the subsystem name does not match, ADASIR abends with an ADAS12 message and condition code 2; the Adabas z/OS communication environment is not initialized. Re-IPL z/OS, specifying SSN=xx if necessary. If this is the first IPL with a type 3 or 4 Adabas SVC, specify CLPA as one of the SET parameters.
If an error is encountered while processing any of the parameters obtained from the IEFSSNxx member or passed from ADASIP (message ADAS05), the operator is prompted to reenter all of the parameters. If the SVC table entry is not correct (message ADAS09) then, depending on the value of the SVCTAB parameter, either the operator is prompted (message ADAS10) for permission to change the SVCTAB parameter, or it is simply changed (message ADAS15).
A Version 8 ADASIR can be used to install a Version 7 Adabas SVC, but the Version 8 SVC requires the Version 8 ADASIR. Software AG recommends using Version 8 to install all supported releases of the SVC.
In the past, the presence of multiple SVCs with the same subsystem ID has resulted in a single ID table being used by different SVCs. This has caused problems, some of them , such as abnormal nucleus termination or corruption of the database.
To eliminate this exposure, ADASVC checks to ensure that the SVC accessing the ID table is the same as the one that was used by ADASIP/ADASIR to initialize the table. If the SVCs are not the same, the IDT is not accessed.
The lack of a usable IDT may occur during Adabas initialization, during the first Adabas call from a user program, or when the ID table is queried by another Software AG server such as Entire Net-Work.
ADASIP has been enhanced to prevent this from arising. If you attempt to install an instance of ADASVC using an SVC number that is presently associated with another subsystem name, message ADAS16 is issued and ADASIP terminates with user abend 435.
When installing or reinstalling ADASVC, ADASIP will also detect if
there is an Adabas SVC already installed as the specified SVC number that
specifies a different subsystem than specified by the SUBSYS parameter. This
causes message ADAS16 to
be issued and ADASIP terminates with user abend 436. This abend can be
overridden by specifying the FORCE=Y
parameter.
If the specified SVC exists and has an IDT where there are active
targets (as indicated by an active IDTE), message
ADAS17 is issued for
each such target and ADASIP terminates with user abend 437. This abend can be
overridden by specifying the FORCE=Y
parameter but doing so may cause the targets to abend when they try to access
the IDT. Using the FORCE=Y parameter should only be
necessary in rare conditions when a target failed in such a way that the IDT
could not be cleaned up.
Due to the implementation of cross-memory services in z/OS, the following points should be noted when running an Adabas nucleus in MULTI mode:
a maximum of one step of a job can establish the cross-memory environment. This means that a job can include at most one step that is a target (for example, an Adabas nucleus).
cross-memory accesses may not be made to a swapped-out address space. Therefore, the address space of an Adabas nucleus is set to "nonswappable" for the duration of the nucleus session. This can increase the installation's real storage requirements. This behavior is documented in the IBM manual Extended Addressability Guide, chapter Synchronous Cross-Memory Communication.
when a nucleus with an active cross-memory environment terminates either normally or abnormally, the entire address space including any initiator is also terminated.
The ASID representing this address space is not reassigned until the next IPL. Therefore, you should choose a sufficiently high value for the MAXUSERS parameter in the active IEASYSxx member of SYS1.PARMLIB or - if your system supports it - the RSVNONR parameter in the same member can be adjusted accordingly. Also, the Adabas nucleus should not be stopped and started without good reason.
This is described in the manuals referred to in the topics Recovery Considerations and Resource Management. Additional information can be found in IBM APARs OZ61154, OZ61741, and OZ67637.
To make its services available to all address spaces in the system, the Adabas nucleus must obtain a system linkage index (LX) from z/OS. The LX is a reserved slot in the linkage space of all address spaces, and permits system-wide linkage to all address spaces.
If your configuration is using z/OS 1.6 or later and your hardware supports the Address Space and LX Reuse Facility (ALRF), the version 8 ADASVC will make use of reusable system LXs. Otherwise, a non-reusable system LX will be used as in previous releases. Reusable system LXs resolve the constraints imposed by non-reusable LXs. The remainder of this section discusses these constraints.
The number of non-reusable LXs set aside by z/OS for system use is rather small (usually 165 out of a possible 2048).
Because of the way z/OS use cross-memory services, non-reusable system LXs obtained by Adabas cannot be returned to z/OS until the next IPL. However, the system that owns the LXs can reuse them, even for a different address space. Adabas makes use of this feature by identifying used LXs in a table in CSA, where they are available to future nuclei.
The number of non-reusable system LXs can be specified in the member IEASYSxx contained in SYS1.PARMLIB, using the NSYSLX parameter. If you change this value, you must perform an IPL to make the change effective.
To determine an appropriate NSYSLX value, consider the following points:
some LXs are probably already being used by other system functions. Therefore, the chances of creating an LX shortage for other users is small.
Adabas requires one system LX for each Adabas nucleus (or any other target) that will be active concurrently. A value of decimal 64 would allow concurrent execution of up to 64 Adabas nuclei or other targets with little chance of restricting other components using LXs.
Entire Net-Work Version 5 uses only one LX and one ID table entry, regardless of how many remote databases it must represent. This is unlike the pseudo-MPM concept of earlier Entire Net-Work versions.
whenever ADASIP is executed with the REPLACE option, all LXs saved in the current ID table are lost until the next IPL.
Likewise, if a session ends either normally with the FORCE operator command or abnormally during ESTAE processing (for example, by an S222 operator cancel or by a S722 spool limit exceeded abend during a snap dump), the LX also cannot be recovered until the next IPL.
Any commands sent to these targets receive an S0D6 abend. Any attempt to restart the nucleus results in an ADAM98 message DUP ID (LOCAL), followed by an abend. To resolve both of these problems, restart the nucleus with the ADARUN FORCE=YES and IGNDIB=YES parameters.
The first target that tries to obtain a system LX when none is available ends with an S053 abend code and reason code 0112. No additional targets can be started until the next IPL.
Use the z/OS AMASPZAP utility to apply zaps in the respective operating system; this method verifies (VER) and replaces (REP) data. The following sample JCL executes AMASPZAP:
//ADAZAP JOB //STEP1 EXEC PGM=AMASPZAP //SYSPRINT DD SYSOUT=X //SYSLIB DD DSN=ADABAS.ADAvrs.LOAD,DISP=SHR //SYSIN DD * (zap control statements) /* //
—where the following are examples of zap control statements:
NAME membername csectname VER displacement data REP displacement data IDRDATA (up to eight bytes of user data) * (comment)
Note:
In VER and REP statements, spaces must be used to separate
command, displacement, and data. Commas are acceptable data separators;
however, commas with spaces or spaces alone are not, and may cause
errors.