Hamlib/tests/rigctltcp.c

1564 wiersze
41 KiB
C

/*
* rigctltcp.c - (C) Stephane Fillod 2000-2011
* (C) Nate Bargmann 2008,2010,2011,2012,2013
* (C) The Hamlib Group 2012-2022
*
* This program test/control a radio using Hamlib.
* It takes commands from a tcp network connection.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
#include <hamlib/config.h>
#ifdef WIN32
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <signal.h>
#include <getopt.h>
#include <sys/types.h> /* See NOTES */
#ifdef HAVE_NETINET_IN_H
# include <netinet/in.h>
#endif
#ifdef HAVE_ARPA_INET_H
# include <arpa/inet.h>
#endif
#ifdef HAVE_SYS_SELECT_H
# include <sys/select.h>
#endif
#ifdef HAVE_SYS_SOCKET_H
# include <sys/socket.h>
#elif HAVE_WS2TCPIP_H
# include <ws2tcpip.h>
# include <fcntl.h>
# if defined(HAVE_WSPIAPI_H)
# include <wspiapi.h>
# endif
#endif
#ifdef HAVE_NETDB_H
# include <netdb.h>
#endif
#ifdef HAVE_PTHREAD
# include <pthread.h>
#endif
#include <hamlib/rig.h>
#include "misc.h"
#include "network.h"
#include "riglist.h"
#include "rigctl_parse.h"
/*
* Reminder: when adding long options,
* keep up to date SHORT_OPTIONS, usage()'s output and man page. thanks.
* TODO: add an option to read from a file
*/
#define SHORT_OPTIONS "m:r:p:d:P:D:s:S:c:T:t:C:W:w:x:z:lLuovhVZMRA:n:"
static struct option long_options[] =
{
{"model", 1, 0, 'm'},
{"rig-file", 1, 0, 'r'},
{"ptt-file", 1, 0, 'p'},
{"dcd-file", 1, 0, 'd'},
{"ptt-type", 1, 0, 'P'},
{"dcd-type", 1, 0, 'D'},
{"serial-speed", 1, 0, 's'},
{"separator", 1, 0, 'S'},
{"civaddr", 1, 0, 'c'},
{"listen-addr", 1, 0, 'T'},
{"port", 1, 0, 't'},
{"set-conf", 1, 0, 'C'},
{"list", 0, 0, 'l'},
{"show-conf", 0, 0, 'L'},
{"dump-caps", 0, 0, 'u'},
{"vfo", 0, 0, 'o'},
{"verbose", 0, 0, 'v'},
{"help", 0, 0, 'h'},
{"version", 0, 0, 'V'},
{"twiddle_timeout", 1, 0, 'W'},
{"twiddle_rit", 1, 0, 'w'},
{"uplink", 1, 0, 'x'},
{"debug-time-stamps", 0, 0, 'Z'},
{"multicast-addr", 1, 0, 'M'},
{"multicast-port", 1, 0, 'n'},
{"password", 1, 0, 'A'},
{"rigctld-idle", 0, 0, 'R'},
{0, 0, 0, 0}
};
struct handle_data
{
RIG *rig;
int sock;
struct sockaddr_storage cli_addr;
socklen_t clilen;
int vfo_mode;
int use_password;
};
void *handle_socket(void *arg);
void usage(void);
#ifdef HAVE_PTHREAD
static unsigned client_count;
#endif
static RIG *my_rig; /* handle to rig (instance) */
static volatile int rig_opened = 0;
static int verbose;
#ifdef HAVE_SIG_ATOMIC_T
static sig_atomic_t volatile ctrl_c;
#else
static int volatile ctrl_c;
#endif
const char *portno = "4531";
const char *src_addr = NULL; /* INADDR_ANY */
const char *multicast_addr = "0.0.0.0";
int multicast_port = 4532;
extern char rigctld_password[65];
char resp_sep = '\n';
extern int lock_mode;
extern powerstat_t rig_powerstat;
static int rigctld_idle =
0; // if true then rig will close when no clients are connected
#define MAXCONFLEN 1024
void mutex_rigctld(int lock)
{
#ifdef HAVE_PTHREAD
static pthread_mutex_t client_lock = PTHREAD_MUTEX_INITIALIZER;
if (lock)
{
pthread_mutex_lock(&client_lock);
rig_debug(RIG_DEBUG_VERBOSE, "%s: client lock engaged\n", __func__);
}
else
{
rig_debug(RIG_DEBUG_VERBOSE, "%s: client lock disengaged\n", __func__);
pthread_mutex_unlock(&client_lock);
}
#endif
}
#ifdef WIN32
static BOOL WINAPI CtrlHandler(DWORD fdwCtrlType)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s: called\n", __func__);
switch (fdwCtrlType)
{
case CTRL_C_EVENT:
case CTRL_CLOSE_EVENT:
ctrl_c = 1;
return TRUE;
default:
return FALSE;
}
}
#else
static void signal_handler(int sig)
{
switch (sig)
{
case SIGINT:
ctrl_c = 1;
break;
default:
/* do nothing */
break;
}
}
#endif
static void handle_error(enum rig_debug_level_e lvl, const char *msg)
{
int e;
#ifdef __MINGW32__
LPVOID lpMsgBuf;
lpMsgBuf = (LPVOID)"Unknown error";
e = WSAGetLastError();
if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
| FORMAT_MESSAGE_FROM_SYSTEM
| FORMAT_MESSAGE_IGNORE_INSERTS,
NULL, e,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
// Default language
(LPTSTR)&lpMsgBuf, 0, NULL))
{
rig_debug(lvl, "%s: Network error %d: %s\n", msg, e, (char *)lpMsgBuf);
LocalFree(lpMsgBuf);
}
else
{
rig_debug(lvl, "%s: Network error %d\n", msg, e);
}
#else
e = errno;
rig_debug(lvl, "%s: Network error %d: %s\n", msg, e, strerror(e));
#endif
}
int main(int argc, char *argv[])
{
rig_model_t my_model = RIG_MODEL_DUMMY;
int retcode; /* generic return code from functions */
int show_conf = 0;
int dump_caps_opt = 0;
const char *rig_file = NULL, *ptt_file = NULL, *dcd_file = NULL;
ptt_type_t ptt_type = RIG_PTT_NONE;
dcd_type_t dcd_type = RIG_DCD_NONE;
int serial_rate = 0;
char *civaddr = NULL; /* NULL means no need to set conf */
char conf_parms[MAXCONFLEN] = "";
struct addrinfo hints, *result, *saved_result;
int sock_listen;
int reuseaddr = 1;
int twiddle_timeout = 0;
int twiddle_rit = 0;
int uplink = 0;
char host[NI_MAXHOST];
char serv[NI_MAXSERV];
char rigstartup[1024];
char vbuf[1024];
#if HAVE_SIGACTION
struct sigaction act;
#endif
#ifdef HAVE_PTHREAD
pthread_t thread;
pthread_attr_t attr;
#endif
struct handle_data *arg;
int vfo_mode = 0; /* vfo_mode=0 means target VFO is current VFO */
int i;
extern int is_rigctld;
is_rigctld = 1;
int err = setvbuf(stderr, vbuf, _IOFBF, sizeof(vbuf));
if (err) { rig_debug(RIG_DEBUG_ERR, "%s: setvbuf err=%s\n", __func__, strerror(err)); }
while (1)
{
int c;
int option_index = 0;
char dummy[2];
c = getopt_long(argc,
argv,
SHORT_OPTIONS,
long_options,
&option_index);
if (c == -1)
{
break;
}
switch (c)
{
case 'h':
usage();
exit(0);
case 'V':
printf("rigctltcp %s\n", hamlib_version2);
exit(0);
case 'R':
rigctld_idle = 1;
break;
case 'A':
strncpy(rigctld_password, optarg, sizeof(rigctld_password) - 1);
//char *md5 = rig_make_m d5(rigctld_password);
char md5[HAMLIB_SECRET_LENGTH + 1];
rig_password_generate_secret(rigctld_password, md5);
printf("Secret key: %s\n", md5);
rig_settings_save("sharedkey", md5, e_CHAR);
break;
case 'm':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
my_model = atoi(optarg);
break;
case 'r':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
rig_file = optarg;
break;
case 'p':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
ptt_file = optarg;
break;
case 'd':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
dcd_file = optarg;
break;
case 'P':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
if (!strcmp(optarg, "RIG"))
{
ptt_type = RIG_PTT_RIG;
}
else if (!strcmp(optarg, "DTR"))
{
ptt_type = RIG_PTT_SERIAL_DTR;
}
else if (!strcmp(optarg, "RTS"))
{
ptt_type = RIG_PTT_SERIAL_RTS;
}
else if (!strcmp(optarg, "PARALLEL"))
{
ptt_type = RIG_PTT_PARALLEL;
}
else if (!strcmp(optarg, "CM108"))
{
ptt_type = RIG_PTT_CM108;
}
else if (!strcmp(optarg, "GPIO"))
{
ptt_type = RIG_PTT_GPIO;
}
else if (!strcmp(optarg, "GPION"))
{
ptt_type = RIG_PTT_GPION;
}
else if (!strcmp(optarg, "NONE"))
{
ptt_type = RIG_PTT_NONE;
}
else
{
puts("Unrecognised PTT type, using NONE");
ptt_type = RIG_PTT_NONE;
}
break;
case 'D':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
if (!strcmp(optarg, "RIG"))
{
dcd_type = RIG_DCD_RIG;
}
else if (!strcmp(optarg, "DSR"))
{
dcd_type = RIG_DCD_SERIAL_DSR;
}
else if (!strcmp(optarg, "CTS"))
{
dcd_type = RIG_DCD_SERIAL_CTS;
}
else if (!strcmp(optarg, "CD"))
{
dcd_type = RIG_DCD_SERIAL_CAR;
}
else if (!strcmp(optarg, "PARALLEL"))
{
dcd_type = RIG_DCD_PARALLEL;
}
else if (!strcmp(optarg, "CM108"))
{
dcd_type = RIG_DCD_CM108;
}
else if (!strcmp(optarg, "GPIO"))
{
dcd_type = RIG_DCD_GPIO;
}
else if (!strcmp(optarg, "GPION"))
{
dcd_type = RIG_DCD_GPION;
}
else if (!strcmp(optarg, "NONE"))
{
dcd_type = RIG_DCD_NONE;
}
else
{
puts("Unrecognised DCD type, using NONE");
dcd_type = RIG_DCD_NONE;
}
break;
case 'c':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
civaddr = optarg;
break;
case 'S':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
resp_sep = *optarg;
rig_debug(RIG_DEBUG_VERBOSE, "%s: resp_sep=%c\n", __func__, resp_sep);
break;
case 's':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
if (sscanf(optarg, "%d%1s", &serial_rate, dummy) != 1)
{
fprintf(stderr, "Invalid baud rate of %s\n", optarg);
exit(1);
}
break;
case 'C':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
if (*conf_parms != '\0')
{
strcat(conf_parms, ",");
}
if (strlen(conf_parms) + strlen(optarg) > MAXCONFLEN - 24)
{
printf("Length of conf_parms exceeds internal maximum of %d\n",
MAXCONFLEN - 24);
return 1;
}
strncat(conf_parms, optarg, MAXCONFLEN - strlen(conf_parms));
break;
case 't':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
portno = optarg;
break;
case 'T':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
src_addr = optarg;
break;
case 'o':
vfo_mode++;
//rig_debug(RIG_DEBUG_ERR, "%s: #0 vfo_mode=%d\n", __func__, vfo_mode);
break;
case 'v':
verbose++;
break;
case 'L':
show_conf++;
break;
case 'l':
list_models();
exit(0);
case 'u':
dump_caps_opt++;
break;
case 'W':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
twiddle_timeout = atoi(optarg);
fprintf(stderr,
"twiddle_timeout is deprecated...use e.g. --set-conf=twiddle_timeout=5\n");
break;
case 'w':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
twiddle_rit = atoi(optarg);
fprintf(stderr,
"twiddle_timeout is deprecated...use e.g. --set-conf=twiddle_timeout=5\n");
break;
case 'x':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
uplink = atoi(optarg);
break;
case 'Z':
rig_set_debug_time_stamp(1);
break;
case 'M':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
multicast_addr = optarg;
break;
case 'n':
if (!optarg)
{
usage(); /* wrong arg count */
exit(1);
}
multicast_port = atoi(optarg);
if (multicast_port == 0)
{
fprintf(stderr, "Invalid multicast port: %s\n", optarg);
exit(1);
}
break;
default:
usage(); /* unknown option? */
exit(1);
}
}
#if 0
if (!vfo_mode)
{
printf("Recommend using --vfo switch for rigctld if client supports it\n");
printf("rigctl and netrigctl will automatically detect vfo mode\n");
}
#endif
rig_set_debug(verbose);
SNPRINTF(rigstartup, sizeof(rigstartup), "%s(%d) Startup:", __FILE__, __LINE__);
for (i = 0; i < argc; ++i) { strcat(rigstartup, " "); strcat(rigstartup, argv[i]); }
rig_debug(RIG_DEBUG_VERBOSE, "%s\n", rigstartup);
rig_debug(RIG_DEBUG_VERBOSE, "rigctltcp %s\n", hamlib_version2);
rig_debug(RIG_DEBUG_VERBOSE, "%s",
"Report bugs to <hamlib-developer@lists.sourceforge.net>\n\n");
rig_debug(RIG_DEBUG_VERBOSE, "Max# of rigctld client services=%d\n",
NI_MAXSERV);
my_rig = rig_init(my_model);
if (!my_rig)
{
fprintf(stderr,
"Unknown rig num %u, or initialization error.\n",
my_model);
fprintf(stderr, "Please check with --list option.\n");
exit(2);
}
retcode = set_conf(my_rig, conf_parms);
if (retcode != RIG_OK)
{
fprintf(stderr, "Config parameter error: %s\n", rigerror(retcode));
exit(2);
}
if (rig_file)
{
strncpy(my_rig->state.rigport.pathname, rig_file, HAMLIB_FILPATHLEN - 1);
}
my_rig->state.twiddle_timeout = twiddle_timeout;
my_rig->state.twiddle_rit = twiddle_rit;
my_rig->state.uplink = uplink;
rig_debug(RIG_DEBUG_TRACE, "%s: twiddle=%d, uplink=%d, twiddle_rit=%d\n",
__func__,
my_rig->state.twiddle_timeout, my_rig->state.uplink, my_rig->state.twiddle_rit);
/*
* ex: RIG_PTT_PARALLEL and /dev/parport0
*/
if (ptt_type != RIG_PTT_NONE)
{
my_rig->state.pttport.type.ptt = ptt_type;
my_rig->state.pttport_deprecated.type.ptt = ptt_type;
// This causes segfault since backend rig_caps are const
// rigctld will use the rig->state version of this for clients
//my_rig->caps->ptt_type = ptt_type;
}
if (dcd_type != RIG_DCD_NONE)
{
my_rig->state.dcdport.type.dcd = dcd_type;
my_rig->state.dcdport_deprecated.type.dcd = dcd_type;
}
if (ptt_file)
{
strncpy(my_rig->state.pttport.pathname, ptt_file, HAMLIB_FILPATHLEN - 1);
strncpy(my_rig->state.pttport_deprecated.pathname, ptt_file,
HAMLIB_FILPATHLEN - 1);
}
if (dcd_file)
{
strncpy(my_rig->state.dcdport.pathname, dcd_file, HAMLIB_FILPATHLEN - 1);
strncpy(my_rig->state.dcdport_deprecated.pathname, dcd_file,
HAMLIB_FILPATHLEN - 1);
}
/* FIXME: bound checking and port type == serial */
if (serial_rate != 0)
{
my_rig->state.rigport.parm.serial.rate = serial_rate;
my_rig->state.rigport_deprecated.parm.serial.rate = serial_rate;
}
if (civaddr)
{
rig_set_conf(my_rig, rig_token_lookup(my_rig, "civaddr"), civaddr);
}
/*
* print out conf parameters
*/
if (show_conf)
{
rig_token_foreach(my_rig, print_conf_list, (rig_ptr_t)my_rig);
}
/*
* print out conf parameters, and exits immediately
* We may be interested only in only caps, and rig_open may fail.
*/
if (dump_caps_opt)
{
dumpcaps(my_rig, stdout);
rig_cleanup(my_rig); /* if you care about memory */
exit(0);
}
/* attempt to open rig to check early for issues */
retcode = rig_open(my_rig);
rig_opened = retcode == RIG_OK ? 1 : 0;
if (retcode != RIG_OK)
{
fprintf(stderr, "rig_open: error = %s %s %s \n", rigerror(retcode), rig_file,
strerror(errno));
// continue even if opening the rig fails, because it may be powered off
}
if (verbose > RIG_DEBUG_ERR)
{
printf("Opened rig model %u, '%s'\n",
my_rig->caps->rig_model,
my_rig->caps->model_name);
}
rig_debug(RIG_DEBUG_VERBOSE, "Backend version: %s, Status: %s\n",
my_rig->caps->version, rig_strstatus(my_rig->caps->status));
// Normally we keep the rig open to speed up the 1st client connect
// But some rigs like the FT-736 have to lock the rig for CAT control
// So they need to release the rig when no clients are connected
if (rigctld_idle)
{
rig_close(my_rig); /* we will reopen for clients */
if (verbose > RIG_DEBUG_ERR)
{
printf("Closed rig model %d, '%s - will reopen for clients'\n",
my_rig->caps->rig_model,
my_rig->caps->model_name);
}
}
#ifdef __MINGW32__
# ifndef SO_OPENTYPE
# define SO_OPENTYPE 0x7008
# endif
# ifndef SO_SYNCHRONOUS_NONALERT
# define SO_SYNCHRONOUS_NONALERT 0x20
# endif
# ifndef INVALID_SOCKET
# define INVALID_SOCKET -1
# endif
WSADATA wsadata;
if (WSAStartup(MAKEWORD(1, 1), &wsadata) == SOCKET_ERROR)
{
fprintf(stderr, "WSAStartup socket error\n");
exit(1);
}
{
int sockopt = SO_SYNCHRONOUS_NONALERT;
setsockopt(INVALID_SOCKET, SOL_SOCKET, SO_OPENTYPE, (char *)&sockopt,
sizeof(sockopt));
}
#endif
/*
* Prepare listening socket
*/
memset(&hints, 0, sizeof(struct addrinfo));
hints.ai_family = AF_UNSPEC; /* Allow IPv4 or IPv6 */
hints.ai_socktype = SOCK_STREAM;/* TCP socket */
hints.ai_flags = AI_PASSIVE; /* For wildcard IP address */
hints.ai_protocol = 0; /* Any protocol */
retcode = getaddrinfo(src_addr, portno, &hints, &result);
if (retcode == 0 && result->ai_family == AF_INET6)
{
rig_debug(RIG_DEBUG_TRACE, "%s: Using IPV6\n", __func__);
}
else if (retcode == 0)
{
rig_debug(RIG_DEBUG_TRACE, "%s: Using IPV4\n", __func__);
}
else
{
fprintf(stderr, "getaddrinfo: %s\n", gai_strerror(retcode));
exit(2);
}
saved_result = result;
enum multicast_item_e items = RIG_MULTICAST_POLL | RIG_MULTICAST_TRANSCEIVE |
RIG_MULTICAST_SPECTRUM;
retcode = network_multicast_publisher_start(my_rig, multicast_addr,
multicast_port, items);
if (retcode != RIG_OK)
{
rig_debug(RIG_DEBUG_ERR, "%s: network_multicast_server failed: %s\n", __FILE__,
rigerror(retcode));
// we will consider this non-fatal for now
}
do
{
sock_listen = socket(result->ai_family,
result->ai_socktype,
result->ai_protocol);
if (sock_listen < 0)
{
handle_error(RIG_DEBUG_ERR, "socket");
freeaddrinfo(saved_result); /* No longer needed */
exit(2);
}
if (setsockopt(sock_listen,
SOL_SOCKET,
SO_REUSEADDR,
(char *)&reuseaddr,
sizeof(reuseaddr))
< 0)
{
handle_error(RIG_DEBUG_ERR, "setsockopt");
freeaddrinfo(saved_result); /* No longer needed */
exit(1);
}
#ifdef IPV6_V6ONLY
if (AF_INET6 == result->ai_family)
{
/* allow IPv4 mapped to IPv6 clients Windows and BSD default
this to 1 (i.e. disallowed) and we prefer it off */
int sockopt = 0;
if (setsockopt(sock_listen,
IPPROTO_IPV6,
IPV6_V6ONLY,
(char *)&sockopt,
sizeof(sockopt))
< 0)
{
handle_error(RIG_DEBUG_ERR, "setsockopt");
freeaddrinfo(saved_result); /* No longer needed */
exit(1);
}
}
#endif
if (0 == bind(sock_listen, result->ai_addr, result->ai_addrlen))
{
break;
}
handle_error(RIG_DEBUG_WARN, "binding failed (trying next interface)");
#ifdef __MINGW32__
closesocket(sock_listen);
#else
close(sock_listen);
#endif
}
while ((result = result->ai_next) != NULL);
freeaddrinfo(saved_result); /* No longer needed */
if (NULL == result)
{
rig_debug(RIG_DEBUG_ERR, "%s: bind error - no available interface\n", __func__);
exit(1);
}
if (listen(sock_listen, 4) < 0)
{
handle_error(RIG_DEBUG_ERR, "listening");
exit(1);
}
#if HAVE_SIGACTION
#ifdef SIGPIPE
/* Ignore SIGPIPE as we will handle it at the write()/send() calls
that will consequently fail with EPIPE. All child threads will
inherit this disposition which is what we want. */
memset(&act, 0, sizeof act);
act.sa_handler = SIG_IGN;
act.sa_flags = SA_RESTART;
if (sigaction(SIGPIPE, &act, NULL))
{
handle_error(RIG_DEBUG_ERR, "sigaction SIGPIPE");
}
#endif
#ifdef SIGINT
memset(&act, 0, sizeof act);
act.sa_handler = signal_handler;
if (sigaction(SIGINT, &act, NULL))
{
handle_error(RIG_DEBUG_ERR, "sigaction SIGINT");
}
#endif
#elif defined (WIN32)
if (!SetConsoleCtrlHandler(CtrlHandler, TRUE))
{
handle_error(RIG_DEBUG_ERR, "SetConsoleCtrlHandler");
}
#elif HAVE_SIGNAL
#ifdef SIGPIPE
if (SIG_ERR == signal(SIGPIPE, SIG_IGN))
{
handle_error(RIG_DEBUG_ERR, "signal SIGPIPE");
}
#endif
#ifdef SIGINT
if (SIG_ERR == signal(SIGINT, signal_handler))
{
handle_error(RIG_DEBUG_ERR, "signal SIGINT");
}
#endif
#endif
/*
* main loop accepting connections
*/
rig_debug(RIG_DEBUG_TRACE, "%s: rigctltcp listening on port %s\n", __func__,
portno);
do
{
fd_set set;
struct timeval timeout;
arg = calloc(1, sizeof(struct handle_data));
if (!arg)
{
rig_debug(RIG_DEBUG_ERR, "calloc: %s\n", strerror(errno));
exit(1);
}
if (rigctld_password[0] != 0) { arg->use_password = 1; }
/* use select to allow for periodic checks for CTRL+C */
FD_ZERO(&set);
FD_SET(sock_listen, &set);
timeout.tv_sec = 5;
timeout.tv_usec = 0;
retcode = select(sock_listen + 1, &set, NULL, NULL, &timeout);
if (retcode == -1)
{
int errno_stored = errno;
rig_debug(RIG_DEBUG_ERR, "%s: select() failed: %s\n", __func__,
strerror(errno_stored));
if (ctrl_c)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s: ctrl_c when retcode==-1\n", __func__);
break;
}
if (errno == EINTR)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s: ignoring interrupted system call\n",
__func__);
retcode = 0;
}
}
else if (retcode == 0)
{
if (ctrl_c)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s: ctrl_c when retcode==0\n", __func__);
break;
}
}
else
{
arg->rig = my_rig;
arg->clilen = sizeof(arg->cli_addr);
arg->vfo_mode = vfo_mode;
arg->sock = accept(sock_listen,
(struct sockaddr *)&arg->cli_addr,
&arg->clilen);
if (arg->sock < 0)
{
handle_error(RIG_DEBUG_ERR, "accept");
break;
}
if ((retcode = getnameinfo((struct sockaddr const *)&arg->cli_addr,
arg->clilen,
host,
sizeof(host),
serv,
sizeof(serv),
NI_NUMERICHOST | NI_NUMERICSERV))
< 0)
{
rig_debug(RIG_DEBUG_WARN,
"Peer lookup error: %s",
gai_strerror(retcode));
}
rig_debug(RIG_DEBUG_VERBOSE,
"Connection opened from %s:%s\n",
host,
serv);
#ifdef HAVE_PTHREAD
pthread_attr_init(&attr);
pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
retcode = pthread_create(&thread, &attr, handle_socket, arg);
if (retcode != 0)
{
rig_debug(RIG_DEBUG_ERR, "pthread_create: %s\n", strerror(retcode));
break;
}
#else
handle_socket(arg);
#endif
}
}
while (retcode == 0 && !ctrl_c);
rig_debug(RIG_DEBUG_VERBOSE, "%s: while loop done\n", __func__);
#ifdef HAVE_PTHREAD
/* allow threads to finish current action */
mutex_rigctld(1);
HAMLIB_TRACE;
if (client_count)
{
rig_debug(RIG_DEBUG_WARN, "%u outstanding client(s)\n", client_count);
}
rig_close(my_rig);
HAMLIB_TRACE;
mutex_rigctld(0);
HAMLIB_TRACE;
#else
rig_close(my_rig); /* close port */
#endif
HAMLIB_TRACE;
network_multicast_publisher_stop(my_rig);
HAMLIB_TRACE;
rig_cleanup(my_rig); /* if you care about memory */
#ifdef __MINGW32__
WSACleanup();
#endif
return 0;
}
static FILE *get_fsockout(struct handle_data *handle_data_arg)
{
#ifdef __MINGW32__
int sock_osfhandle = _open_osfhandle(handle_data_arg->sock, _O_RDONLY);
return _fdopen(sock_osfhandle, "wb");
#else
return fdopen(handle_data_arg->sock, "wb");
#endif
}
static FILE *get_fsockin(struct handle_data *handle_data_arg)
{
#ifdef __MINGW32__
int sock_osfhandle = _open_osfhandle(handle_data_arg->sock, _O_RDONLY);
if (sock_osfhandle == -1)
{
rig_debug(RIG_DEBUG_ERR, "_open_osfhandle error: %s\n", strerror(errno));
return NULL;
}
return _fdopen(sock_osfhandle, "rb");
#else
return fdopen(handle_data_arg->sock, "rb");
#endif
}
/*
* This is the function run by the threads
*/
void *handle_socket(void *arg)
{
struct handle_data *handle_data_arg = (struct handle_data *)arg;
FILE *fsockin = NULL;
FILE *fsockout = NULL;
int retcode = RIG_OK;
char host[NI_MAXHOST];
char serv[NI_MAXSERV];
rig_powerstat = RIG_POWER_ON; // defaults to power on
fsockin = get_fsockin(handle_data_arg);
if (!fsockin)
{
rig_debug(RIG_DEBUG_ERR, "%s: fdopen(0x%d) in: %s\n", __func__,
handle_data_arg->sock,
strerror(errno));
goto handle_exit;
}
fsockout = get_fsockout(handle_data_arg);
if (!fsockout)
{
rig_debug(RIG_DEBUG_ERR, "%s: fdopen out: %s\n", __func__, strerror(errno));
fclose(fsockin);
fsockin = NULL;
goto handle_exit;
}
#ifdef HAVE_PTHREAD
mutex_rigctld(1);
++client_count;
#if 0
if (!client_count++)
{
retcode = rig_open(my_rig);
if (RIG_OK == retcode && verbose > RIG_DEBUG_ERR)
{
printf("Opened rig model %d, '%s'\n",
my_rig->caps->rig_model,
my_rig->caps->model_name);
}
}
#endif
mutex_rigctld(0);
#else
mutex_rigctld(1);
retcode = rig_open(my_rig);
mutex_rigctld(1);
if (RIG_OK == retcode && verbose > RIG_DEBUG_ERR)
{
printf("Opened rig model %d, '%s'\n",
my_rig->caps->rig_model,
my_rig->caps->model_name);
}
#endif
if (my_rig->caps->get_powerstat)
{
mutex_rigctld(1);
rig_get_powerstat(my_rig, &rig_powerstat);
mutex_rigctld(0);
my_rig->state.powerstat = rig_powerstat;
}
do
{
mutex_rigctld(1);
if (!rig_opened)
{
retcode = rig_open(my_rig);
rig_opened = retcode == RIG_OK ? 1 : 0;
rig_debug(RIG_DEBUG_ERR, "%s: rig_open reopened retcode=%d\n", __func__,
retcode);
}
mutex_rigctld(0);
int nbytes = -1;
if (rig_opened) // only do this if rig is open
{
powerstat_t powerstat;
unsigned char cmd[64];
unsigned char reply[64];
unsigned char *term = (unsigned char *)";";
rig_debug(RIG_DEBUG_TRACE, "%s: doing rigctl_parse vfo_mode=%d, secure=%d\n",
__func__,
handle_data_arg->vfo_mode, handle_data_arg->use_password);
#if 0
retcode = rigctl_parse(handle_data_arg->rig, fsockin, fsockout, NULL, 0,
mutex_rigctld,
1, 0, &handle_data_arg->vfo_mode, send_cmd_term, &ext_resp, &resp_sep,
handle_data_arg->use_password);
#else
memset(cmd, 0, sizeof(cmd));
nbytes = -1;
do
{
++nbytes;
int val = fgetc(fsockin);
if (val == EOF) { goto client_done; }
rig_debug(RIG_DEBUG_ERR, "%s: val=0x%02x @ %d\n", __func__, val, nbytes);
cmd[nbytes] = val;
}
while (nbytes < sizeof(cmd) - 1 && cmd[nbytes] != ';' && cmd[nbytes] != 0xfd);
++nbytes;
rig_debug(RIG_DEBUG_ERR, "%s: bytes=%d, cmd=%s\n", __func__, nbytes, cmd);
if (cmd[nbytes - 1] == ';')
{
rig_debug(RIG_DEBUG_ERR, "%s: cmd kenwood=%s\n", __func__, cmd);
term[0] = ';';
term[1] = 0;
}
else if (cmd[0] == 0xfe && cmd[1] == 0xfe)
{
rig_debug(RIG_DEBUG_ERR, "%s: cmd#2 icom=%s\n", __func__, cmd);
dump_hex(cmd, nbytes);
term[0] = 0xfd;
term[1] = 0;
}
else
{
rig_debug(RIG_DEBUG_ERR, "%s: unknown cmd:", __func__);
dump_hex(cmd, nbytes);
cmd[0] = 0;
}
// This should work with Icom binary cmds any ASCII cmd with last char being standard terminator
// This means some of the 5-byte rigs won't be handled correctly -- to be fixed?
#if 1
if (cmd[0] != 0)
{
memset(reply, 0, sizeof(reply));
rig_flush(&my_rig->state.rigport);
retcode = rig_send_raw(my_rig, cmd, nbytes, reply, sizeof(reply),
term);
if (retcode < 0)
{
rig_debug(RIG_DEBUG_ERR, "%s: rig_send_raw error=%s\n", __func__,
rigerror(retcode));
}
else
{
rig_debug(RIG_DEBUG_VERBOSE, "%s: reply(%d bytes)='%s'\n", __func__, retcode,
reply);
fwrite(reply, 1, retcode, fsockout);
fflush(fsockout);
}
}
#endif
#if 0
if (strncmp(cmd, "FA", 2) == 0)
{
char *s = "FA00014074000;";
printf("%s\n", s);
fwrite(s, strlen(s), 1, fsockout);
fflush(fsockout);
}
else if (strncmp(cmd, "FB", 2) == 0)
{
char *s = "FB00014075000;";
printf("%s\n", s);
fwrite(s, strlen(s), 1, fsockout);
fflush(fsockout);
}
else if (strncmp(cmd, "AG0", 2) == 0)
{
char *s = "AG0000;";
printf("%s\n", s);
fwrite(s, strlen(s), 1, fsockout);
fflush(fsockout);
}
else if (strncmp(cmd, "IF", 2) == 0)
{
char *s = "IF000101310001000+0000000000020010000;";
printf("%s\n", s);
fwrite(s, strlen(s), 1, fsockout);
fflush(fsockout);
}
#endif
#endif
if (retcode != 0) { rig_debug(RIG_DEBUG_VERBOSE, "%s: rigctl_parse retcode=%d\n", __func__, retcode); }
// update our power stat in case power gets turned off
if (retcode == -RIG_ETIMEOUT
&& my_rig->caps->get_powerstat) // if we get a timeout we might be powered off
{
rig_get_powerstat(my_rig, &powerstat);
rig_powerstat = powerstat;
if (powerstat == RIG_POWER_OFF) { retcode = -RIG_EPOWER; }
}
}
else
{
retcode = -RIG_EIO;
}
// if we get a hard error we try to reopen the rig again
// this should cover short dropouts that can occur
if (retcode < 0 && !RIG_IS_SOFT_ERRCODE(-retcode))
{
int retry = 3;
rig_debug(RIG_DEBUG_ERR, "%s: i/o error\n", __func__);
do
{
mutex_rigctld(1);
retcode = rig_close(my_rig);
rig_opened = 0;
mutex_rigctld(0);
rig_debug(RIG_DEBUG_ERR, "%s: rig_close retcode=%d\n", __func__, retcode);
hl_usleep(1000 * 1000);
mutex_rigctld(1);
if (!rig_opened)
{
retcode = rig_open(my_rig);
rig_opened = retcode == RIG_OK ? 1 : 0;
rig_debug(RIG_DEBUG_ERR, "%s: rig_open retcode=%d, opened=%d\n", __func__,
retcode, rig_opened);
}
mutex_rigctld(0);
}
while (!ctrl_c && !rig_opened && retry-- > 0 && retcode != RIG_OK);
}
}
while (!ctrl_c && (retcode == RIG_OK || RIG_IS_SOFT_ERRCODE(-retcode)));
client_done:
if (rigctld_idle && client_count == 1)
{
rig_close(my_rig);
if (verbose > RIG_DEBUG_ERR) { printf("Closed rig model %s. Will reopen for new clients\n", my_rig->caps->model_name); }
}
#ifdef HAVE_PTHREAD
--client_count;
if (rigctld_idle && client_count > 0) { printf("%d client%s still connected so rig remains open\n", client_count, client_count > 1 ? "s" : ""); }
#if 0
mutex_rigctld(1);
/* Release rig if there are no clients */
if (!--client_count)
{
rig_close(my_rig);
if (verbose > RIG_DEBUG_ERR)
{
printf("Closed rig model %d, '%s - no clients, will reopen for new clients'\n",
my_rig->caps->rig_model,
my_rig->caps->model_name);
}
}
mutex_rigctld(0);
#endif
#else
rig_close(my_rig);
if (verbose > RIG_DEBUG_ERR)
{
printf("Closed rig model %d, '%s - will reopen for new clients'\n",
my_rig->caps->rig_model,
my_rig->caps->model_name);
}
#endif
if ((retcode = getnameinfo((struct sockaddr const *)&handle_data_arg->cli_addr,
handle_data_arg->clilen,
host,
sizeof(host),
serv,
sizeof(serv),
NI_NUMERICHOST | NI_NUMERICSERV))
< 0)
{
rig_debug(RIG_DEBUG_WARN, "Peer lookup error: %s", gai_strerror(retcode));
}
rig_debug(RIG_DEBUG_VERBOSE,
"Connection closed from %s:%s\n",
host,
serv);
handle_exit:
// for MINGW we close the handle before fclose
#ifdef __MINGW32__
retcode = closesocket(handle_data_arg->sock);
if (retcode != 0) { rig_debug(RIG_DEBUG_ERR, "%s: fclose(fsockin) %s\n", __func__, strerror(retcode)); }
#endif
if (fsockin) { fclose(fsockin); }
if (fsockout) { fclose(fsockout); }
// for everybody else we close the handle after fclose
#ifndef __MINGW32__
retcode = close(handle_data_arg->sock);
if (retcode != 0 && errno != EBADF) { rig_debug(RIG_DEBUG_ERR, "%s: close(handle_data_arg->sock) %s\n", __func__, strerror(errno)); }
#endif
free(arg);
#ifdef HAVE_PTHREAD
pthread_exit(NULL);
#endif
return NULL;
}
void usage(void)
{
printf("Usage: rigctltcp [OPTION]...\n"
"Daemon serving COMMANDs to a connected radio transceiver or receiver.\n\n");
printf(
" -m, --model=ID select radio model number. See model list\n"
" -r, --rig-file=DEVICE set device of the radio to operate on\n"
" -p, --ptt-file=DEVICE set device of the PTT device to operate on\n"
" -d, --dcd-file=DEVICE set device of the DCD device to operate on\n"
" -P, --ptt-type=TYPE set type of the PTT device to operate on\n"
" -D, --dcd-type=TYPE set type of the DCD device to operate on\n"
" -s, --serial-speed=BAUD set serial speed of the serial port\n"
" -c, --civaddr=ID set CI-V address, decimal (for Icom rigs only)\n"
" -t, --port=NUM set TCP listening port, default %s\n"
" -S, --separator=CHAR set char as rigctld response separator, default is \\n\n"
" -T, --listen-addr=IPADDR set listening IP address, default ANY\n"
" -C, --set-conf=PARM=VAL set config parameters\n"
" -L, --show-conf list all config parameters\n"
" -l, --list list all model numbers and exit\n"
" -u, --dump-caps dump capabilities and exit\n"
" -o, --vfo do not default to VFO_CURR, require extra vfo arg\n"
" -v, --verbose set verbose mode, cumulative (-v to -vvvvv)\n"
" -W, --twiddle_timeout timeout after detecting vfo manual change\n"
" -w, --twiddle_rit suppress VFOB getfreq so RIT can be twiddled\n"
" -x, --uplink set uplink get_freq ignore, 1=Sub, 2=Main\n"
" -Z, --debug-time-stamps enable time stamps for debug messages\n"
" -M, --multicast-addr=addr set multicast UDP address, default 0.0.0.0 (off), recommend 224.0.1.1\n"
" -n, --multicast-port=port set multicast UDP port, default 4531\n"
" -A, --password set password for rigctld access\n"
" -R, --rigctld-idle make rigctld close the rig when no clients are connected\n"
" -h, --help display this help and exit\n"
" -V, --version output version information and exit\n\n",
portno);
usage_rig(stdout);
printf("\nError codes and messages\n");
for (enum rig_errcode_e e = 0; e < RIG_EEND; ++e)
{
printf("-%d - %s", e, rigerror2(e));
}
printf("\nReport bugs to <hamlib-developer@lists.sourceforge.net>.\n");
}