fishdescriptor/fishdescriptor

   1 #!/usr/bin/python3
   2
   3 import sys
   4 import fishdescriptor.fish
   5 import optparse
   6 import re
   7 import subprocess
   8 import socket
   9 import os
  10
  11 donor = None
  12
  13 usage = '''fishdescriptor [-p|--pid] <pid> <action>... [-p|--pid <pid> <action>...]
  14
  15 <action>s
  16   [<here-0fd>=]<there-fd>
  17           fish the openfile referenced by descriptor <there-fd> in
  18           (the most recent) <pid> and keep a descriptor onto it;
  19           and, optionally, give it the number <here-fd> for exec
  20   exec <program> [<arg>...]
  21           execute a process with each specified <here>
  22           as an actual fd
  23   sockinfo
  24           calls getsockname/getpeername on the most recent
  25           <there-fd>
  26
  27   -p|-pid <pid>
  28           now attach to <pid>, detaching from previous pid
  29 '''
  30
  31 pending = []
  32 # list of (nominal, there) where nominal might be None
  33
  34 fdmap = { }
  35 # fdmap[nominal] = (actual, Donor, there)
  36
  37 def implement_pending():
  38     actuals = donor.fish([pend[1] for pend in pending])
  39     assert(len(actuals) == len(pending))
  40     for (nominal, there), actual in zip(pending, actuals):
  41         overwriting_info = fdmap.get(nominal)
  42         if overwriting_info is not None: os.close(overwriting_info[0])
  43         fdmap[nominal] = (actual, donor, there)
  44
  45 def implement_sockinfo(nominal):
  46     (actual, tdonor, there) = fdmap[nominal]
  47     # socket.fromfd requires the AF.  But of course we don't know the AF.
  48     # There isn't a sane way to get it in Python:
  49     #  https://utcc.utoronto.ca/~cks/space/blog/python/SocketFromFdMistake
  50     # Rejected options:
  51     #  https://github.com/tiran/socketfromfd
  52     #   adds a dependency, not portable due to reliance on SO_DOMAIN
  53     #  call getsockname using ctypes
  54     #   no sane way to discover how to unpack sa_family_t
  55     perl_script = '''
  56         use strict;
  57         use Socket;
  58         use POSIX;
  59         my $sa = getsockname STDIN;
  60         exit 0 if !defined $sa and $!==ENOTSOCK;
  61         my $family = sockaddr_family $sa;
  62         print $family, "\n" or die $!;
  63     '''
  64     famp = subprocess.Popen(
  65         stdin = actual,
  66         stdout = subprocess.PIPE,
  67         args = ['perl','-we',perl_script]
  68     )
  69     (output, dummy) = famp.communicate()
  70     family = int(output)
  71
  72     sock = socket.fromfd(actual, family, 0)
  73
  74     print("[%s] %d sockinfo" % (tdonor.pid, there), end='')
  75     for f in (lambda: socket.AddressFamily(family).name,
  76               lambda: repr(sock.getsockname()),
  77               lambda: repr(sock.getpeername())):
  78         try: info = f()
  79         except Exception as e: info = repr(e)
  80         print("\t", info, sep='', end='')
  81     print("")
  82
  83     sock.close()
  84
  85 def permute_fds_for_exec():
  86     actual2intended = { info[0]: nominal for nominal, info in fdmap.items() }
  87     # invariant at the start of each loop iteration:
  88     #     for each intended (aka `nominal') we have processed:
  89     #         relevant open-file is only held in fd intended
  90     #         (unless `nominal' is None in which case it is closed)
  91     #     for each intended (aka `nominal') we have NOT processed:
  92     #         relevant open-file is only held in actual
  93     #         where  actual = fdmap[nominal][0]
  94     #         and where  actual2intended[actual] = nominal
  95     # we can rely on processing each intended only once,
  96     #  since they're hash keys
  97     # the post-condition is not really a valid state (fdmap
  98     #  is nonsense) but we call this function just before exec
  99     for intended, (actual, tdonor, there) in fdmap.items():
 100         if intended == actual:
 101             continue
 102         if intended is not None:
 103             inway_intended = actual2intended.get(intended)
 104             if inway_intended is not None:
 105                 inway_moved = os.dup(intended)
 106                 actual2intended[inway_moved] = inway_intended
 107                 fdmap[inway_intented][0] = inway_moved
 108             os.dup2(actual, intended)
 109         os.close(actual)
 110
 111 def implement_exec(argl):
 112     if donor is not None: donor.detach()
 113     sys.stdout.flush()
 114     permute_fds_for_exec()
 115     os.execvp(argl[0], argl)
 116
 117 def set_donor(pid):
 118     global donor
 119     if donor is not None: donor.detach()
 120     donor = fishdescriptor.fish.Donor(pid, debug=ov.debug)
 121
 122 def ocb_set_donor(option, opt, value, parser):
 123     set_donor(value)
 124
 125 ov = optparse.Values()
 126
 127 def process_args():
 128     global ov
 129
 130     m = None
 131
 132     def arg_matches(regexp):
 133         nonlocal m
 134         m = re.search(regexp, arg)
 135         return m
 136
 137     op = optparse.OptionParser(usage=usage)
 138
 139     op.disable_interspersed_args()
 140     op.add_option('-p','--pid', type='int', action='callback',
 141                   callback=ocb_set_donor)
 142     op.add_option('-D','--debug', action='store_const',
 143                   dest='debug', const=sys.stderr)
 144     ov.debug = None
 145
 146     args = sys.argv[1:]
 147     last_nominal = None # None or (nominal,) ie None or (None,) or (int,)
 148
 149     while True:
 150         (ov, args) = op.parse_args(args=args, values=ov)
 151         if not len(args): break
 152
 153         arg = args.pop(0)
 154
 155         if donor is None:
 156             set_donor(int(arg))
 157         elif arg_matches(r'^(?:(\d+)=)?(\d+)?$'):
 158             (nominal, there) = m.groups()
 159             nominal = None if nominal is None else int(nominal)
 160             there = int(there)
 161             pending.append((nominal,there))
 162             last_nominal = (nominal,)
 163         elif arg == 'exec':
 164             if not len(args):
 165                 op.error("exec needs command to run")
 166             implement_pending()
 167             implement_exec(args)
 168         elif arg == 'sockinfo':
 169             if last_nominal is None:
 170                 op.error('sockinfo needs a prior fd spec')
 171             implement_pending()
 172             implement_sockinfo(last_nominal[0])
 173         else:
 174             op.error("unknown argument/option `%s'" % arg)
 175
 176 process_args()