From 650c2c88dd495173c11adabee8aca9a427a6ff7a Mon Sep 17 00:00:00 2001 From: joevt Date: Sun, 14 Aug 2022 06:48:16 -0700 Subject: [PATCH] Add socket type for serial_backend With the option --serial_backend=socket, input and output to a serial port will use a SOCK_STREAM type UNIX domain socket. This allows you to do Open Firmware in one window, while the first window can be used for dingusppc debugger. Other fixes: - Added SIGTERM handler so that if the user force quits dingusppc, the terminal settings are properly restored. A user needs to force quit when --serial_backend=stdio and Open Firmware is taking input from ttya. If terminal settings are not restored, then running dingusppc after a force quit will cause Control-C to not work when --serial_backend is not stdio. - Added a couple numbers to rcv_char_available - 15 is the number of consecutive characters that can processed. 400 is the total number of calls to rcv_char_available after 15 consecutive characters have been read before additional characters can be read. This delay in processing additional characters allows pasting arbitrarily large amounts of text into Open Firmware. A real serial port terminal app might have a text pacing option to limit the number of output characters per second but that is not an option since the emulator is not limiting character data to a baud rate. Related Notes: The socket file is created when dingusppc starts. The socket file is named dingusppcsocket and is created in the current working directory (usually where the executable is located and where the dingusppc.log, nvram.bin, and pram.bin files are created). The socket file is not visible in the Finder. You can see it in the terminal using the ls command. The socket file can be used with the following command in a new terminal window: socat UNIX-CLIENT:dingussocket -,cs8,parenb=0,echo=0,icanon=0,isig=0,icrnl=0 When dingusppc quits, the socat command ends. Other notes: The dingusppc --debugger option causes dingusppc to enter the debugger before Open Firmware outputs anything. You can connect to the socket while dingusppc is in the debugger. Then enter the go command to leave the debugger and start Open Firmware. However, since the startup sound takes a long time, you can probably connect to the socket before Open Firmware starts even without the --debugger option. It's like with a real Power Mac - you have a few seconds to hold Command-Option-O-F except in this case you have a few seconds to press the up arrow and press enter (for executing the last command from the terminal command history) and if you do it too late you'll still get into Open Firmware if auto-boot? was previously set to false using the dingusppc debugger which is actually the only way to get into Open Firmware since a keyboard is currently not emulated?). To set ttya as the input and output device in Open Firmware, you can use the setenv command in the dingusppc debugger. The device path needs to be longer than the current device path (because code for handling shortening of the paths is currently not implemented). For example, ttya can replace kbd for the input-device, but to replace screen for the output-device you need to add some extra characters like this: ttya,11 (I think the number is for baud but we're not using a real serial port so baud doesn't matter). Future ideas: - Have dingusppc execute the socat command for you so that it opens a terminal window before Open Firmware starts. - Add another --serial_backend for the printer port (ttyb) since now we have more than one type of serial backend. If both serial ports use socket backend, then a different name for the second socket is required. - Have an option to make dingusppc block until something connects to the socket (this means calling accept after listen instead of after select). - Test compatibility with serial port socket created by Parallels Desktop virtual machines in macOS. - Find a solution that works with Windows. - Test with Linux. - Create a serial_backend type for tty devices. I suppose maybe socat can pipe the file socket to tty but a direct connection might be easier to setup. - Allow using a socket created by some other app (for example, socat UNIX-LISTEN). This means dingusppc will assume the client role and will call connect instead of accept. --- devices/serial/chario.cpp | 275 ++++++++++++++++++++++++++++++++++++-- devices/serial/chario.h | 25 +++- devices/serial/escc.cpp | 16 ++- 3 files changed, 300 insertions(+), 16 deletions(-) diff --git a/devices/serial/chario.cpp b/devices/serial/chario.cpp index 5508e04..74f0f2b 100644 --- a/devices/serial/chario.cpp +++ b/devices/serial/chario.cpp @@ -56,7 +56,7 @@ HANDLE hOutput = GetStdHandle(STD_OUTPUT_HANDLE); DWORD old_in_mode, old_out_mode; int old_stdin_trans_mode; -void mysig_handler(int signum) { +void CharIoStdin::mysig_handler(int signum) { SetStdHandle(signum, hInput); SetStdHandle(signum, hOutput); } @@ -127,24 +127,24 @@ int CharIoStdin::rcv_char(uint8_t* c) { #else // non-Windows OS (Linux, mac OS etc.) -#include #include #include #include #include -#include #include -struct sigaction old_act, new_act; +struct sigaction old_act_sigint, new_act_sigint; +struct sigaction old_act_sigterm, new_act_sigterm; struct termios orig_termios; -void mysig_handler(int signum) +void CharIoStdin::mysig_handler(int signum) { // restore original terminal state tcsetattr(STDIN_FILENO, TCSANOW, &orig_termios); // restore original signal handler for SIGINT - signal(SIGINT, old_act.sa_handler); + signal(SIGINT, old_act_sigint.sa_handler); + signal(SIGTERM, old_act_sigterm.sa_handler); LOG_F(INFO, "Old terminal state restored, SIG#=%d", signum); @@ -171,9 +171,15 @@ int CharIoStdin::rcv_enable() // save original signal handler for SIGINT // then redirect SIGINT to new handler - memset(&new_act, 0, sizeof(new_act)); - new_act.sa_handler = mysig_handler; - sigaction(SIGINT, &new_act, &old_act); + memset(&new_act_sigint, 0, sizeof(new_act_sigint)); + new_act_sigint.sa_handler = mysig_handler; + sigaction(SIGINT, &new_act_sigint, &old_act_sigint); + + // save original signal handler for SIGTERM + // then redirect SIGTERM to new handler + memset(&new_act_sigterm, 0, sizeof(new_act_sigterm)); + new_act_sigterm.sa_handler = mysig_handler; + sigaction(SIGTERM, &new_act_sigterm, &old_act_sigterm); this->stdio_inited = true; @@ -189,25 +195,38 @@ void CharIoStdin::rcv_disable() tcsetattr(STDIN_FILENO, TCSANOW, &orig_termios); // restore original signal handler for SIGINT - signal(SIGINT, old_act.sa_handler); + signal(SIGINT, old_act_sigint.sa_handler); + + // restore original signal handler for SIGTERM + signal(SIGTERM, old_act_sigterm.sa_handler); this->stdio_inited = false; } bool CharIoStdin::rcv_char_available() { + static int consecutivechars = 0; + + if (consecutivechars >= 15) { + consecutivechars++; + if (consecutivechars >= 400) + consecutivechars = 0; + return 0; + } + fd_set readfds; FD_ZERO(&readfds); FD_SET(STDIN_FILENO, &readfds); - fd_set savefds = readfds; struct timeval timeout; timeout.tv_sec = 0; timeout.tv_usec = 0; - int chr; - int sel_rv = select(1, &readfds, NULL, NULL, &timeout); + if (sel_rv > 0) + consecutivechars++; + else + consecutivechars = 0; return sel_rv > 0; } @@ -224,3 +243,233 @@ int CharIoStdin::rcv_char(uint8_t *c) } #endif + +//======================== SOCKET character I/O backend ======================== +#ifdef _WIN32 + +#else // non-Windows OS (Linux, mac OS etc.) + +#include +#include +#include + + +CharIoSocket::CharIoSocket() +{ + int rc; + + path = "dingussocket"; + + do { + rc = unlink(path); + if (rc == 0) { + LOG_F(INFO, "socket unlinked %s", path); + } + else if (errno != ENOENT) { + LOG_F(INFO, "socket unlink err: %s", strerror(errno)); + break; + } + + sockaddr_un address; + memset(&address, 0, sizeof(address)); + address.sun_family = AF_UNIX; + strcpy(address.sun_path, path); + + sockfd = socket(AF_UNIX, SOCK_STREAM, 0); + if (sockfd == -1) { + LOG_F(INFO, "socket create err: %s", strerror(errno)); + break; + } + + rc = bind(sockfd, (sockaddr*)(&address), sizeof(address)); + if (rc == -1) { + LOG_F(INFO, "socket bind err: %s", strerror(errno)); + close(sockfd); + sockfd = -1; + break; + } + + rc = listen(sockfd, 100); + if (rc == -1) { + LOG_F(INFO, "socket listen err: %s", strerror(errno)); + close(sockfd); + sockfd = -1; + break; + } + + LOG_F(INFO, "socket listen %d", sockfd); + + } while (0); +}; + + +CharIoSocket::~CharIoSocket() { + unlink(path); + if (errno != ENOENT) { + LOG_F(INFO, "socket unlink err: %s", strerror(errno)); + } + if (sockfd != -1) { + close(sockfd); + sockfd = -1; + } +} + + +int CharIoSocket::rcv_enable() +{ + if (this->socket_inited) + return 0; + + this->socket_inited = true; + + return 0; +} + +void CharIoSocket::rcv_disable() +{ + if (!this->socket_inited) + return; + + this->socket_inited = false; +} + +bool CharIoSocket::rcv_char_available() +{ + static int consecutivechars = 0; + static int count = 0; + + if (consecutivechars >= 15) { + consecutivechars++; + if (consecutivechars >= 400) + consecutivechars = 0; + return 0; + } + + int sel_rv = 0; + bool havechars = false; + fd_set readfds; + fd_set writefds; + fd_set errorfds; + + int sockmax = 0; + if (sockfd != -1) { + FD_ZERO(&readfds); + FD_SET(sockfd, &readfds); + if (sockfd > sockmax) sockmax = sockfd; + if (acceptfd != -1) { + FD_SET(acceptfd, &readfds); + if (acceptfd > sockmax) sockmax = acceptfd; + } + writefds = readfds; + errorfds = readfds; + + struct timeval timeout; + timeout.tv_sec = 0; + timeout.tv_usec = 0; + + sel_rv = select(sockmax + 1, &readfds, &writefds, &errorfds, &timeout); + if (sel_rv == -1) { + LOG_F(INFO, "socket select err: %s", strerror(errno)); + } + } + + if (sel_rv > 0) { + if (sockfd != -1) { + if (FD_ISSET(sockfd, &readfds)) { + uint8_t c; + int received = recv(sockfd, &c, 1, 0); + if (received == -1 && acceptfd != -1) { + LOG_F(INFO, "socket sock read err: %s", strerror(errno)); + } + else if (received == 1) { + LOG_F(INFO, "socket sock read '%c'", c); + } + else { + LOG_F(INFO, "socket sock read %d", received); + } + + if (acceptfd == -1) { + sockaddr_un acceptfdaddr; + memset(&acceptfdaddr, 0, sizeof(acceptfdaddr)); + socklen_t len = sizeof(acceptfdaddr); + acceptfd = accept(sockfd, (struct sockaddr *) &acceptfdaddr, &len); + if (acceptfd == -1){ + LOG_F(INFO, "socket accept err: %s", strerror(errno)); + } + else { + LOG_F(INFO, "socket accept %d", acceptfd); + } + } + } // if read + + if (FD_ISSET(sockfd, &writefds)) { + LOG_F(INFO, "socket sock write"); + } + + if (FD_ISSET(sockfd, &errorfds)) { + LOG_F(INFO, "socket sock error"); + } + } // if sockfd + + if (acceptfd != -1) { + if (FD_ISSET(acceptfd, &readfds)) { + // LOG_F(INFO, "socket accept read havechars"); + havechars = true; + consecutivechars++; + } // if read + + if (FD_ISSET(acceptfd, &writefds)) { + // LOG_F(INFO, "socket accept write"); // this is usually always true + } + + if (FD_ISSET(acceptfd, &errorfds)) { + LOG_F(INFO, "socket accept error"); + } + } // if acceptfd + } + else + consecutivechars = 0; + return havechars; +} + +int CharIoSocket::xmit_char(uint8_t c) +{ + if (acceptfd == -1) + CharIoSocket::rcv_char_available(); + + if (acceptfd != -1) { + int sent = send(acceptfd, &c, 1, 0); + if (sent == -1) { + LOG_F(INFO, "socket accept write err: %s", strerror(errno)); + } + if (sent == 1) { + // LOG_F(INFO, "socket accept write '%c'", c); + } + else { + LOG_F(INFO, "socket accept write %d", sent); + } + } + return 0; +} + +int CharIoSocket::rcv_char(uint8_t *c) +{ + if (acceptfd == -1) + CharIoSocket::rcv_char_available(); + + if (acceptfd != -1) { + int received = recv(acceptfd, c, 1, 0); + if (received == -1) { + LOG_F(INFO, "socket accept read err: %s", strerror(errno)); + } + else if (received == 1) { + // LOG_F(INFO, "socket accept read '%c'", c ? *c : 0); + } + else { + LOG_F(INFO, "socket accept read %d", received); + } + } + return 0; +} + +#endif diff --git a/devices/serial/chario.h b/devices/serial/chario.h index 118b26f..2bc2d0b 100644 --- a/devices/serial/chario.h +++ b/devices/serial/chario.h @@ -26,13 +26,16 @@ along with this program. If not, see . #include -#ifndef _WIN32 +#ifdef _WIN32 +#else #include +#include #endif enum { CHARIO_BE_NULL = 0, // NULL backend: swallows everything, receives nothing CHARIO_BE_STDIO = 1, // STDIO backend: uses STDIN for input and STDOUT for output + CHARIO_BE_SOCKET = 2, // socket backend: uses a socket for input and output }; /** Interface for character I/O backends. */ @@ -72,7 +75,27 @@ public: int rcv_char(uint8_t *c); private: + static void mysig_handler(int signum); bool stdio_inited; }; +/** Socket character I/O backend. */ +class CharIoSocket : public CharIoBackEnd { +public: + CharIoSocket(); + ~CharIoSocket(); + + int rcv_enable(); + void rcv_disable(); + bool rcv_char_available(); + int xmit_char(uint8_t c); + int rcv_char(uint8_t *c); + +private: + bool socket_inited = false; + int sockfd = -1; + int acceptfd = -1; + const char* path = 0; +}; + #endif // CHAR_IO_H diff --git a/devices/serial/escc.cpp b/devices/serial/escc.cpp index 4bed831..49cb590 100644 --- a/devices/serial/escc.cpp +++ b/devices/serial/escc.cpp @@ -49,7 +49,13 @@ EsccController::EsccController() std::string backend_name = GET_STR_PROP("serial_backend"); this->ch_a->attach_backend( - (backend_name == "stdio") ? CHARIO_BE_STDIO : CHARIO_BE_NULL); + (backend_name == "stdio") ? CHARIO_BE_STDIO : +#ifdef _WIN32 +#else + (backend_name == "socket") ? CHARIO_BE_SOCKET : +#endif + CHARIO_BE_NULL + ); this->ch_b->attach_backend(CHARIO_BE_NULL); this->reg_ptr = 0; @@ -166,6 +172,12 @@ void EsccChannel::attach_backend(int id) case CHARIO_BE_STDIO: this->chario = std::unique_ptr (new CharIoStdin); break; +#ifdef _WIN32 +#else + case CHARIO_BE_SOCKET: + this->chario = std::unique_ptr (new CharIoSocket); + break; +#endif default: LOG_F(ERROR, "ESCC: unknown backend ID %d, using NULL instead", id); this->chario = std::unique_ptr (new CharIoNull); @@ -309,7 +321,7 @@ uint8_t EsccChannel::receive_byte() return c; } -static const vector CharIoBackends = {"null", "stdio"}; +static const vector CharIoBackends = {"null", "stdio", "socket"}; static const PropMap Escc_Properties = { {"serial_backend", new StrProperty("null", CharIoBackends)},