DEBUGUL parameter: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
m (misc formatting)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:DEBUGUL parameter subtitle}}
==Summary==
==Summary==
<dl>
<dl>
Line 12: Line 14:
<dd><var class="product">Model 204 V6.1</var> or earlier
<dd><var class="product">Model 204 V6.1</var> or earlier
</dl>
</dl>
==Description==
==Description==
<p>Included procedures can accompany evaluation time <var class="product">Model&nbsp;204</var> error messages</p>
<p>
<p>You can display the names of the procedures that were included up to the point of the evaluation time error on the audit trail or at your terminal. </p>
Included procedures can accompany evaluation time <var class="product">Model&nbsp;204</var> error messages</p>
<p>The DEBUGUL settings and their effects are: </p>
<p>
You can display the names of the procedures that were included up to the point of the evaluation time error on the audit trail or at your terminal. </p>
<p>
The <var>DEBUGUL</var> settings and their effects are: </p>
<table>
<table>
<tr><th>Setting</th><th>Displays procedure list...</th></tr>
<tr class="head"><th>Setting</th><th>Displays procedure list...</th></tr>
<tr><th align="right"><var>X'20'</var></th><td>After warning messages about truncation for User Language WITH operator string concatenations greater than 255 bytes </td></tr>
 
<tr><th align="right"><var>X'10' </var></th><td>Debug messages on user's terminal in addition to audit trail.</td></tr>
<tr><th><var>X'20'</var></th>
<tr><th align="right"><var>X'08' </var></th><td>After errors (other than counting errors) that terminate execution of the request</td></tr>
<td>After warning messages about truncation for User Language WITH operator string concatenations greater than 255 bytes </td></tr>
<tr><th align="right"><var>X'04' </var></th><td>After counting errors that terminate execution of the request </td></tr>
 
<tr><th align="right"><var>X'02'</var></th><td>After counting errors that do not terminate execution of the request </td></tr>
<tr><th><var>X'10' </var></th>
<tr><th align="right"><var>X'01' </var></th><td>After informational messages </td></tr>
<td>Debug messages on user's terminal in addition to audit trail.</td></tr>
<tr><th><var>Any nonzero</var></th><td>After a snap or a dump</td></tr>
 
<tr><th align="right"><var>X'00'</var></th><td>Does not display procedure list</td></tr>
<tr><th><var>X'08' </var></th>
<td>After errors (other than counting errors) that terminate execution of the request</td></tr>
 
<tr><th><var>X'04' </var></th>
<td>After counting errors that terminate execution of the request </td></tr>
 
<tr><th><var>X'02'</var></th>
<td>After counting errors that do not terminate execution of the request </td></tr>
 
<tr><th><var>X'01' </var></th>
<td>After informational messages </td></tr>
 
<tr><th nowrap><var class="term">Any nonzero</var></th>
<td>After a snap or a dump</td></tr>
 
<tr><th><var>X'00'</var></th>
<td>Does not display procedure list</td></tr>
</table>
</table>
====DEBUGUL and error messages display====
 
<p>When DEBUGUL is set to x'10', <var class="product">Model&nbsp;204</var> forces the error message along with the DEBUGUL messages to the user's terminal regardless of the setting of MSGCTL. However, if an error message is normally suppressed from going to the user's terminal through the use of NOTERM (or by default it is not displayed) then the DEBUGUL messages are suppressed regardless of the setting of DEBUGUL.</p>
==Usage==
====How the DEBUGUL parameter can override the MSGCTL parameter====
 
<p>If you have set the MSGCTL parameter to a value that suppresses the message, AND set the DEBUGUL parameter to a value where the X'10' bit is on, then the DEBUGUL parameter setting forces the message to the terminal, even though the MSGCTL parameter setting says not to.</p>
===DEBUGUL and error messages display===
====How the MSGCTL command can override both the MSGCTL and DEBUGUL parameters====
<p>
<p>If you use the MSGCTL command, and suppress the display of a message by using the NOTERM keyword, then no matter how the MSGCTL or DEBUGUL parameters are set, the message does not go to the terminal. Conversely, if you want messages displayed at the terminal, enter MSGCTL command using the following syntax: </p>
When <var>DEBUGUL</var> is set to X'10', <var class="product">Model&nbsp;204</var> forces the error message along with the <var>DEBUGUL</var> messages to the user's terminal regardless of the setting of <var>[[MSGCTL_parameter|MSGCTL]]</var>. However, if an error message is normally suppressed from going to the user's terminal through the use of <var>NOTERM</var> (or by default it is not displayed), the <var>DEBUGUL</var> messages are suppressed regardless of the setting of <var>DEBUGUL</var>.</p>
<p class="code">MSGCTL {M204 | USER}.<i>msg-number</i> TERM  
 
</p>
===How the DEBUGUL parameter can override the MSGCTL parameter===
[[Category:User Parameters]]
<p>
If you have set the <var>MSGCTL</var> parameter to a value that suppresses the message, <b>and</b> set the <var>DEBUGUL</var> parameter to a value where the X'10' bit is on, the <var>DEBUGUL</var> parameter setting forces the message to the terminal, even though the <var>MSGCTL</var> parameter setting says not to.</p>
 
