Markus Zolliker
f7a6ba8b5b
motivation: a thread creating a lot of messages like a polling loop with very short polling frequency or a fast polling connection might monopolize the output of message over receiving new messages. In addition, the current design has a latency of 0.3 sec for the output of asynchronous replies. Anyway, the output queue is just extending the network output buffer, which is usally big enough. - change the name of 'queue_async_reply' to 'send_reply'. This method anyway was not only used for async replies. - send_reply is directly sending the reply instead of putting into the queue. It will slow down the calling thread, if the output buffer is full, which is desired behaviour. Change-Id: I305669be2f7c027355b43421432f32be9c166ed4 Reviewed-on: https://forge.frm2.tum.de/review/c/sine2020/secop/playground/+/23119 Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de> Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de> Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
193 lines
7.9 KiB
Python
193 lines
7.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# *****************************************************************************
|
|
# 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.,
|
|
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
#
|
|
# Module authors:
|
|
# Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
|
|
# Markus Zolliker <markus.zolliker@psi.ch>
|
|
#
|
|
# *****************************************************************************
|
|
"""provides tcp interface to the SECoP Server"""
|
|
|
|
import sys
|
|
import socket
|
|
import socketserver
|
|
import threading
|
|
|
|
from secop.datatypes import StringType, BoolType
|
|
from secop.errors import SECoPError
|
|
from secop.lib import formatException, \
|
|
formatExtendedStack, formatExtendedTraceback
|
|
from secop.properties import Property
|
|
from secop.protocol.interface import decode_msg, encode_msg_frame, get_msg
|
|
from secop.protocol.messages import ERRORPREFIX, \
|
|
HELPREPLY, HELPREQUEST, HelpMessage
|
|
|
|
|
|
DEF_PORT = 10767
|
|
MESSAGE_READ_SIZE = 1024
|
|
HELP = HELPREQUEST.encode()
|
|
|
|
|
|
class TCPRequestHandler(socketserver.BaseRequestHandler):
|
|
|
|
def setup(self):
|
|
self.log = self.server.log
|
|
self.running = True
|
|
self.send_lock = threading.Lock()
|
|
|
|
def handle(self):
|
|
"""handle a new tcp-connection"""
|
|
# copy state info
|
|
mysocket = self.request
|
|
clientaddr = self.client_address
|
|
serverobj = self.server
|
|
|
|
self.log.info("handling new connection from %s:%d" % clientaddr)
|
|
data = b''
|
|
|
|
# notify dispatcher of us
|
|
serverobj.dispatcher.add_connection(self)
|
|
|
|
# copy relevant settings from Interface
|
|
detailed_errors = serverobj.detailed_errors
|
|
|
|
mysocket.settimeout(1)
|
|
# start serving
|
|
while self.running:
|
|
try:
|
|
newdata = mysocket.recv(MESSAGE_READ_SIZE)
|
|
if not newdata:
|
|
# no timeout error, but no new data -> connection closed
|
|
return
|
|
data = data + newdata
|
|
except socket.timeout:
|
|
continue
|
|
except socket.error as e:
|
|
self.log.exception(e)
|
|
return
|
|
if not data:
|
|
continue
|
|
# put data into (de-) framer,
|
|
# put frames into (de-) coder and if a message appear,
|
|
# call dispatcher.handle_request(self, message)
|
|
# dispatcher will queue the reply before returning
|
|
while self.running:
|
|
origin, data = get_msg(data)
|
|
if origin is None:
|
|
break # no more messages to process
|
|
origin = origin.strip()
|
|
if origin in (HELP, b''): # empty string -> send help message
|
|
for idx, line in enumerate(HelpMessage.splitlines()):
|
|
# not sending HELPREPLY here, as there should be only one reply for every request
|
|
self.send_reply(('_', '%d' % (idx+1), line))
|
|
# ident matches request
|
|
self.send_reply((HELPREPLY, None, None))
|
|
continue
|
|
try:
|
|
msg = decode_msg(origin)
|
|
except Exception as err:
|
|
# we have to decode 'origin' here
|
|
# use latin-1, as utf-8 or ascii may lead to encoding errors
|
|
msg = origin.decode('latin-1').split(' ', 3) + [None] # make sure len(msg) > 1
|
|
result = (ERRORPREFIX + msg[0], msg[1], ['InternalError', str(err),
|
|
{'exception': formatException(),
|
|
'traceback': formatExtendedStack()}])
|
|
print('--------------------')
|
|
print(formatException())
|
|
print('--------------------')
|
|
print(formatExtendedTraceback(sys.exc_info()))
|
|
print('====================')
|
|
else:
|
|
try:
|
|
result = serverobj.dispatcher.handle_request(self, msg)
|
|
except SECoPError as err:
|
|
result = (ERRORPREFIX + msg[0], msg[1], [err.name, str(err),
|
|
{'exception': formatException(),
|
|
'traceback': formatExtendedStack()}])
|
|
except Exception as err:
|
|
# create Error Obj instead
|
|
result = (ERRORPREFIX + msg[0], msg[1], ['InternalError', repr(err),
|
|
{'exception': formatException(),
|
|
'traceback': formatExtendedStack()}])
|
|
print('--------------------')
|
|
print(formatException())
|
|
print('--------------------')
|
|
print(formatExtendedTraceback(sys.exc_info()))
|
|
print('====================')
|
|
|
|
if not result:
|
|
self.log.error('empty result upon msg %s' % repr(msg))
|
|
if result[0].startswith(ERRORPREFIX) and not detailed_errors:
|
|
# strip extra information
|
|
result[2][2].clear()
|
|
self.send_reply(result)
|
|
|
|
def send_reply(self, data):
|
|
"""send reply
|
|
|
|
stops recv loop on error (including timeout when output buffer full for more than 1 sec)
|
|
"""
|
|
if not data:
|
|
self.log.error('should not reply empty data!')
|
|
return
|
|
outdata = encode_msg_frame(*data)
|
|
with self.send_lock:
|
|
if self.running:
|
|
try:
|
|
self.request.sendall(outdata)
|
|
except Exception as e:
|
|
self.log.error('ERROR in send_reply %r', e)
|
|
self.running = False
|
|
|
|
def finish(self):
|
|
"""called when handle() terminates, i.e. the socket closed"""
|
|
self.log.info('closing connection from %s:%d' % self.client_address)
|
|
# notify dispatcher
|
|
self.server.dispatcher.remove_connection(self)
|
|
# close socket
|
|
try:
|
|
self.request.shutdown(socket.SHUT_RDWR)
|
|
except Exception:
|
|
pass
|
|
finally:
|
|
self.request.close()
|
|
|
|
|
|
class TCPServer(socketserver.ThreadingTCPServer):
|
|
daemon_threads = True
|
|
allow_reuse_address = True
|
|
|
|
# for cfg-editor
|
|
configurables = {
|
|
'uri': Property('hostname or ip address for binding', StringType(),
|
|
default='tcp://%d' % DEF_PORT, export=False),
|
|
'detailed_errors': Property('Flag to enable detailed Errorreporting.', BoolType(),
|
|
default=False, export=False),
|
|
}
|
|
|
|
def __init__(self, name, logger, options, srv):
|
|
self.dispatcher = srv.dispatcher
|
|
self.name = name
|
|
self.log = logger
|
|
port = int(options.pop('uri').split('://', 1)[-1])
|
|
self.detailed_errors = options.pop('detailed_errors', False)
|
|
|
|
self.allow_reuse_address = True
|
|
self.log.info("TCPServer %s binding to port %d" % (name, port))
|
|
socketserver.ThreadingTCPServer.__init__(
|
|
self, ('0.0.0.0', port), TCPRequestHandler, bind_and_activate=True)
|
|
self.log.info("TCPServer initiated")
|