Programming Interface Information: This information is NOT intended to be
used as Programming Interfaces of z/VM.

LGNBK

Prolog  

Control Block Contents  
   LGNBK DSECT

Storage Layout  

Cross Reference (Contains links to field and bit definitions)  


LGNBK Prolog

 NAME       : HCPLGNBK
 DESCRIPTION: LOGON work buffer
 DSECT      : LGNBK
 FUNCTION   : Used by the LOGON/(X)AUTOLOG code as a work area
              for LOGON/(X)AUTOLOG processing.
 LOCATED BY : NONE
 CREATED BY : HCPAUT   HCPLOG
 DELETED BY : HCPLGB

 

LGNBK Control Block Content


LGNBK DSECT

Hex   Dec Type/Val   Lng Label (dup)    Comments
---- ---- --------- ---- -------------- --------
0000    0 Structure      LGNBK          LOGON work buffer
0000    0 Signed       4 LGNFLGS (0)    Parameter flags for logon
0000    0 Bitstring    1 LGNFLAG        Command line option flag 1
          1... ....      LGNAUTO        X'80' An AUTOLOG command in
                                        process
          .1.. ....      LGNNOIPL       X'40' No system IPL to be
                                        performed
          ..1. ....      LGNAPL         X'20' APL option specified
          ...1 ....      LGNTEXT        X'10' TEXT option specified
          .... 1...      LGNQUIET       X'08' QUIET option specified
          .... .1..      LGNDATA        X'04' Data line present with
                                        command
          .... ..1.      LGNIPL         X'02' IPL option specified
          .... ...1      LGNNORUN       X'01' NORUN option specified
0001    1 Bitstring    1 LGNFLAG2       Command line option flag 2
          1... ....      LGNPASS        X'80' PASSWORD option specified
          .1.. ....      LGNPROMT       X'40' PROMPT option specified
          ..1. ....      LGNDIRCT       X'20' DIRECTORY option specified
          ...1 ....      LGNHERE        X'10' HERE option specified
          .... 1...      LGNSYNCH       X'08' SYNCH option specified
          .... .1..      LGNMASK        X'04' Mask option specified
          .... ..1.      LGNSECLB       X'02' SECLABEL option specified
          .... ...1      LGNMCH         X'01' MACHINE option specified
0002    2 Bitstring    1 LGNFLAG3       Program execution flag 1
          1... ....      LGNNOFAT       X'80' Nonfatal error - return to
                                        caller
          .1.. ....      LGNRECON       X'40' User to be reconnected
          ..1. ....      LGNMAXU        X'20' This user is allowed to
                                        LOGON even if the maxusers limit
                                        has been exceeded.
          ...1 ....      LGNIS663       X'10' Issued message 663 to user
                                        already
          .... 1...      LGNASYNC       X'08' Processing Asynchronous
                                        XAUTOLOG
          .... ..1.      LGNALOGS       X'02' Autolog process - first
                                        pass through (X)AUTOLOG/LOGON
                                        modules
          .... ...1      LGNDLOCK       X'01' User directory entry is
                                        locked
0003    3 Bitstring    1 LGNFLAG4       Program execution flag 2
          1... ....      LGNDFRWK       X'80' Indicates that the deferred
                                        work counter for target VMDBK of
                                        a reconnect has been incremented.
          ...1 ....      LGNNOCSA       X'10' Indicate no CSABK or domain
          .... 1...      LGNNOCRY       X'08' Indicate no real crypto
                                        facility
          .... .1..      LGNNOCMD       X'04' Indicates this is a dummy
                                        logon from the LOGO panel.
          .... ..1.      LGNNAUDT       X'02' Indicates that
                                        LOGON/(X)AUTOLOG has gone far
                                        enough that HCPLGALF should no
                                        longer be called.
          .... ...1      LGNNOPAS       X'01' Password=NOPASS in the
                                        directory.
0004    4 Bitstring    1 LGNFLAG5       Logon work area flag 5
          1... ....      LGNAUTH        X'80' User passed password(ESM)
                                        check so we need to call HCPJRLOG
          .1.. ....      LGNBADPW       X'40' User fail password(ESM)
                                        check so we need to call HCPJRLPW
          ..1. ....      LGNPRMPT       X'20' Causes HCPLGALF to display
                                        logon prompt on exit.
          ...1 ....      LGNNOPMT       X'10' Do not force the user even
                                        though we should not display the
                                        logon prompt.
          .... 1...      LGNLOGBY       X'08' A BYUSER entered the LOGON
                                        command
