chiark / gitweb /
config redo
[hippotat.git] / hippotat / __init__.py
index 064909100fbe409fe30ee67b772c902140060443..6b87da9f63919f64979e3bf8680bc361a99abdc3 100644 (file)
@@ -4,6 +4,9 @@ import signal
 signal.signal(signal.SIGINT, signal.SIG_DFL)
 
 import sys
+import os
+
+from zope.interface import implementer
 
 import twisted
 from twisted.internet import reactor
@@ -20,47 +23,87 @@ from optparse import OptionParser
 from configparser import ConfigParser
 from configparser import NoOptionError
 
+from functools import partial
+
 import collections
 import time
 import codecs
+import traceback
 
 import re as regexp
 
 import hippotat.slip as slip
 
 class DBG(twisted.python.constants.Names):
+  INIT = NamedConstant()
+  CONFIG = NamedConstant()
   ROUTE = NamedConstant()
   DROP = NamedConstant()
   FLOW = NamedConstant()
   HTTP = NamedConstant()
-  HTTP_CTRL = NamedConstant()
-  INIT = NamedConstant()
+  TWISTED = NamedConstant()
   QUEUE = NamedConstant()
+  HTTP_CTRL = NamedConstant()
   QUEUE_CTRL = NamedConstant()
+  HTTP_FULL = NamedConstant()
+  CTRL_DUMP = NamedConstant()
+  SLIP_FULL = NamedConstant()
+  DATA_COMPLETE = NamedConstant()
 
 _hex_codec = codecs.getencoder('hex_codec')
 
+#---------- logging ----------
+
+org_stderr = sys.stderr
+
 log = twisted.logger.Logger()
 
+debug_set = set()
+debug_def_detail = DBG.HTTP
+
 def log_debug(dflag, msg, idof=None, d=None):
+  if dflag not in debug_set: return
+  #print('---------------->',repr((dflag, msg, idof, d)), file=sys.stderr)
   if idof is not None:
-    msg = '[%d] %s' % (id(idof), msg)
+    msg = '[%#x] %s' % (id(idof), msg)
   if d is not None:
-    d = d[0:64]
+    trunc = ''
+    if not DBG.DATA_COMPLETE in debug_set:
+      if len(d) > 64:
+        d = d[0:64]
+        trunc = '...'
     d = _hex_codec(d)[0].decode('ascii')
-    msg += ' ' + d
+    msg += ' ' + d + trunc
   log.info('{dflag} {msgcore}', dflag=dflag, msgcore=msg)
 
+@implementer(twisted.logger.ILogFilterPredicate)
+class LogNotBoringTwisted:
+  def __call__(self, event):
+    yes = twisted.logger.PredicateResult.yes
+    no  = twisted.logger.PredicateResult.no
+    try:
+      if event.get('log_level') != LogLevel.info:
+        return yes
+      dflag = event.get('dflag')
+      if dflag                         in debug_set: return yes
+      if dflag is None and DBG.TWISTED in debug_set: return yes
+      return no
+    except Exception:
+      print(traceback.format_exc(), file=org_stderr)
+      return yes
+
+#---------- default config ----------
+
 defcfg = '''
 [DEFAULT]
 #[<client>] overrides
 max_batch_down = 65536           # used by server, subject to [limits]
 max_queue_time = 10              # used by server, subject to [limits]
-max_request_time = 54            # used by server, subject to [limits]
 target_requests_outstanding = 3  # must match; subject to [limits] on server
+http_timeout = 30                # used by both } must be
+http_timeout_grace = 5           # used by both }  compatible
 max_requests_outstanding = 4     # used by client
 max_batch_up = 4000              # used by client
-http_timeout = 30                # used by client
 http_retry = 5                   # used by client
 
 #[server] or [<client>] overrides
@@ -89,12 +132,12 @@ port = 80                  # used by server
 [limits]
 max_batch_down = 262144           # used by server
 max_queue_time = 121              # used by server
-max_request_time = 121            # used by server
+http_timeout = 121                # used by server
 target_requests_outstanding = 10  # used by server
 '''
 
 # these need to be defined here so that they can be imported by import *
