1 :Info: trace_mcs:  1982-03-10  trace_mcs
  2 
  3 Syntax as a command:
  4   trace_mcs print {channel_name(s)} {-control_args}
  5   trace_mcs reset
  6   trace_mcs modes {new_modes} {-control_args}
  7   trace_mcs channel {channel_name(s)} {-control_args}
  8   trace_mcs table_size {new_table_size} {-control_args}
  9 
 10 
 11 Function:  Controls the MCS tracing facility and prints MCS trace table
 12 entries.
 13 
 14 
 15 Arguments (operation):
 16 print, pr, p
 17    Prints entries from the trace table.
 18 reset, rs
 19    Resets MCS tracing: sets global modes to off,^default,none, sets the
 20    trace table size to zero, and turns off both channel tracing flags
 21    for all channels. No additional arguments are allowed.
 22 modes
 23    Prints the current global tracing modes, or changes the specified
 24    modes if a new_modes argument is present. See "List of modes",
 25    below.
 26 
 27 
 28 channel, chn
 29    Prints or changes the tracing flags for a single channel or group
 30    of channels. At least one of printing or changing must be specified,
 31    and at least one channel_name must be specified.
 32 table_size, ts
 33    Changes the size of the MCS trace table. The table size may only be
 34    changed when tracing is disabled, and if a trace table exists, the
 35    size must be first changed to zero and then to the new value in
 36    order to change the size to a different nonzero value. If no new
 37    table size is supplied, the current table size is printed.
 38 
 39 
 40 Arguments (all functions):
 41 channel_name(s)
 42    Up to 20 different channel names may be specified. The channel names
 43    may be starnames, and all channels which match any of the supplied
 44    names is selected for the operation.
 45 new_modes
 46    Is the new mode string containing the global MCS tracing modes to be
 47    changed. See "List of modes", below.
 48 table_size
 49    Is a decimal integer specifying the number of entries in the MCS
 50    trace table. Each entry occupies 16 words in tty_buf. The program
 51    queries if the new trace table size will occupy more than 50 percent
 52    of the free space in tty_buf, to guard against errors.
 53 
 54 
 55 Control arguments (all functions):
 56 -erf NNN
 57    Takes the MCS trace table from the FDUMP for ERF NNN. If this
 58    argument is specified, no parameters (modes, channel flags, table
 59    size) may be changed, although they can be printed.
 60 
 61 
 62 Control arguments (print):
 63 -reset, -rs
 64    Resets the last trace entry indicator in trace_mcs. Normally, only
 65    those entries which have been added to the trace table since the
 66    last time entries were printed are printed. If -reset is specified,
 67    the next use of trace_mcs will print all the trace table entries.
 68 -all, -a
 69    Prints all trace table entries, but without resetting or changing
 70    the last entry indicator.
 71 -last NNN, -lt NNN
 72    Prints the last NNN entries in the trace table, without resetting or
 73    changing the last entry indicator.
 74 
 75 
 76 -reverse, -rev
 77    Prints the entries in reverse order. This can only be specified if
 78    -all or -last is also specified.
 79 {-channel} XXX, {-chn} XXX
 80    Selects a channel or group of channels for printing. This control
 81    argument need not be supplied before the channel name, and is
 82    provided only for compatibility.
 83 
 84 
 85 Control arguments (channel):
 86 -print, -pr
 87    Causes the state of the channel trace flags for the selected
 88    channels to be printed. If -on or -off is also specified, both the
 89    previous and new states are printed.
 90 -on
 91    Turns on the "trace" flag for the channel(s). If this flag is
 92    different from the "default" global mode, and the force flag is not
 93    also set, the channel is traced. If the force flag is set, the
 94    channel is traced regardless of the state of the "default" mode.
 95 -off
 96    Turns off the "trace" flag for the channel(s). Only one of -on and
 97    -off may be specified.
 98 
 99 
100 -force, -fc
101    Sets the "force" flag for the channel. If the force flag is set, the
102    channel is traced or not depending only on the state of its "trace"
103    flag, and not on the "default" mode. If -force is specified, one of
104    -on or -off must also be specified.
105 
106 
107 Control arguments (modes):
108 -brief, -bf
109    Suppresses the printing of the new mdes after the change is applied.
110    Normally, the modes now in effect are printed.
111 -long, -lg
112    Prints the new mode string after the changes are applied (Default).
113 
114 
115 List of modes:
116 on
117    Whether tracing is enabled at all. The "on" mode may also be
118    represented as "^off", and "^on" as "off".
119 default
120    Whether channels are traced by default. Normally, this is off,
121    meaning that only channels whose trace flag is set are traced.
122 all
123    May only be specified as "all", not "^all". This mode is a shorthand
124    for setting all the remaining modes (except "none"), used to turn on
125    tracing for all MCS events.
126 
127 
128 none
129    May only be specified as "none", and not as "^none". This mode is
130    shorthand for resetting all the remaining modes. It is usually used
131    in combination with some other mode or modes, to trace only those
132    specific operations.
133 
134 
135 read
136    Whether channel_manager$read operations are traced.
137 write
138    Whether channel_manager$write operations are traced.
139 data
140    Whether the data in read and write operations is to be recorded in
141    the trace table, as well as the events themselves.
142 control
143    Whether channel_manager$control operations are traced.
144 modes
145    Whether channel_manager$check_modes, get_modes, and set_modes
146    operations are traced.
147 
148 
149 interrupt
150    Whether channel_manager$interrupt, interrupt_later, and
151    queued_interrupt operations are to be traced.
152 init_mpx
153    Whether to trace priv_channel_manager$init_multiplexer operations.
154 start_mpx
155    Whether to trace priv_channel_manager$start_multiplexer operations.
156 stop_mpx
157    Whether to trace priv_channel_manager$stop_multiplexer operations.
158 space_man
159    Whether to trace calls to tty_space_man requesting non-buffer type
160    space. (Apparently not implemented)
161 
162 
163 Access required:
164 Access to phcs_ is required to print the trace table of the running
165 system. Access to the FDUMP is required to access the trace table in
166 an FDUMP. Access to hphcs_ is required to change any parameters for
167 the running system.
168 
169 
170 Notes:
171 The MCS trace table is kept in a circular array, with old entries being
172 overwritten by new ones. Each entry contains the time, the device index
173 of the associated channel, and a short string identifying the
174 operation.
175 
176 
177 :hcom:
178 
179 
180 
181 /****^  HISTORY COMMENTS:
182   1) change(2020-05-19,GDixon), approve(2021-02-22,MCR10088),
183      audit(2021-05-27,Swenson), install(2021-05-27,MR12.6g-0056):
184      Fix info seg format errors reported by verify_info.
185                                                    END HISTORY COMMENTS */
186 
187 
188