0005    5 Bitstring    1 LGNCMD
          00000004       LGNLOGON       X'04' This is a LOGON command
          00000008       LGNAUTOL       X'08' This is an AUTOLOG command
          0000000C       LGNXAUT        X'0C' This is a CLASS A or B
                                        XAUTOLOG
          00000010       LGNXAUTG       X'10' This is a CLASS G XAUTOLOG
          00000014       LGNAUTSI       X'14' This is a system
                                        initialization autolog.
          00000018       LGNAUTPR       X'18' This is a TSAF private
                                        server autolog.
          0000001C       LGNLOGOP       X'1C' This is the operator
                                        logging on system initialization.
          00000000       *
0006    6 Bitstring    1 LGNMLVL
          1... ....      VMDMSGON       X'80' CONTROLS WHETHER MESSAGES
                                        SENT BY OTHER USERS ARE
                                        DISPLAYED. (CONTROLLED BY THE SET
                                        MSG OR TERMINAL MSG COMMANDS)
          .1.. ....      VMDWNGON       X'40' CONTROLS WHETHER MESSAGES
                                        SENT USING THE WARNING COMMAND
                                        ARE DISPLAYED. (CONTROLLED BY THE
                                        SET WNG OR TERMINAL WNG COMMANDS)
          ..1. ....      VMDMCODE       X'20' CONTROLS ERROR MESSAGE
                                        DISPLAY OF THE ERROR MESSAGE
                                        CODE. (CONTROLLED BY THE SET EMSG
                                        OR TERMINAL EMSG COMMANDS)
          ...1 ....      VMDMTEXT       X'10' CONTROLS ERROR MESSAGE
                                        DISPLAY OF THE ERROR MESSAGE
                                        TEXT. (CONTROLLED BY THE SET EMSG
                                        OR TERMINAL EMSG COMMANDS)
          .... 1...      VMDSPMSG       X'08' CONTROLS WHETHER SPECIAL
                                        MESSAGES SENT BY OTHER USERS CAN
                                        BE RECEIVED. (CONTROLLED BY THE
                                        SET SMSG COMMAND)
          .... .1..      VMDMIMSG       X'04' CONTROLS THE DISPLAY OF
                                        SELECTED CP COMMAND INFORMATIONAL
                                        RESPONSES. IF SET THE RESPONSES
                                        ARE DISPLAYED, IF NOT THE
                                        RESPONSES WILL NOT BE DISPLAYED.
                                        (CONTROLLED BY THE SET IMSG AND
                                        TERMINAL IMSG COMMANDS)
          .... ...1      VMDMCNFG       X'01' Message level set from
                                        system configuration file
0007    7 Bitstring    1 *              Reserved for IBM use
0008    8 Character    8 LGNACNUM       Account number
0010   16 Signed       4 LGNILEN        IPL command length
0014   20 Address      4 LGNIADDR       IPL command address
0018   24 Address      4 LGNDVMD        Directory buffer address
001C   28 Address      4 LGNCDATA       Pointer to console input data.
0020   32 Signed       4 LGNCDATL       Length of console input data.
0028   40 Dbl-Word     8 LGNKSTOR       Storage size in K
0028   40 Signed       4 LGNKSTR0       High word of LGNKSTOR
002C   44 Signed       4 LGNKSTR1       Low word of LGNLSTOR
0030   48 Character    3 LGNMACH        Machine setting (i.e. 370, etc)
0033   51 Bitstring    1 LGNDDEF        Maps to DVMDDEF
          1... ....      DVMDXSTR       X'80' EXTENDED STORAGE FACILITY
                                        ALLOWED
          .1.. ....      DVMDNOP        X'40' 'NOPDATA' STATEMENT IN
                                        ENTRY
          ..1. ....      DVMDNLG        X'20' VIRTUAL MACHINE'S PSWD IS
                                        NOLOG
          ...1 ....      DVMDVXC        X'10' GUEST IS A VIRTUAL ESA/XC
                                        MACHINE
          .... 1...      DVMDVESA       X'08' GUEST IS A VIRTUAL ESA
          .... .1..      DVMDYES        X'04' USER HAS AT LEAST ONE DDEV
          .... ..1.      DVMDVXA        X'02' GUEST IS A VIRTUAL XA
          .... ...1      DVMDV370       X'01' GUEST IS A VIRTUAL 370