-cfg = ConfigParser()
+cfg = ConfigParser(strict=False)
 optparser = OptionParser()
 
 _mimetrans = bytes.maketrans(b'-'+slip.esc, slip.esc+b'-')
@@ -153,31 +196,38 @@ def ipnetwork(input):
 #---------- ipif (SLIP) subprocess ----------
 
 class SlipStreamDecoder():
-  def __init__(self, on_packet):
-    # we will call packet(<packet>)
+  def __init__(self, desc, on_packet):
     self._buffer = b''
     self._on_packet = on_packet
+    self._desc = desc
+    self._log('__init__')
+
+  def _log(self, msg, **kwargs):
+    log_debug(DBG.SLIP_FULL, 'slip %s: %s' % (self._desc, msg), **kwargs)
 
   def inputdata(self, data):
-    #print('SLIP-GOT ', repr(data))
-    self._buffer += data
-    packets = slip.decode(self._buffer)
+    self._log('inputdata', d=data)
+    packets = slip.decode(data)
+    packets[0] = self._buffer + packets[0]
     self._buffer = packets.pop()
     for packet in packets:
       self._maybe_packet(packet)
+    self._log('bufremain', d=self._buffer)
 
   def _maybe_packet(self, packet):
-      if len(packet):
-        self._on_packet(packet)
+    self._log('maybepacket', d=packet)
+    if len(packet):
+      self._on_packet(packet)
 
   def flush(self):
+    self._log('flush')
     self._maybe_packet(self._buffer)
     self._buffer = b''
 
 class _IpifProcessProtocol(twisted.internet.protocol.ProcessProtocol):
   def __init__(self, router):
     self._router = router
-    self._decoder = SlipStreamDecoder(self.slip_on_packet)
+    self._decoder = SlipStreamDecoder('ipif', self.slip_on_packet)
   def connectionMade(self): pass
   def outReceived(self, data):
     self._decoder.inputdata(data)
@@ -199,6 +249,7 @@ def start_ipif(command, router):
                        env=None)
 
 def queue_inbound(packet):
+  log_debug(DBG.FLOW, "queue_inbound", d=packet)
   ipif.transport.write(slip.delimiter)
   ipif.transport.write(slip.encode(packet))
   ipif.transport.write(slip.delimiter)
@@ -208,6 +259,7 @@ def queue_inbound(packet):
 class PacketQueue():
   def __init__(self, desc, max_queue_time):
     self._desc = desc
+    assert(desc + '')
     self._max_queue_time = max_queue_time
     self._pq = collections.deque() # packets
 
@@ -271,7 +323,8 @@ _crashing = False
 def crash(err):
   global _crashing
   _crashing = True
-  print('CRASH ', err, file=sys.stderr)
+  print('========== CRASH ==========', err,
+        '===========================', file=sys.stderr)
   try: reactor.stop()
   except twisted.internet.error.ReactorNotRunning: pass
 
@@ -351,20 +404,132 @@ def process_cfg_clients(constructor):
 #---------- startup ----------
 
 def common_startup():
