Scout Module API

Summary File

Summary File

The file /proc/scout/ports/summary shows the current status of all ports managed by the Scout module. For example:


  [princeton8@planetlab-3] cat /proc/scout/ports/summary 
  prot    port    slice   types
  tcp     33301   758     l
  tcp     33301   759     c
  icmp    11234   900     C
  tcp     11234   900     CI
  udp     11234   900     CI
  tcp     12521   642     CSR
  tcp     22      0       C
  udp     123     0       C
  tcp     80      0       C
  tcp     79      0       C
  udp     32768   99      C

The prot and port columns together identify the port. The slice column shows the owner of the port, and the types column shows the references that have been placed on the port. Note that in the example above, TCP port 33301 has split ownership. Values for types are:

  • [C]onsumer: This means the slice has bound a socket (either a standard TCP/UDP socket or a safe raw socket) on this port to both the external and loopback IP address

  • [c]onsumer: This means the slice has bound a socket (either a standard TCP/UDP socket or a safe raw socket) on this port to only the external IP address

  • [l]oopback: This means the slice has bound a TCP/UDP socket on this port to only the loopback IP address.

  • [I]CMP errors: The slice has opened a safe raw socket to receive ICMP Destination Unreachable messages for the corresponding TCP/UDP port

  • [R]eserved: The port has been reserved for this slice for all IP addresses (currently there is no way to reserve only the external or loopback IP address for a slice)

  • [S]niffer: A sniffer socket is open on this port

The [C] reference implies [c] and [l], and so only one of [Ccl] will be present in the types column. The [I] and [S] references only apply to the external IP interface. In the above example, slice 758 has bound TCP port 33301 to the loopback IP address and 759 has bound the same port to the external address. Slice 759 will be able to open ICMP error and sniffer sockets on the port but slice 758 will not.