Files
org-hyperion-cules/sockdev.c
Fish (David B. Trout) d094e4f3c6 Carry over into SDL Hyperion some recent Aethra fixes:
. Fix compiler warnings on macOS.
. Fix compiler warnings on GCC 12.

. Use performance cores on Apple Silicon. (Enrico Sorichetti)

. Save maxprio/minprio in sysblk so impl() doesn't clobber them. (Tyler Mitchell)
. Handle non-GNU Linuxes properly. (Tyler Mitchell)
. getprotobyname: some Linuxes want "tcp" not "TCP". (Tyler Mitchell)
. Fix for occasional crash on exit. (Tyler Mitchell):

  In POSIX, detach_thread() is neither needed nor valid
  after a return from join_thread(). When the latter returns,
  the thread has exited and its resources are released,
  so detach_thread() not only is not needed, but references
  deallocated resources. This can be harmless, but not always.
2024-01-24 13:17:39 -08:00

634 lines
18 KiB
C

/* SOCKET.C (C) Copyright Roger Bowler, 1999-2012 */
/* Hercules Socketdevice Handler */
/* */
/* Released under "The Q Public License Version 1" */
/* (http://www.hercules-390.org/herclic.html) as modifications to */
/* Hercules. */
#include "hstdinc.h"
#include "hercules.h"
#include "opcode.h"
#if defined(WIN32) && !defined(HDL_USE_LIBTOOL) && !defined(_MSVC_)
extern SYSBLK *psysblk;
#define sysblk (*psysblk)
#endif
/*===================================================================*/
/* S o c k e t D e v i c e s ... */
/*===================================================================*/
// #define DEBUG_SOCKDEV
#ifdef DEBUG_SOCKDEV
#define DEBUGMSG LOGMSG
#else
#define DEBUGMSG 1 ? ((void)0) : LOGMSG
#endif
/*-------------------------------------------------------------------*/
/* Working storage */
/*-------------------------------------------------------------------*/
static int init_done = FALSE;
static LIST_ENTRY bind_head; /* (bind_struct list anchor) */
/*-------------------------------------------------------------------*/
/* Initialization / termination functions... */
/*-------------------------------------------------------------------*/
static void init_sockdev( void );
static void term_sockdev( void* );
static void init_sockdev( void )
{
obtain_lock( &sysblk.bindlock );
{
if (!init_done)
{
InitializeListHead( &bind_head );
hdl_addshut( "term_sockdev", term_sockdev, NULL );
init_done = TRUE;
}
}
release_lock( &sysblk.bindlock );
}
static void term_sockdev( void* arg )
{
UNREFERENCED( arg );
if (!init_done) init_sockdev();
SIGNAL_SOCKDEV_THREAD();
join_thread ( sysblk.socktid, NULL );
#if defined( OPTION_FTHREADS )
detach_thread ( sysblk.socktid ); // only needed for fthreads
#endif
}
/*-------------------------------------------------------------------*/
/* unix_socket create and bind a Unix domain socket */
/*-------------------------------------------------------------------*/
int unix_socket( char* path )
{
#if !defined( HAVE_SYS_UN_H )
UNREFERENCED( path );
// "COMM: this hercules build does not support unix domain sockets"
WRMSG( HHC01032, "E" );
return -1;
#else
struct sockaddr_un addr;
int sd;
DEBUGMSG( "unix_socket(%s)\n", path );
if (strlen( path ) > sizeof( addr.sun_path ) - 1)
{
// "COMM: error: socket pathname %s exceeds limit %d"
WRMSG( HHC01033, "E", path, (int) sizeof( addr.sun_path ) - 1 );
return -1;
}
addr.sun_family = AF_UNIX;
STRLCPY( addr.sun_path, path ); /* guaranteed room by above check */
if ((sd = socket( PF_UNIX, SOCK_STREAM, 0 )) < 0)
{
// "COMM: error in function %s: %s"
WRMSG( HHC01034, "E", "socket()", strerror( HSO_errno ));
return -1;
}
unlink( path ); // (i.e. delete file/folder)
fchmod( sd, 0700 ); // (remove group permissions)
if (0
|| bind( sd, (struct sockaddr*) &addr, sizeof( addr )) < 0
|| listen( sd, 1 ) < 0
)
{
// "COMM: error in function %s: %s"
WRMSG( HHC01034, "E", "bind()", strerror( HSO_errno ));
return -1;
}
return sd;
#endif // defined( HAVE_SYS_UN_H )
}
/*-------------------------------------------------------------------*/
/* inet_socket create and bind a regular TCP/IP socket */
/*-------------------------------------------------------------------*/
int inet_socket( char* spec )
{
/* We need a copy of the path to overwrite a ':' with '\0' */
char buf[sizeof(((DEVBLK*)0)->filename)];
char* colon;
char* node;
char* service;
int sd;
int one = 1;
struct sockaddr_in sin;
DEBUGMSG("inet_socket(%s)\n", spec);
memset( &sin, 0, sizeof( sin ));
sin.sin_family = AF_INET;
STRLCPY( buf, spec );
colon = strchr( buf, ':' );
if (colon)
{
*colon = '\0';
node = buf;
service = colon + 1;
}
else
{
node = NULL;
service = buf;
}
if (!node)
sin.sin_addr.s_addr = INADDR_ANY;
else
{
struct hostent* he = gethostbyname( node );
if (!he)
{
// "COMM: failed to determine IP address from node %s"
WRMSG( HHC01035, "E", node );
return -1;
}
memcpy( &sin.sin_addr, he->h_addr_list[0], sizeof( sin.sin_addr ));
}
if (isdigit( (unsigned char)service[0] ))
{
sin.sin_port = htons( atoi( service ));
}
else
{
struct servent* se = getservbyname( service, "tcp" );
if (!se)
{
// "COMM: failed to determine port number from service %s"
WRMSG( HHC01036, "E", service );
return -1;
}
sin.sin_port = se->s_port;
}
if ((sd = socket( PF_INET, SOCK_STREAM, 0 )) < 0)
{
// "COMM: error in function %s: %s"
WRMSG( HHC01034, "E", "socket()", strerror( HSO_errno ));
return -1;
}
setsockopt( sd, SOL_SOCKET, SO_REUSEADDR, (GETSET_SOCKOPT_T*) &one, sizeof( one ));
if (0
|| bind( sd, (struct sockaddr*) &sin, sizeof( sin )) < 0
|| listen( sd, 1 ) < 0
)
{
// "COMM: error in function %s: %s"
WRMSG( HHC01034, "E", "bind()", strerror( HSO_errno ));
return -1;
}
return sd;
}
/*-------------------------------------------------------------------*/
/* add_socket_devices_to_fd_set add all bound socket devices' */
/* listening sockets to the FD_SET */
/*-------------------------------------------------------------------*/
int add_socket_devices_to_fd_set( int maxfd, fd_set* readset )
{
bind_struct* bs;
LIST_ENTRY* pListEntry;
obtain_lock( &sysblk.bindlock );
{
pListEntry = bind_head.Flink;
while (pListEntry != &bind_head)
{
bs = CONTAINING_RECORD( pListEntry, bind_struct, bind_link );
if (bs->sd != -1) /* if listening for connections, */
{
FD_SET( bs->sd, readset ); /* then add file to set */
if (bs->sd > maxfd)
maxfd = bs->sd;
}
pListEntry = pListEntry->Flink;
}
}
release_lock( &sysblk.bindlock );
return maxfd;
}
/*-------------------------------------------------------------------*/
/* socket_device_connection_handler */
/*-------------------------------------------------------------------*/
void socket_device_connection_handler( bind_struct* bs )
{
struct sockaddr_in client; /* Client address structure */
struct hostent* pHE; /* Addr of hostent structure */
socklen_t namelen; /* Length of client structure*/
char* clientip; /* Addr of client ip address */
char* clientname; /* Addr of client hostname */
DEVBLK* dev; /* Device Block pointer */
int csock; /* Client socket */
dev = bs->dev;
DEBUGMSG("socket_device_connection_handler(dev=%4.4X)\n",
dev->devnum);
/* Accept the connection... */
if ((csock = accept( bs->sd, NULL, NULL )) < 0)
{
// "%1d:%04X COMM: error in function %s: %s"
WRMSG( HHC01000, "E", LCSS_DEVNUM, "accept()", strerror( HSO_errno ));
return;
}
/* Determine the connected client's IP address and hostname */
namelen = sizeof( client );
clientip = NULL;
clientname = "<unknown>";
if (1
&& getpeername( csock, (struct sockaddr*) &client, &namelen ) == 0
&& (clientip = inet_ntoa( client.sin_addr )) != NULL
&& (pHE = gethostbyaddr( (unsigned char*)(&client.sin_addr),
sizeof( client.sin_addr ), AF_INET )) != NULL
&& pHE->h_name
&& *pHE->h_name
)
{
clientname = (char*) pHE->h_name;
}
if (!clientip)
clientip = "<unknown>";
/* Obtain the device lock */
OBTAIN_DEVLOCK( dev );
{
/* Reject if device is busy or interrupt pending */
if (0
|| dev->busy
|| IOPENDING( dev )
|| (dev->scsw.flag3 & SCSW3_SC_PEND)
)
{
close_socket( csock );
// "%1d:%04X COMM: client %s, IP %s connection to device %s rejected: device busy or interrupt pending"
WRMSG( HHC01037, "E", LCSS_DEVNUM, clientname, clientip, bs->spec );
RELEASE_DEVLOCK( dev );
return;
}
/* Reject new client if previous client still connected */
if (dev->fd >= 0)
{
close_socket( csock );
// "%1d:%04X COMM: client %s, IP %s connection to device %s rejected: client %s ip %s still connected"
WRMSG( HHC01038, "E", LCSS_DEVNUM, clientname, clientip, bs->spec,
bs->clientname, bs->clientip );
RELEASE_DEVLOCK( dev );
return;
}
/* Indicate that a client is now connected to this device */
dev->fd = csock;
if (bs->clientip) free( bs->clientip );
if (bs->clientname) free( bs->clientname );
bs->clientip = strdup( clientip );
bs->clientname = strdup( clientname );
/* Call the boolean onconnect callback */
if (bs->fn && !bs->fn( bs->arg ))
{
/* Callback says it can't accept it */
close_socket( dev->fd );
dev->fd = -1;
// "%1d:%04X COMM: client %s, IP %s connection to device %s rejected: by onconnect callback"
WRMSG( HHC01039, "E", LCSS_DEVNUM, clientname, clientip, bs->spec );
RELEASE_DEVLOCK( dev );
return;
}
// "%1d:%04X COMM: client %s, IP %s connected to device %s"
WRMSG( HHC01040, "I", LCSS_DEVNUM, clientname, clientip, bs->spec );
}
RELEASE_DEVLOCK( dev );
device_attention( dev, CSW_DE );
}
/*-------------------------------------------------------------------*/
/* check_socket_devices_for_connections */
/*-------------------------------------------------------------------*/
void check_socket_devices_for_connections( fd_set* readset )
{
bind_struct* bs;
LIST_ENTRY* pListEntry;
obtain_lock( &sysblk.bindlock );
{
pListEntry = bind_head.Flink;
while (pListEntry != &bind_head)
{
bs = CONTAINING_RECORD( pListEntry, bind_struct, bind_link );
if (bs->sd >= 0 && FD_ISSET( bs->sd, readset ))
{
/* Note: there may be other connection requests
* waiting to be serviced, but we'll catch them
* the next time the panel thread calls us. */
release_lock( &sysblk.bindlock );
socket_device_connection_handler( bs );
return;
}
pListEntry = pListEntry->Flink;
}
}
release_lock( &sysblk.bindlock );
}
/*-------------------------------------------------------------------*/
/* socket_thread listen for socket device connections */
/*-------------------------------------------------------------------*/
void* socket_thread( void* arg )
{
int rc;
fd_set sockset;
int maxfd = 0;
int select_errno;
int exit_now;
UNREFERENCED( arg );
SET_THREAD_PRIORITY( sysblk.srvprio, sysblk.qos_user_initiated );
/* Display thread started message on control panel */
LOG_THREAD_BEGIN( SOCKET_THREAD_NAME );
for (;;)
{
/* Set the file descriptors for select */
FD_ZERO( &sockset );
maxfd = add_socket_devices_to_fd_set( 0, &sockset );
SUPPORT_WAKEUP_SOCKDEV_SELECT_VIA_PIPE( maxfd, &sockset );
/* Do the select and save results */
rc = select( maxfd+1, &sockset, NULL, NULL, NULL );
select_errno = HSO_errno;
/* Clear the pipe signal if necessary */
RECV_SOCKDEV_THREAD_PIPE_SIGNAL();
/* Check if it's time to exit yet */
obtain_lock( &sysblk.bindlock );
{
exit_now = (sysblk.shutdown || IsListEmpty( &bind_head ));
}
release_lock( &sysblk.bindlock );
if (exit_now)
break;
/* Log select errors */
if (rc < 0)
{
if (HSO_EINTR != select_errno)
// "COMM: error in function %s: %s"
WRMSG( HHC01034, "E", "select()", strerror( select_errno ));
continue;
}
/* Check if any sockets have received new connections */
check_socket_devices_for_connections( &sockset );
}
LOG_THREAD_END( SOCKET_THREAD_NAME );
return NULL;
}
/* (end socket_thread) */
/*-------------------------------------------------------------------*/
/* bind_device bind a device to a socket (adds entry to our list */
/* of bound devices) (1=success, 0=failure) */
/*-------------------------------------------------------------------*/
int bind_device_ex( DEVBLK* dev, char* spec, ONCONNECT fn, void* arg )
{
bind_struct* bs;
int was_list_empty;
int rc;
if (!init_done)
init_sockdev();
if (sysblk.shutdown)
return 0;
DEBUGMSG("bind_device (%4.4X, %s)\n", dev->devnum, spec);
/* Error if device already bound */
if (dev->bs)
{
WRMSG( HHC01041, "E", LCSS_DEVNUM, dev->bs->spec );
return 0; /* (failure) */
}
/* Create a new bind_struct entry */
bs = malloc( sizeof( bind_struct ));
if (!bs)
{
char buf[40];
MSGBUF( buf, "malloc(%d)", (int) sizeof( bind_struct ));
// "%1d:%04X COMM: error in function %s: %s"
WRMSG( HHC01000, "E", LCSS_DEVNUM, buf, strerror( errno ));
return 0; /* (failure) */
}
memset( bs, 0, sizeof( bind_struct ));
bs->fn = fn;
bs->arg = arg;
if (!(bs->spec = strdup( spec )))
{
// "%1d:%04X COMM: error in function %s: %s"
WRMSG( HHC01000, "E", LCSS_DEVNUM, "strdup()", strerror( errno ));
free( bs );
return 0; /* (failure) */
}
/* Create a listening socket */
if (bs->spec[0] == '/') bs->sd = unix_socket( bs->spec );
else bs->sd = inet_socket( bs->spec );
if (bs->sd < 0)
{
/* (error message already issued) */
free( bs->spec );
free( bs );
return 0; /* (failure) */
}
/* Chain device and bind_struct to each other */
dev->bs = bs;
bs->dev = dev;
/* Add the new entry to our list of bound devices
and create the socket thread that will listen
for connections (if it doesn't already exist) */
obtain_lock( &sysblk.bindlock );
{
was_list_empty = IsListEmpty( &bind_head );
InsertListTail( &bind_head, &bs->bind_link );
if (was_list_empty)
{
rc = create_thread( &sysblk.socktid, JOINABLE,
socket_thread, NULL, SOCKET_THREAD_NAME );
if (rc)
{
// "Error in function create_thread(): %s"
WRMSG( HHC00102, "E", strerror( rc ));
RemoveListEntry( &bs->bind_link );
close_socket( bs->sd );
free( bs->spec );
free( bs );
release_lock( &sysblk.bindlock );
return 0; /* (failure) */
}
}
SIGNAL_SOCKDEV_THREAD();
}
release_lock( &sysblk.bindlock );
// "%1d:%04X COMM: device bound to socket %s"
WRMSG( HHC01042, "I", LCSS_DEVNUM, dev->bs->spec );
return 1; /* (success) */
}
/*-------------------------------------------------------------------*/
/* unbind_device unbind a device from a socket (removes entry from */
/* our list and discards it) (1=success, 0=failure) */
/*-------------------------------------------------------------------*/
int unbind_device_ex( DEVBLK* dev, int forced )
{
bind_struct* bs;
DEBUGMSG("unbind_device(%4.4X)\n", dev->devnum);
/* Error if device not bound */
if (!(bs = dev->bs))
{
// "%1d:%04X COMM: device not bound to any socket"
WRMSG( HHC01043, "E", LCSS_DEVNUM );
return 0; /* (failure) */
}
/* Is anyone still connected? */
if (dev->fd >= 0)
{
/* Yes. Should we forcibly disconnect them? */
if (forced)
{
/* Yes. Then do so... */
close_socket( dev->fd );
dev->fd = -1;
// "%1d:%04X COMM: client %s, IP %s disconnected from device %s"
WRMSG( HHC01044, "I", LCSS_DEVNUM, dev->bs->clientip,
dev->bs->clientname, dev->bs->spec );
}
else
{
/* No. Then fail the request. */
// "%1d:%04X COMM: client %s, IP %s still connected to device %s"
WRMSG( HHC01045, "E", LCSS_DEVNUM, dev->bs->clientip,
dev->bs->clientname, dev->bs->spec );
return 0; /* (failure) */
}
}
/* Remove the entry from our list */
obtain_lock( &sysblk.bindlock );
{
RemoveListEntry( &bs->bind_link );
SIGNAL_SOCKDEV_THREAD();
}
release_lock( &sysblk.bindlock );
// "%1d:%04X COMM: device unbound from socket %s"
WRMSG( HHC01046, "I",LCSS_DEVNUM, bs->spec );
if (bs->sd >= 0)
close_socket( bs->sd );
/* Unchain device and bind_struct from each another */
dev->bs = NULL;
bs->dev = NULL;
/* Discard the entry */
if ( bs->clientname ) free( bs->clientname );
if ( bs->clientip ) free( bs->clientip );
bs->clientname = NULL;
bs->clientip = NULL;
free ( bs->spec );
free ( bs );
return 1; /* (success) */
}