/* ****************************************************** * * * A spy program to reveal X11 traffic * * * * James Peterson, 1988 * * Copyright (C) 1988 MCC * * Permission to use, copy, modify, distribute, and sell this software and its * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting * documentation, and that the name of MCC not be used in * advertising or publicity pertaining to distribution of the software without * specific, written prior permission. MCC makes no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * * MCC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO * EVENT SHALL MCC BE LIABLE FOR ANY SPECIAL, INDIRECT OR * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. * * ***************************************************** */ #include "scope.h" #include /* for struct iovec, used by socket.h */ #include /* for AF_INET, SOCK_STREAM, ... */ #include /* for FIONCLEX, FIONBIO, ... */ #ifdef SVR4 #include #endif #include #include /* struct sockaddr_in */ #include #include /* struct servent * and struct hostent * */ #include /* for EINTR, EADDRINUSE, ... */ extern int errno; extern InitializePEX(); /* ********************************************** */ /* */ /* ********************************************** */ #define DefaultPort 6000 char ServerHostName[255]; char AudioServerHostName[255]; long ServerBasePort = DefaultPort; long ServerInPort = 1; long ServerOutPort = 0; long ServerDisplay = 0; long TranslateText = 0; char ScopeEnabled = 1; char HandleSIGUSR1 = 0; char DoAudio = 0; char TerminateClose = 0; int Interrupt = 0; struct FDDescriptor *FDD = 0; short MaxFD = 0; short nFDsInUse = 0; long ReadDescriptors = 0; long WriteDescriptors = 0; long BlockedReadDescriptors; short HighestFD; short debuglevel = 0; short Verbose = 0; short XVerbose = 0; short NasVerbose = 0; int ScopePort = 0; char *ScopeHost = 0; typedef struct _BreakPoint { struct _BreakPoint *next; int number; unsigned char request; Boolean enabled; } BP; typedef enum _CMDResult { CMDProceed, CMDDebug, CMDSyntax, CMDError } CMDResult; CMDResult CMDStep (); CMDResult CMDCont (); CMDResult CMDBreak (); CMDResult CMDDelete (); CMDResult CMDDisable (); CMDResult CMDEnable (); CMDResult CMDLevel (); CMDResult CMDAudio (); CMDResult CMDQuit (); CMDResult CMDHelp (); typedef struct _CMDFunc { char *name; char *alias; CMDResult (*func)(); char *usage; char *help; } CMDFuncRec, *CMDFuncPtr; CMDFuncRec CMDFuncs[] = { "audio", "a", CMDAudio, "[a]udio", "Set audio output level\n", "break", "b", CMDBreak, "[b]reak", "Create breakpoints\n", "cont", "c", CMDCont, "[c]ont", "Continue scoping\n", "delete", "del", CMDDelete, "[del]ete", "Delete breakpoints\n", "disable","d", CMDDisable, "[d]isable", "Disable breakpoints\n", "enable", "e", CMDEnable, "[e]nable", "Enable breakpoints\n", "help", "?", CMDHelp, "help", "Print this list\n", "level", "l", CMDLevel, "[l]evel", "Set output level\n", "quit", "q", CMDQuit, "[q]uit", "Quit Xscope\n", "step", "s", CMDStep, "[s]tep", "Step trace one request\n", }; #define NumCMDFuncs (sizeof CMDFuncs / sizeof CMDFuncs[0]) #ifndef FALSE #define FALSE 0 #define TRUE 1 #endif static int CMDStringToInt(s, v) char *s; int *v; { int sign = 1; switch (*s) { case '-': sign = -1; s++; break; case '+': s++; break; } if (!strncmp (s, "0x", 2)) { sscanf (s + 2, "%x", v); } else if (*s == '0') { sscanf (s, "%o", v); } else if (isdigit (*s)) { sscanf (s, "%d", v); } else if (*s == '\'') { s++; if (*s == '\\') { s++; switch (*s) { case 'n': *v = '\n'; break; case 't': *v = '\t'; break; default: *v = (int) *s; break; } } else *v = (int) *s; s++; if (*s != '\'') return FALSE; } else return FALSE; *v *= sign; return TRUE; } static CMDFuncPtr CMDStringToFunc (name) char *name; { int i; for (i = 0; i < NumCMDFuncs; i++) { if (!strcmp (name, CMDFuncs[i].name) || !strcmp (name, CMDFuncs[i].alias)) { return &CMDFuncs[i]; } } return 0; } static int CMDSplitIntoWords(line, argv) char *line; char **argv; { char quotechar; int argc; argc = 0; while (*line) { while (isspace(*line)) line++; if (!*line) break; if (*line == '"') { quotechar = *line++; *argv++ = line; argc++; while (*line && *line != quotechar) line++; if (*line) *line++ = '\0'; } else { *argv++ = line; argc++; while (*line && !isspace(*line)) line++; if (*line) *line++ = '\0'; } } *argv = 0; return argc; } CMDResult CMDHelp(argc, argv) int argc; char **argv; { int i; CMDFuncPtr func; if (argc == 1) { for (i = 0; i < NumCMDFuncs; i++) printf("%-10s%s\n", CMDFuncs[i].name, CMDFuncs[i].usage); } else { for (i = 1; i < argc; i++) { func = CMDStringToFunc (argv[i]); if (!func) { printf ("%-10s unknown command\n", argv[i]); return CMDSyntax; } printf ("%-10s %s\n%s", func->name, func->usage, func->help); } } return CMDDebug; } static void CMDSyntaxError(argc, argv) int argc; char **argv; { printf("Syntax error in:"); while (*argv) printf(" %s", *argv++); printf("\n"); } void ReadCommands () { int argc; char line[1024]; char *argv[20]; CMDResult result; CMDFuncPtr func; static int here; if (here) return; here = 1; for (;;) { printf ("> "); if (!fgets (line, sizeof line, stdin)) break; argc = CMDSplitIntoWords(line, argv); if (argc > 0) { func = CMDStringToFunc (argv[0]); if (!func) CMDSyntaxError (argc, argv); else { result = (*func->func)(argc, argv); switch (result) { case CMDSyntax: CMDSyntaxError(argc, argv); break; case CMDError: printf ("Error\n"); break; case CMDProceed: here = 0; return; default: break; } } } } printf("...\n"); here = 0; } int SingleStep; int BreakPoint; BP *breakPoints; int breakPointNumber; void TestBreakPoints (buf, n) unsigned char *buf; long n; { BP *bp; for (bp = breakPoints; bp; bp = bp->next) { if (bp->request == buf[0]) { break; } } if (bp) { printf ("Breakpoint on request %d\n", bp->request); ReadCommands (); } } void setBreakPoint () { Boolean b = false; BP *bp; FD fd; if (SingleStep) b = true; else { for (bp = breakPoints; bp; bp = bp->next) { if (bp->enabled) { b = true; break; } } } if (b != BreakPoint) { BreakPoint = b; for (fd = 0; fd < HighestFD; fd++) { extern DataFromClient(); if (FDD[fd].Busy && FDD[fd].InputHandler == DataFromClient) { if (BreakPoint) SetBufLimit (fd); else ClearBufLimit (fd); } } } } CMDResult CMDBreak (argc, argv) int argc; char **argv; { BP *bp, **prev; int request; if (argc == 1) { for (bp = breakPoints; bp; bp = bp->next) { printf ("%3d: %3d %s\n", bp->number, bp->request, bp->enabled ? "enabled" : "disabled"); } } else { for (prev = &breakPoints; *prev; prev = &(*prev)->next); while (*++argv) { request = GetXRequestFromName (*argv); if (request < 0 && !CMDStringToInt (*argv, &request)) return CMDSyntax; bp = (BP *) malloc (sizeof (BP)); bp->request = request; bp->number = ++breakPointNumber; bp->enabled = true; bp->next = 0; *prev = bp; prev = &bp->next; } } setBreakPoint (); return CMDDebug; } CMDResult CMDCont (argc, argv) int argc; char **argv; { SingleStep = 0; return CMDProceed; } CMDResult CMDDisable (argc, argv) int argc; char **argv; { BP *bp; int number; if (argc == 1) { printf ("Disabling all breakpoints...\n"); for (bp = breakPoints; bp; bp = bp->next) bp->enabled = false; } else { while (*++argv) { if (!CMDStringToInt (*argv, &number)) return CMDSyntax; for (bp = breakPoints; bp; bp = bp->next) if (bp->number == number) { bp->enabled = false; break; } if (!bp) { printf ("No such breakpoint %s\n", *argv); } } } setBreakPoint (); return CMDDebug; } CMDResult CMDDelete (argc, argv) int argc; char **argv; { BP *bp, **prev; int number; if (argc == 1) { printf ("Deleting all breakpoints...\n"); while (bp = breakPoints) { breakPoints = bp->next; free (bp); } } else { while (*++argv) { if (!CMDStringToInt (*argv, &number)) return CMDSyntax; for (prev = &breakPoints; bp = *prev; prev = &bp->next) { if (bp->number == number) { *prev = bp->next; free (bp); break; } } if (!bp) { printf ("No such breakpoint %s\n", *argv); } } } setBreakPoint (); return CMDDebug; } CMDResult CMDEnable (argc, argv) int argc; char **argv; { BP *bp; int number; if (argc == 1) { printf ("Enablingg all breakpoints...\n"); for (bp = breakPoints; bp; bp = bp->next) bp->enabled = true; } else { while (*++argv) { if (!CMDStringToInt (*argv, &number)) return CMDSyntax; for (bp = breakPoints; bp; bp = bp->next) if (bp->number == number) { bp->enabled = true; break; } if (!bp) { printf ("No such breakpoint %s\n", *argv); } } } setBreakPoint (); return CMDDebug; } CMDResult CMDStep (argc, argv) int argc; char **argv; { SingleStep = 1; setBreakPoint (); return CMDProceed; } CMDResult CMDQuit (argc, argv) int argc; char **argv; { printf ("exiting...\n"); exit (0); } CMDResult CMDLevel (argc, argv) int argc; char **argv; { int level; if (argc == 1) printf ("Level: %d\n", XVerbose); else if (argc == 2 && CMDStringToInt (argv[1], &level)) XVerbose = level; else return CMDSyntax; return CMDDebug; } CMDResult CMDAudio (argc, argv) int argc; char **argv; { int level; if (argc == 1) printf ("Audio Level: %d\n", NasVerbose); else if (argc == 2 && CMDStringToInt (argv[1], &level)) NasVerbose = level; else return CMDSyntax; return CMDDebug; } /* ********************************************** */ /* */ /* */ /* ********************************************** */ short GetServerport () { short port; enterprocedure("GetServerport"); port = ServerBasePort + ServerOutPort + ServerDisplay; debug(4,(stderr, "Server service is on port %d\n", port)); return(port); } short GetScopePort () { short port; enterprocedure("GetScopePort"); port = ServerBasePort + ServerInPort + ServerDisplay; debug(4,(stderr, "scope service is on port %d\n", port)); return(port); } /* ********************************************** */ /* */ /* ********************************************** */ Usage() { fprintf(stderr, "Usage: xscope\n"); fprintf(stderr, " [-h]\n"); fprintf(stderr, " [-i]\n"); fprintf(stderr, " [-o]\n"); fprintf(stderr, " [-d]\n"); fprintf(stderr, " [-v] -- verbose output\n"); fprintf(stderr, " [-a] -- audio verbose output\n"); fprintf(stderr, " [-q] -- quiet output\n"); fprintf(stderr, " [-D]\n"); fprintf(stderr, " [-S] -- start/stop on SIGUSR1\n"); fprintf(stderr, " [-t] -- terminate when all clients close\n"); exit(1); } char *OfficialName(); /* forward type declaration */ ScanArgs(argc, argv) int argc; char **argv; { XVerbose = 1 /* default verbose-ness level */; NasVerbose = 1; /* Scan argument list */ while (--argc > 0) { ++argv; if (**argv == '-') switch (*++*argv) { /* debug levels: 2 - trace each procedure entry 4 - I/O, connections 8 - Scope internals 16 - Message protocol 32 - 64 - malloc 128 - 256 - really low level */ case 'D': debuglevel = atoi(++*argv); if (debuglevel == 0) debuglevel = 255; XVerbose = 7; debug(1,(stderr, "debuglevel = %d\n", debuglevel)); break; case 'S': HandleSIGUSR1 = 1; ScopeEnabled = atoi(++*argv); break; case 'q': /* quiet mode */ XVerbose = 0; debug(1,(stderr, "Verbose = %d\n", XVerbose)); break; case 'v': /* verbose mode */ XVerbose = atoi(++*argv); debug(1,(stderr, "Verbose = %d\n", XVerbose)); break; case 'o': ServerOutPort = atoi(++*argv); if (ServerOutPort <= 0) ServerOutPort = 0; debug(1,(stderr, "ServerOutPort = %d\n", ServerOutPort)); break; case 'd': ServerDisplay = atoi(++*argv); if (ServerDisplay <= 0) ServerDisplay = 0; debug(1,(stderr, "ServerDisplay=%d\n", ServerDisplay)); break; case 'i': ServerInPort = atoi(++*argv); if (ServerInPort <= 0) ServerInPort = 0; debug(1,(stderr, "ServerInPort = %d\n", ServerInPort)); break; case 'h': if (++*argv != NULL && **argv != '\0') (void)strcpy(ServerHostName, OfficialName(*argv)); debug(1,(stderr, "ServerHostName=%s\n", ServerHostName)); break; case 'T': TranslateText = 1; break; case 'A': DoAudio = 1; break; case 'a': /* verbose mode */ NasVerbose = atoi(++*argv); debug(1,(stderr, "NasVerbose = %d\n", NasVerbose)); break; case 'n': /* NAS server host */ if (++*argv != NULL && **argv != '\0') (void)strcpy(AudioServerHostName, OfficialName(*argv)); debug(1,(stderr, "AudioServerHostName=%s\n", AudioServerHostName)); break; case 't': TerminateClose = 1; break; default: fprintf(stderr, "Unknown option %c\n", **argv); Usage(); break; } else { /* file argument to scope -- error */ Usage(); } } /* check for different port numbers or different machines */ if (ServerInPort == ServerOutPort) if (ServerHostName[0] == '\0') { fprintf(stderr, "Can't have xscope on same port as server (%d)\n", ServerInPort); Usage(); } } /* ********************************************** */ /* */ /* ********************************************** */ int NewConnection (); int NewAudio (); main(argc, argv) int argc; char **argv; { ScanArgs(argc, argv); InitializeFD(); InitializeX11(); if (DoAudio) InitializeAudio(); #ifdef PEX InitializePEX(); #endif SetUpStdin(); SetUpConnectionSocket(GetScopePort(), NewConnection); if (DoAudio) SetUpConnectionSocket (GetScopePort() + 2000, NewAudio); SetSignalHandling(); MainLoop(); } TimerExpired() { debug(16,(stderr, "Timer tick\n")); } /* ********************************************** */ /* */ /* ********************************************** */ /* here is where we would add code to allow control from the keyboard. We would want to read a command and interpret it. Possibilties: (a) verbose level setting (b) reset time (c) save X requests to a file. (d) replay X requests from a file. (e) allow fake events, errors to be generated. */ ReadStdin(fd) FD fd; { char buf[2048]; long n; enterprocedure("ReadStdin"); n = read(fd, buf, 2048); debug(4,(stderr, "read %d bytes from stdin\n", n)); } SetUpStdin() { enterprocedure("SetUpStdin"); UsingFD(fileno(stdin), ReadStdin, (int (*)()) NULL); } /* ************************************************************ */ /* */ /* */ /* ************************************************************ */ /* xscope is really meant to look at one client at a time. However, it can easily handle multiple clients and servers. To do so, we need to have a pair of FDs: one for the client and one for the server for that client. If either goes away, so does the other. We need to be able to identify the other FD of a pair, so that if we get input from one, we can write it to the other. */ static long clientNumber = 0; struct fdinfo FDinfo[StaticMaxFD]; SetUpPair(client, server) FD client; FD server; { if (client >= 0) { clientNumber += 1; FDinfo[client].Server = false; FDinfo[client].pair = server; FDinfo[client].ClientNumber = clientNumber; FDinfo[client].bufcount = 0; FDinfo[client].buflimit = -1; FDinfo[client].bufdelivered = 0; if (server >= 0) { FDinfo[server].Server = true; FDinfo[server].pair = client; FDinfo[server].ClientNumber = FDinfo[client].ClientNumber; FDinfo[server].bufcount = 0; FDinfo[server].buflimit = -1; FDinfo[server].bufdelivered = 0; } } else if (server >= 0) { (void)close(server); NotUsingFD(server); } } ResetPair (client, server) FD client; FD server; { if (client >= 0) { FDinfo[client].bufcount = 0; FDinfo[client].buflimit = -1; FDinfo[client].bufdelivered = 0; } if (server >= 0) { FDinfo[server].bufcount = 0; FDinfo[server].buflimit = -1; FDinfo[server].bufdelivered = 0; } } CloseConnection(fd) FD fd; { debug(4,(stderr, "close %d and %d\n", fd, FDPair(fd))); ResetPair (ClientHalf(fd), ServerHalf(fd)); StopClientConnection(ServerHalf(fd)); StopServerConnection(ClientHalf(fd)); (void)close(fd); NotUsingFD(fd); (void)close(FDPair(fd)); NotUsingFD(FDPair(fd)); if (TerminateClose) exit (0); } /* ************************************************************ */ FD FDPair(fd) FD fd; { return(FDinfo[fd].pair); } FD ClientHalf(fd) FD fd; { if (FDinfo[fd].Server) return(FDinfo[fd].pair); return(fd); } FD ServerHalf(fd) FD fd; { if (FDinfo[fd].Server) return(fd); return(FDinfo[fd].pair); } char *ClientName (fd) FD fd; { static char name[12]; (void)sprintf(name, " %d", FDinfo[fd].ClientNumber); return(name); } int ClientNumber (fd) FD fd; { return FDinfo[fd].ClientNumber; } /* ********************************************** */ /* */ /* ********************************************** */ /* * Write as much of the queued data as the receiver will accept * Block reads from the sender until the receiver gets all of the * data */ FlushFD (fd) FD fd; { long BytesToWrite = FDinfo[fd].bufcount - FDinfo[fd].bufstart; char *p = FDinfo[fd].buffer + FDinfo[fd].bufstart; int PeerFD; PeerFD = FDPair (fd); if (FDinfo[fd].buflimit >= 0) { if (FDinfo[fd].bufdelivered + BytesToWrite > FDinfo[fd].buflimit) BytesToWrite = FDinfo[fd].buflimit - FDinfo[fd].bufdelivered; } while (BytesToWrite > 0) { int n1 = write (fd, (char *)p, (int)BytesToWrite); debug(4,(stderr, "write %d bytes\n", n1)); if (n1 < 0) { if (errno != EWOULDBLOCK && errno != EAGAIN) { perror("Error on write"); if (PeerFD >= 0) CloseConnection(PeerFD); BytesToWrite = 0; } break; } else { FDinfo[fd].bufstart += n1; FDinfo[fd].bufdelivered += n1; BytesToWrite -= n1; p += n1; } } if (FDinfo[fd].bufstart == FDinfo[fd].bufcount) { if (PeerFD >= 0) BlockedReadDescriptors &= ~ (1 << PeerFD); WriteDescriptors &= ~(1 << fd); FDinfo[fd].bufcount = FDinfo[fd].bufstart = 0; } else { if (PeerFD >= 0) BlockedReadDescriptors |= 1 << PeerFD; if (FDinfo[fd].buflimit != FDinfo[fd].bufdelivered) WriteDescriptors |= 1 << fd; } } /* when we get data from a client, we read it in, copy it to the server for this client, then dump it to the client. Note, we don't have to have a server, if there isn't one. */ DataFromClient(fd) FD fd; { long n; FD ServerFD; Verbose = XVerbose; enterprocedure("DataFromClient"); ServerFD = FDPair(fd); if (ServerFD < 0) { ServerFD = ConnectToServer(false); if (ServerFD < 0) { CloseConnection(fd); return; } SetUpPair(fd, ServerFD); } n = read(fd, FDinfo[ServerFD].buffer, BUFFER_SIZE); debug(4,(stderr, "read %d bytes from Client%s\n", n, ClientName(fd))); if (n < 0) { PrintTime(); perror("Client --> read error:"); CloseConnection(fd); return; } if (n == 0) { PrintTime(); if (Verbose >= 0) fprintf(stdout, "Client%s --> EOF\n", ClientName(fd)); CloseConnection(fd); return; } FDinfo[ServerFD].bufcount = n; FDinfo[ServerFD].bufstart = 0; FlushFD (ServerFD); /* also report the bytes to standard out */ ReportFromClient(fd, FDinfo[ServerFD].buffer, n); } /* ********************************************** */ /* */ /* ********************************************** */ /* similar situation for the server, but note that if there is no client, we close the connection down -- don't need a server with no client. */ DataFromServer(fd) FD fd; { long n; FD ClientFD; Verbose = XVerbose; ClientFD = FDPair(fd); if (ClientFD < 0) { CloseConnection(fd); return; } enterprocedure("DataFromServer"); n = read(fd, (char *)FDinfo[ClientFD].buffer, BUFFER_SIZE); debug(4,(stderr, "read %d bytes from Server%s\n", n, ClientName(fd))); if (n < 0) { PrintTime(); perror("read error <- Server"); CloseConnection(fd); return; } if (n == 0) { PrintTime(); if (Verbose >= 0) fprintf(stdout, "EOF <-- Server%s\n", ClientName(fd)); CloseConnection(fd); return; } FDinfo[ClientFD].bufcount = n; FDinfo[ClientFD].bufstart = 0; FlushFD (ClientFD); /* also report the bytes to standard out */ ReportFromServer(fd, FDinfo[ClientFD].buffer, n); } /* ************************************************************ */ /* */ /* Create New Connection to a client program and to Server */ /* */ /* ************************************************************ */ static int ON = 1 /* used in ioctl */ ; NewConnection(fd) FD fd; { FD ServerFD = -1; FD ClientFD = -1; ClientFD = ConnectToClient(fd); ServerFD = ConnectToServer(true); SetUpPair(ClientFD, ServerFD); } /* ************************************************************ */ FD ConnectToClient(ConnectionSocket) FD ConnectionSocket; { FD ClientFD; ClientFD = AcceptConnection(ConnectionSocket); UsingFD(ClientFD, DataFromClient, FlushFD); StartClientConnection(ClientFD); return(ClientFD); } /* ************************************************************ */ /* */ /* */ /* ************************************************************ */ FD ConnectToServer(report) Boolean report; { FD ServerFD; ServerFD = MakeConnection (ServerHostName, GetServerport (), report); if (ServerFD >= 0) { UsingFD(ServerFD, DataFromServer, FlushFD); StartServerConnection(ServerFD); } return(ServerFD); } /* ********************************************** */ /* */ /* ********************************************** */ char *OfficialName(name) char *name; { struct hostent *HostEntry; HostEntry = gethostbyname(name); if (HostEntry == NULL) { perror("gethostbyname"); exit(-1); } debug(4,(stderr, "Official name of %s is %s\n", name, HostEntry->h_name)); return(HostEntry->h_name); }