-  log_formatter = twisted.logger.formatEventAsClassicLogText
-  log_observer = twisted.logger.FileLogObserver(sys.stderr, log_formatter)
-  twisted.logger.globalLogBeginner.beginLoggingTo(
-    [ log_observer, crash_on_critical ]
-    )
+  re = regexp.compile('#.*')
+  cfg.read_string(re.sub('', defcfg))
+  need_defcfg = True
+
+  def readconfig(pathname, mandatory=True):
+    def log(m, p=pathname):
+      if not DBG.CONFIG in debug_set: return
+      print('DBG.CONFIG: %s: %s' % (m, pathname))
+
+    try:
+      files = os.listdir(pathname)
+
+    except FileNotFoundError:
+      if mandatory: raise
+      log('skipped')
+      return
+
+    except NotADirectoryError:
+      cfg.read(pathname)
+      log('read file')
+      return
+
+    # is a directory
+    log('directory')
+    re = regexp.compile('[^-A-Za-z0-9_]')
+    for f in os.listdir(cdir):
+      if re.search(f): continue
+      subpath = pathname + '/' + f
+      try:
+        os.stat(subpath)
+      except FileNotFoundError:
+        log('entry skipped', subpath)
+        continue
+      cfg.read(subpath)
+      log('entry read', subpath)
+      
+  def oc_config(od,os, value, op):
+    nonlocal need_defcfg
+    need_defcfg = False
+    readconfig(value)
+
+  def dfs_less_detailed(dl):
+    return [df for df in DBG.iterconstants() if df <= dl]
+
+  def ds_default(od,os,dl,op):
+    global debug_set
+    debug_set = set(dfs_less_detailed(debug_def_detail))
+
+  def ds_select(od,os, spec, op):
+    for it in spec.split(','):
+
+      if it.startswith('-'):
+        mutator = debug_set.discard
+        it = it[1:]
+      else:
+        mutator = debug_set.add
+
+      if it == '+':
+        dfs = DBG.iterconstants()
+
+      else:
+        if it.endswith('+'):
+          mapper = dfs_less_detailed
+          it = it[0:len(it)-1]
+        else:
+          mapper = lambda x: [x]
+
+          try:
+            dfspec = DBG.lookupByName(it)
+          except ValueError:
+            optparser.error('unknown debug flag %s in --debug-select' % it)
+
+        dfs = mapper(dfspec)
+
+      for df in dfs:
+        mutator(df)
+
+  optparser.add_option('-D', '--debug',
+                       nargs=0,
+                       action='callback',
+                       help='enable default debug (to stdout)',
+                       callback= ds_default)
+
+  optparser.add_option('--debug-select',
+                       nargs=1,
+                       type='string',
+                       metavar='[-]DFLAG[+]|[-]+,...',
+                       help=
+'''enable (`-': disable) each specified DFLAG;
+`+': do same for all "more interesting" DFLAGSs;
+just `+': all DFLAGs.
+  DFLAGS: ''' + ' '.join([df.name for df in DBG.iterconstants()]),
+                       action='callback',
+                       callback= ds_select)
+
+  optparser.add_option('-c', '--config',
+                       nargs=1,
+                       type='string',
+                       metavar='CONFIGFILE',
+                       dest='configfile',
+                       action='callback',
+                       callback= oc_config)
 
-  optparser.add_option('-c', '--config', dest='configfile',
-                       default='/etc/hippotat/config')
   (opts, args) = optparser.parse_args()
   if len(args): optparser.error('no non-option arguments please')
 
-  re = regexp.compile('#.*')
-  cfg.read_string(re.sub('', defcfg))
-  cfg.read(opts.configfile)
+  if need_defcfg:
+    readconfig('/etc/hippotat/config',   False)
+    readconfig('/etc/hippotat/config.d', False)
+
+  #print(repr(debug_set), file=sys.stderr)
+
+  log_formatter = twisted.logger.formatEventAsClassicLogText
+  stdout_obs = twisted.logger.FileLogObserver(sys.stdout, log_formatter)
+  stderr_obs = twisted.logger.FileLogObserver(sys.stderr, log_formatter)
+  pred = twisted.logger.LogLevelFilterPredicate(LogLevel.error)
+  stdsomething_obs = twisted.logger.FilteringLogObserver(
+    stderr_obs, [pred], stdout_obs
+  )
+  log_observer = twisted.logger.FilteringLogObserver(
+    stdsomething_obs, [LogNotBoringTwisted()]
+  )
+  #log_observer = stdsomething_obs
+  twisted.logger.globalLogBeginner.beginLoggingTo(
+    [ log_observer, crash_on_critical ]
+    )
 
 def common_run():
   log_debug(DBG.INIT, 'entering reactor')