0034   52 Signed       4 LGNVMDBK       VMDBK address of target VMDBK for
                                        a reconnect.
0038   56 Signed       4 LGNTODON       VMDTODON of the target VMDBK for
                                        a reconnect.
003C   60 Address      4 LGNEFTID       The address of the effective
                                        userid that is causing a LGNAUTPR
                                        autolog to be done.
     This following is the paramter section for HCPRPWRD.
0040   64 Dbl-Word     8 LGNPWDPM (0)   Parameters for HCPPWDRD
0040   64 Address      4 LGNPWDIN       Address of input password area
0044   68 Address      4 LGNPWDPP       Address of the password prompt
0048   72 Bitstring    1 LGNPWLEN       Password length
     The following byte is to manage the fretting for the LGNBK and its
     related control blocks. It is zero if this process should not fret the
     LGNBK and is X'FF' if this process should fret the LGNBK. It is updated
     with TEST AND SET.
0049   73 Bitstring    1 LGNFRET        Fret byte...
004A   74 Bitstring    2 *              Alignment
004C   76 Character  139 LGNBUFF        Message buffer (see description
                                        on the next page)
00D7  215 Bitstring    1 *              Alignment
00D8  216 Character    5 LGNLNG         Language ID Work Area for HCPLGN
00DD  221 Bitstring    3 *              Reserved for IBM use
00E0  224 Dbl-Word     8 LGNACIPM (0)   Area for ACIPARMS
          0000001C       LGNBKL         (*-LGNBK+7)/8 Size of LGNBK in
                                        doublewords
     LGNBUFF - Buffer/work area for constructing message substitution data.
     The first field in this area (MSGPDUID) contains the userid padded with
     blanks (if necessary) of the user being logged on. This field is
     constructed from the userid on the command line and is preserved
     throughout the process of logging on the user. It is used for a couple
     of purposes. First, it is used as input to all routines requiring a
     userid (such as HCPUDR). Second, it is used as substitution data for
     the "tag" placed on messages issued for the asynchronous XAUTOLOG
     command. For this reason, it is immediately followed by a delimiter
     (initially set to X'FF').
     Immediately following MSGPDUID and its delimiter (MSGPUDLM), all other
     substitution data for "tagged" and untagged messages are constructed.
     This area is labelled MSGSUB. The first field (that is always
     constructed at the same time as MSGPDUID) is MSGUID, which contains the
     userid with trailing blanks removed. It is delimited with X'FF'. This
     the most common substitution data in messages issued by these modules.
     This field should not be overlaid when issueing non-fatal messages
     because it may be required by a subsequent fatal error message.
     For fatal error messages having substitution data other than the
     userid, the substitution data should be constructed starting at label
     MSGSUB (overlaying the userid). This area may be redefined in a
     particular module for various messages to be issued by the module. This
     is done in the module by placing the local definitions following this
     mapping and using an ORG MSGSUB in front of the definition(s) for each
     message.
     For non-fatal (informational) messages, MSGUID should not be overlaid.
     In these cases, start building the substitution data at label MSGODATA.
     Use of the message buffer area:
     - For "tagged" asynchronous XAUTOLOG messages with no substitution data
     other than in the tag, point R1 to the field MSGPDUID.
     - For "tagged" asynchronous XAUTOLOG messages with substitution data in
     the basic message text, change the delimiter MSGPUDLM to X'00' and
     point R1 to the field MSGPDUID.
     - For untagged error messages with substitution data, point R1 to the
     field MSGSUB.
     - For informational (non-fatal) messages with substitution data, point
     R1 to the field MSGODATA.
