simh-testsetgenerator/sim_console.h
Mark Pizzolato 454b706a11 Added Buffered Console Capabilities
A key capability needed to support simulators running with background
    execution is the ability to have a Telnet connected console which isn’t
    continuously connected.  This feature is called a Buffered Telnet console.
    Absolutely nothing changes for someone not interested in using the feature.
    However, if someone is interested in the feature, the following SCP
    commands are available:

         sim> SET CONSOLE TELNET=port                  ! Unchanged
         sim> SET CONSOLE TELNET=BUFFERED{=buffersize} ! buffersize defaults to 32K
         sim> SET CONSOLE TELNET=UNBUFFERED            ! restores normal behavior
         sim> SET CONSOLE TELNET=NOBUFFERED            ! synonym for UNBUFFERED
         sim> SET CONSOLE TELNET=LOG=logdestination    ! enables logging of Telnet session traffic (potentially separate from destination specified by SET CONSOLE LOG=conlogdest)
         sim> SET CONSOLE TELNET=NOLOG                 ! turns off specific logging of Telnet session

         sim> SET CONSOLE TELNET=LOG=conlogdest                ! turns on logging all console traffic (unless the telnet session logging is also specified).

    The logdestinations for any of the logging/debugging commands can
    now be:
    LOG, DEBUG, STDOUT, STDERR or any file specification (caps are not
    required, but these names are reserved to indicate the current
    destination of the specified file handles (sim_log, sim_deb,
    stdout, stderr).

    When a Console Telnet session is Buffered, a simulator will start
    (via BOOT CPU or whatever is appropriate for a particular simulator)
    without needing to have an active telnet connection.  When a Telnet
    connection comes along for the telnet port, the contents of the saved
    buffer (which wraps on overflow) are presented on the telnet session
    as output before session traffic.  This allows the connecting telnet
    client to see what happened before he connected since the likely
    reason he might be connecting to the console of a background
    simulator is to troubleshoot unusual behavior.

    The current structure has the optional ability to log the Telnet
    session separately from the simulator output (i.e. ini file command
    execution) is potentially useful when you need to review what the
    simulator may have output which may be difficult to find in and
    amongst the possibly verbose Operating system console output.
    If someone doesn’t use “SET CONSOLE TELNET=LOG=logdestination”,
    then the original strategy of logging all output to the target
    specified by “SET CONSOLE LOG=logdestination” is preserved.  Looking
    at the isolated console output might be more interesting if/when
    control flow scp commands are ever implemented (ON,GOTO, RETURN, etc.)
2011-04-15 08:43:07 -07:00

91 lines
4.4 KiB
C

/* sim_console.h: simulator console I/O library headers
Copyright (c) 1993-2008, Robert M Supnik
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
ROBERT M SUPNIK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of Robert M Supnik shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Robert M Supnik.
17-Jan-11 MP Added buffered line capabilities
22-Jun-06 RMS Implemented SET/SHOW PCHAR
22-Nov-05 RMS Added central input/output conversion support
05-Nov-04 RMS Moved SET/SHOW DEBUG under CONSOLE hierarchy
28-May-04 RMS Added SET/SHOW CONSOLE
02-Jan-04 RMS Removed timer routines, added Telnet console routines
*/
#ifndef _SIM_CONSOLE_H_
#define _SIM_CONSOLE_H_ 0
#define TTUF_V_MODE (UNIT_V_UF + 0)
#define TTUF_W_MODE 2
#define TTUF_MODE_7B 0
#define TTUF_MODE_8B 1
#define TTUF_MODE_UC 2
#define TTUF_MODE_7P 3
#define TTUF_KSR (1u << TTUF_W_MODE)
#define TTUF_M_MODE ((1u << TTUF_W_MODE) - 1)
#define TTUF_V_UF (TTUF_V_MODE + TTUF_W_MODE)
#define TT_MODE (TTUF_M_MODE << TTUF_V_MODE)
#define TT_MODE_7B (TTUF_MODE_7B << TTUF_V_MODE)
#define TT_MODE_8B (TTUF_MODE_8B << TTUF_V_MODE)
#define TT_MODE_UC (TTUF_MODE_UC << TTUF_V_MODE)
#define TT_MODE_7P (TTUF_MODE_7P << TTUF_V_MODE)
#define TT_MODE_KSR (TT_MODE_UC)
#define TT_GET_MODE(x) (((x) >> TTUF_V_MODE) & TTUF_M_MODE)
t_stat sim_set_console (int32 flag, char *cptr);
t_stat sim_set_kmap (int32 flag, char *cptr);
t_stat sim_set_telnet (int32 flag, char *cptr);
t_stat sim_set_notelnet (int32 flag, char *cptr);
t_stat sim_set_logon (int32 flag, char *cptr);
t_stat sim_set_logoff (int32 flag, char *cptr);
t_stat sim_set_debon (int32 flag, char *cptr);
t_stat sim_set_cons_buff (int32 flg, char *cptr);
t_stat sim_set_cons_unbuff (int32 flg, char *cptr);
t_stat sim_set_cons_log (int32 flg, char *cptr);
t_stat sim_set_cons_nolog (int32 flg, char *cptr);
t_stat sim_set_deboff (int32 flag, char *cptr);
t_stat sim_set_pchar (int32 flag, char *cptr);
t_stat sim_show_console (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_show_kmap (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_show_telnet (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_show_log (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_show_debug (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_show_pchar (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_show_cons_buff (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_show_cons_log (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, char *cptr);
t_stat sim_check_console (int32 sec);
t_stat sim_open_logfile (char *filename, t_bool binary, FILE **pf, FILEREF **pref);
t_stat sim_close_logfile (FILEREF **pref);
const char *sim_logfile_name (FILE *st, FILEREF *ref);
t_stat sim_poll_kbd (void);
t_stat sim_putchar (int32 c);
t_stat sim_putchar_s (int32 c);
t_stat sim_ttinit (void);
t_stat sim_ttrun (void);
t_stat sim_ttcmd (void);
t_stat sim_ttclose (void);
t_stat sim_os_poll_kbd (void);
t_stat sim_os_putchar (int32 out);
int32 sim_tt_inpcvt (int32 c, uint32 mode);
int32 sim_tt_outcvt (int32 c, uint32 mode);
#endif