===How the MSGCTL command can override both the MSGCTL and DEBUGUL parameters===
<p>
If you use the <var>[[MSGCTL_command|MSGCTL]]</var> command, and suppress the display of a message by using the <var>NOTERM</var> keyword, then no matter how the <var>MSGCTL</var> or <var>DEBUGUL</var> parameters are set, the message does not go to the terminal. Conversely, if you want messages displayed at the terminal, enter a <var>MSGCTL</var> command using the following syntax: </p>
<p class="code">MSGCTL {M204 | USER}.<var class="term">msg-number</var> TERM </p>
<p>
Where:</p>
<ul>
<li>M204 or USER specifies a Model&nbsp;204 or User defined message, respectively</li>
 
<li><var class="term">msg-number</var> is the 4-digit number of the message</li>
 
<li>TERM displays the specified error message on the user’s terminal, when appropriate</li>
</ul>
 
===DEBUGUL parameter and QTBL size===
<p>
Setting the <var>DEBUGUL</var> parameter to anything other than 0 significantly increases QTBL.
Increases in STBL and VTBL are dependent on how many INCLUDEs the procedure does because of the storage described here:</p>
<table>
<tr class="head"><th>Table name</th><th>Stores</th></tr>
 
<tr><td>QTBL</td>
<td>An extra word for every QUAD in the request</td></tr>
 
<tr><td>STBL</td>
<td>Procedure names</td></tr>
 
<tr><td>VTBL</td>
<td>Chain storage for file and procedure pointers</td></tr>
</table>
 
===Usage in production===
<p>
A <var>UTABLE</var> command can handle the additional space requirements before the request is
compiled. Although there is a storage penalty for using the <var>DEBUGUL</var> parameter, there is no evaluation time penalty in CPU unless an error that you are debugging is reported on.</p>
 
===Rocket Software recommends===
<p>
Set this parameter in User 0’s CCAIN only if the job is not set up to use subsystems (<var>SYSOPT</var> does not include the 1-bit setting). Procedures that are run for [[APSY]] subsystem initialization do not allow for the extra compiler table requirements needed when <var>DEBUGUL</var> is set.</p>
<ul>
<li>If you are not using APSY, you can set <var>DEBUGUL</var> in the CCAIN.</li>
<li>If you are using APSY, you can set <var>DEBUGUL</var>:
<ul>
<li>On <var>IODEV</var> lines</li>
<li>In APSY subsystem login procedures</li>
<li>In user procedures</li>
</ul></li>
</ul>
 
[[Category:User parameters]]
[[Category:Parameters]]
[[Category:Parameters]]

Latest revision as of 21:26, 2 January 2018

User language debug options

Summary

Default value
X'00'
Parameter type
User
Where set
By any user
Related products
All
Introduced
Model 204 V6.1 or earlier

Description

Included procedures can accompany evaluation time Model 204 error messages

You can display the names of the procedures that were included up to the point of the evaluation time error on the audit trail or at your terminal.

The DEBUGUL settings and their effects are:

SettingDisplays procedure list...
X'20' After warning messages about truncation for User Language WITH operator string concatenations greater than 255 bytes
X'10' Debug messages on user's terminal in addition to audit trail.
X'08' After errors (other than counting errors) that terminate execution of the request
X'04' After counting errors that terminate execution of the request
X'02' After counting errors that do not terminate execution of the request
X'01' After informational messages
Any nonzero After a snap or a dump
X'00' Does not display procedure list

Usage

DEBUGUL and error messages display

When DEBUGUL is set to X'10', Model 204 forces the error message along with the DEBUGUL messages to the user's terminal regardless of the setting of MSGCTL. However, if an error message is normally suppressed from going to the user's terminal through the use of NOTERM (or by default it is not displayed), the DEBUGUL messages are suppressed regardless of the setting of DEBUGUL.

How the DEBUGUL parameter can override the MSGCTL parameter

If you have set the MSGCTL parameter to a value that suppresses the message, and set the DEBUGUL parameter to a value where the X'10' bit is on, the DEBUGUL parameter setting forces the message to the terminal, even though the MSGCTL parameter setting says not to.

How the MSGCTL command can override both the MSGCTL and DEBUGUL parameters

If you use the MSGCTL command, and suppress the display of a message by using the NOTERM keyword, then no matter how the MSGCTL or DEBUGUL parameters are set, the message does not go to the terminal. Conversely, if you want messages displayed at the terminal, enter a MSGCTL command using the following syntax:

MSGCTL {M204 | USER}.msg-number TERM

Where:

  • M204 or USER specifies a Model 204 or User defined message, respectively
  • msg-number is the 4-digit number of the message
  • TERM displays the specified error message on the user’s terminal, when appropriate

DEBUGUL parameter and QTBL size

Setting the DEBUGUL parameter to anything other than 0 significantly increases QTBL. Increases in STBL and VTBL are dependent on how many INCLUDEs the procedure does because of the storage described here:

Table nameStores
QTBL An extra word for every QUAD in the request
STBL Procedure names
VTBL Chain storage for file and procedure pointers

Usage in production

A UTABLE command can handle the additional space requirements before the request is compiled. Although there is a storage penalty for using the DEBUGUL parameter, there is no evaluation time penalty in CPU unless an error that you are debugging is reported on.

Rocket Software recommends

Set this parameter in User 0’s CCAIN only if the job is not set up to use subsystems (SYSOPT does not include the 1-bit setting). Procedures that are run for APSY subsystem initialization do not allow for the extra compiler table requirements needed when DEBUGUL is set.

  • If you are not using APSY, you can set DEBUGUL in the CCAIN.
  • If you are using APSY, you can set DEBUGUL:
    • On IODEV lines
    • In APSY subsystem login procedures
    • In user procedures