004C   76 Character    8 LGNPDUID       Padded userid
0054   84 Character    1 LGNPUDLM       Userid delimiter
0055   85 Character    1 LGNSUB (0)     Message substitution fields
0055   85 Character    8 LGNUID         Non-padded userid for messages
005D   93 Character    1 LGNUIDLM       Userid delimiter
005E   94 Character    1 LGNODATA (0)   Other substitution data
     Some overlays used by different messages.
0055   85 Character    8 LGNLUNAM       LUNAME
005D   93 Character    1 LGNLUEND       Message substitution end
                                        delimiter
0055   85 Character    5 LGNDVADR       Device address
005A   90 Character    1 LGNDVEND       Message substitution end
                                        delimiter
0055   85 Character    8 LGNSYSNM       "Other" system name
005D   93 Character    1 LGNSYSND       Message substitution end
                                        delimiter Substitutions unique to
                                        message 1513
0055   85 Character    4 LGN13DNA       Device name
0059   89 Character    1 LGN13DL1       Substitution delimiter
005A   90 Character    5 LGN13DNU       Device number
005F   95 Character    1 LGN13END       Message substitution end
                                        delimiter
     Here are some constants used by logon.
          .... .1..      LGNLIMIT       X'04' Number of LOGON cmds before
                                        a skeleton is forced.
          .... ...1      LGNPWLMT       X'01' Number of times to prompt
                                        for a password.

 

LGNBK Storage Layout

          
*** LGNBK - LOGON work buffer
*
*     +------+------+------+------+------+------+------+------+
*   0 |:FLAG |:FLAG2|:FLAG3|:FLAG4|:FLAG5|LGNCMD|:MLVL |//////|
*     +------+------+------+------+------+------+------+------+
*   8 |                       LGNACNUM                        |
*     +---------------------------+---------------------------+
*  10 |         LGNILEN           |         LGNIADDR          |
*     +---------------------------+---------------------------+
*  18 |         LGNDVMD           |         LGNCDATA          |
*     +---------------------------+---------------------------+
*  20 |         LGNCDATL          |///////////////////////////|
*     +---------------------------+---------------------------+
*  28 |                       LGNKSTOR                        |
*     +-------------------------------------------------------+
*  30
*
*** LGNBK - LOGON work buffer
          
*** Overlay for LGNKSTOR in LGNBK
*
*     +---------------------------+---------------------------+
*  28 |         LGNKSTR0          |         LGNKSTR1          |
*     +--------------------+------+---------------------------+
*  30 |      LGNMACH       |:DDEF |         LGNVMDBK          |
*     +--------------------+------+---------------------------+
*  38 |         LGNTODON          |         LGNEFTID          |
*     +---------------------------+---------------------------+
*  40 |         LGNPWDIN          |         LGNPWDPP          |
*     +------+------+-------------+---------------------------+
*  48 |:PWLEN|:FRET |/////////////|                           |
*     +------+------+-------------+                           |
*  50 |                                                       |
*     =                       LGNBUFF                         =
*     |                                                +------+
*  D0 |                                                |//////|
*     +----------------------------------+-------------+------+
*  D8 |             LGNLNG               |////////////////////|
*     +----------------------------------+--------------------+
*
*** Overlay for LGNKSTOR in LGNBK
          
*** Overlay for LGNBUFF in LGNBK
*
*                                 +---------------------------+
*     ...                      4C |        LGNPDUID-          |
*     +---------------------------+------+--------------------+
*  50 |          -(04C)           |:PUDLM|      (055)-        |
*     +---------------------------+------+------+-------------+
*  58 |             -LGNUID              |:UIDLM|
*     +----------------------------------+------+
*
*** Overlay for LGNBUFF in LGNBK
          
*** Overlay for LGNSUB in LGNBK
*
*                                        +--------------------+
*     ...                             55 |      (055)-        |
*     +----------------------------------+------+-------------+
*  58 |            -LGNLUNAM             |:LUEND| 5E
*     +----------------------------------+------+
*
*** Overlay for LGNSUB in LGNBK
          
*** Overlay for LGNSUB in LGNBK
*
*                                        +--------------------+
*     ...                             55 |     LGNDVADR-      |
*     +-------------+------+-------------+--------------------+
*  58 |   -(055)    |:DVEND| 5B
*     +-------------+------+
*
*** Overlay for LGNSUB in LGNBK
          
