tcl.list-locks Verb: Access/TCL

tcl.list-locks

Command tcl.list-locks Verb: Access/TCL
Applicable release versions: AP, AP 6.1, AP 6.2
Category TCL (746)
Description displays the current status of all system, Pick/BASIC, Spooler, group and item locks.

All locks are displayed automatically unless one or more of the available options is provided with the command.

"System" Locks are the 10 internal system locks used during saves and etc.:

### This lock position is unused.
nnn The port.number using this lock position.

"Basic" Locks are the 64 Pick/BASIC program execution locks (used by Pick/BASIC programs).:

### This lock position is unused.
nnn The port.number using this lock position.

"Spooler" Locks are the internal spooler locks:

mq Master Queue Lock
iq Input Queue Lock
fq Forms Queue Lock
peq Permanent Entry Queue Lock

"Group" Locks:

nnnnn The frame-id, in decimal.
(nnnnnn) The frame-id (in hexadecimal).
Pib# The pib# (port) who has the item locked.
Lvl The level on which this group is locked.
Type The type of group lock. This may be either Rdo (for Read-Only) or Upd (for Update).
Filename The file in which the group exists.

"Item" Locks

nnnnn The frame-id, in decimal.
(nnnnnn) The frame-id (in hexadecimal).
PIB# The pib# (port) who has this item locked.
Lvl The owner's push-level number.
Hash The locked item's hash code.
Item-id The item-id which is currently locked.
Filename The name of the file where the item resides.

"File" Locks are special item locks which affect the whole file. These locks prevent any updates or normal items locks to a file while in effect. File locks are displayed in the item lock listing as having item id's of "*" and hashes of "0". These locks are set with the BASIC "filelock" statement.

When displaying item locks (by using the "i" option, it is optionally possible to display the locks of a remote Pick machine by specifying the host name. If a "*" is specified for the host name, then list-locks attempts to list the locks on all remote hosts. (ap 6.2 and above)
Syntax list-locks {host|*} {(options)}
Options fid Displays item-lock status for the group starting at the specified frame-id (fid). (R83 only).

b Displays the 64 Pick/BASIC execution locks. (ap)

g Displays group locks only.

h Displays host information instead of the group of item locks. This is useful for server systems for displaying the client host, pib, and level for each lock. (ap 6.2 and above)

i Displays item-locks only.

p Directs output to system printer, via the Spooler.

q Displays the 4 Spooler queue locks. (ap)

r Displays remote item locks held by local processes. Note that these are "potential" locks and that they may list locks not actually held on the server if those locks have been removed in an abnormal fashion. (ap 6.2 and above)

s Displays the 10 system locks. (ap)
Example
list-locks (i
Item Locks          PIB#  Lvl  Hash  Item-id              Filename
5834   (0016CA)     54   0   7E2C    21086                orders
2746   (000ABA)     68   0   0D1F    roy/month2           memos
183325 (02CC1D)     29   1   5DD7    3242                 entity
183197 (02CB9D)     22   2   7D9F    20946                entity
184453 (02D085)     66   0   279F    73291176             entity
110819 (01B0E3)     42   0   084D    tcl.list-locks       ap.doc
110908 (01B13C)      3   0   3E36    data.representation  ap.doc
133899 (020B0B)     82   0   6C2C    monitor              status

In this example, the display is limited to the current item locks.

list-locks
System Locks
   0   1   2   3   4   5   6   7   8   9   A   B   C   D   E   F 
0 ### ### ### ### ### ### ### ### ### ### ### 

Basic Locks
   0   1   2   3   4   5   6   7   8   9   A   B   C   D   E   F 
0 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### 
1 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### 
2 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### 
3 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### 

Spooler Locks
   mq  iq  fq peq
0 ### ### ### ### 

Group Locks        PIB#  Lvl  Type  Filename
442384 (06C00F)     13    1    Upd   xsym

Item Locks         PIB#  Lvl  Hash  Item-id            Filename
123034 (01E09A)     23    1 54B898A5 wm                email
79174  (013546)     57    0 9472A038 hv                tcl-stack

In this example, all locks are shown.
Purpose
Related locking.scheme
tcl.list-locks_rp
spooler.locks
tcl.list-lockq
filename.hosts
tcl.unlock-file
basic.filelock