*** Overlay for LGNSUB in LGNBK
*
*                                        +--------------------+
*     ...                             55 |      (055)-        |
*     +----------------------------------+------+-------------+
*  58 |            -LGNSYSNM             |:SYSND| 5E
*     +----------------------------------+------+
*
*** Overlay for LGNSUB in LGNBK
          
*** Overlay for LGNSUB in LGNBK
*
*                                        +--------------------+
*     ...                             55 |     LGN13DNA-      |
*     +------+------+--------------------+-------------+------+
*  58 |-(055)|:13DL1|            LGN13DNU              |:13END|
*     +------+------+----------------------------------+------+
*  60
*
*** Overlay for LGNSUB in LGNBK

 

LGNBK Cross Reference

Symbol         Dspl Value
-------------- ---- -----
*              0005 00000000
DVMDNLG        0033 20
DVMDNOP        0033 40
DVMDVESA       0033 08
DVMDVXA        0033 02
DVMDVXC        0033 10
DVMDV370       0033 01
DVMDXSTR       0033 80
DVMDYES        0033 04
LGNACIPM       00E0
LGNACNUM       0008
LGNALOGS       0002 02
LGNAPL         0000 20
LGNASYNC       0002 08
LGNAUTH        0004 80
LGNAUTO        0000 80
LGNAUTOL       0005 00000008
LGNAUTPR       0005 00000018
LGNAUTSI       0005 00000014
LGNBADPW       0004 40
LGNBKL         00E0 0000001C
LGNBUFF        004C
LGNCDATA       001C
LGNCDATL       0020
LGNCMD         0005
LGNDATA        0000 04
LGNDDEF        0033
LGNDFRWK       0003 80
LGNDIRCT       0001 20
LGNDLOCK       0002 01
LGNDVADR       0055
LGNDVEND       005A
LGNDVMD        0018
LGNEFTID       003C
LGNFLAG        0000
LGNFLAG2       0001
LGNFLAG3       0002
LGNFLAG4       0003
LGNFLAG5       0004
LGNFLGS        0000
LGNFRET        0049
LGNHERE        0001 10
LGNIADDR       0014
LGNILEN        0010
LGNIPL         0000 02
LGNIS663       0002 10
LGNKSTOR       0028
LGNKSTR0       0028
LGNKSTR1       002C
LGNLIMIT       005F 04
LGNLNG         00D8
LGNLOGBY       0004 08
LGNLOGON       0005 00000004
LGNLOGOP       0005 0000001C
LGNLUEND       005D
LGNLUNAM       0055
LGNMACH        0030
LGNMASK        0001 04
LGNMAXU        0002 20
LGNMCH         0001 01
LGNMLVL        0006
LGNNAUDT       0003 02
LGNNOCMD       0003 04
LGNNOCRY       0003 08
LGNNOCSA       0003 10
LGNNOFAT       0002 80
LGNNOIPL       0000 40
LGNNOPAS       0003 01
LGNNOPMT       0004 10
LGNNORUN       0000 01
LGNODATA       005E
LGNPASS        0001 80
LGNPDUID       004C
LGNPRMPT       0004 20
LGNPROMT       0001 40
LGNPUDLM       0054
LGNPWDIN       0040
LGNPWDPM       0040
LGNPWDPP       0044
LGNPWLEN       0048
LGNPWLMT       005F 01
LGNQUIET       0000 08
LGNRECON       0002 40
LGNSECLB       0001 02
LGNSUB         0055
LGNSYNCH       0001 08
LGNSYSND       005D
LGNSYSNM       0055
LGNTEXT        0000 10
LGNTODON       0038
LGNUID         0055
LGNUIDLM       005D
LGNVMDBK       0034
LGNXAUT        0005 0000000C
LGNXAUTG       0005 00000010
LGN13DL1       0059
LGN13DNA       0055
LGN13DNU       005A
LGN13END       005F
VMDMCNFG       0006 01
VMDMCODE       0006 20
VMDMIMSG       0006 04
VMDMSGON       0006 80
VMDMTEXT       0006 10
VMDSPMSG       0006 08
VMDWNGON       0006 40

This information is based on z/VM V4R1.0.
Last updated on 6 Jun 2001 at 11:45:39 EDT.
Copyright IBM Corporation, 1990, 2001