SPP Command Interface

>>>>> WARNING: NOT READY FOR PUBLIC CONSUMPTION <<<<<

System Resource Manager (SRM)

The SRM is the top level controller for the SPP and provides several services. These include acquiring slice definitions from SPP-PLC, instantiating slice definitions, reserving and assigning resources to slices and coordinating the initialization of the whole system. The SRM implements functions provided by the Node Manager on a conventional PlanetLab node, but must provide this functionality in the context of a system with a more complex internal structure, and a richer set of resources.

The SRM polls SPP-PLC periodically to obtain new slice definitions. When a new slice is detected, the SRM selects one of the two GPEs on which to instantiate the slice. Slice instantiation involves creating a vServer on the selected slice, initializing it and configuring a login so that users can access their assigned vServer.

Once assigned to a vServer, a user can run programs that send and receive packets on the external interfaces. Outgoing connections are subjected to port number translation at the Line Cards, as described in Section 4. Users may also request the use of specific external port numbers in order to run servers that listen on specific ports. User requests are made through an interface provided by the RMP on the user’s assigned GPE. The RMP forwards these requests to the SRM which manages all system level resources, including external port numbers, physical interface bandwidth and NPE resources.

Resource Manager Proxy (RMP)

The RMP provides an API used by applications running in vServers. The API allows users to reserve resources in advance (such as external port bandwidth and NPE fastpaths), to acquire those resources when a reservation period starts and configure the resources as needed. The RMP is implemented as a daemon that runs in the root context and is accessed through a set of library routines. A command line interface is also provided so that users can reserve and configure resources interactively, or through a shell script. The command line interface converts the given commands to API calls.

The main API calls are listed below in topical sub-sections, along with a brief description of how each call is used. We use a representation that attempts to informally describe the interface semantics. More precise descriptions are given in the reference manual. We use an abstract interface syntax that has the form “R ← F(A1,…,An)” where F is the function name, Ai is the i-th argument, and R is the return value. Mnemonic names are used to convey usage while data type modifiers have been omitted. The following abbreviations and mnemonics are used in argument names and descriptions:

FP	FastPath
EP	EndPoint (a logical interface used by a slice and mapped to a physical interface)
LC	LineCard
BW	BandWidth
DB	DataBase
Xdescr	X description where X is Q, EP or FP for Queue, EndPoint, or FastPath (e.g., FPdescr)
Xid	X identifier where X is F, FP, MI, Q or S for Filter, FastPath, MetaInterface, Queue, or Slice (e.g., FPid)

Getting Interface Information

 client --cmd get_ifaces

Display all interfaces

 client --cmd get_ifpeer --ifn N

Display the peer of interface num N

 client --cmd get_ifattrs --ifn N

Display the attributes of interface num N

 client --cmd get_ifn --ipaddr A

Display the interface associated with IP address A

 client --cmd get_endpoint --fpid I --mii I'

Display the endpoint associated with (fastpath I, meta-interface I')

Endpoint Management

 client --cmd alloc_endpoint --bw K --ipaddr A --port N --proto P

Create the K Kbps capacity LC endpoint (A, N, P)

 client --cmd free_endpoint --ipaddr A --port N --proto P

Remove the K Kbps capacity LC endpoint (A, N, P)

Fastpath Management

 client --cmd alloc_udp_tunnel --fpid I --bw  K --ipaddr A --port N

Add (A, N) as a local end of a UDP tunnel with capacity K Kbps to fastpath I

 client --cmd free_udp_tunnel --fpid I --ipaddr A --port N

Free (A, N) as a local end of a UDP tunnel

 client --cmd alloc_fastpath --copt C --firm K --soft 0
               --fltrs N1 --qs N2 --stats N3 --buffs N4 --sram 4096 --dram 0

Allocate fastpath resources for code option C: K Kbps firm bandwidth, N1 filters, N2 queues, N3 stats indices, N4 buffers

 client --cmd free_fastpath --fpid I

Free the resources for fastpath I

Queue Management

 client --cmd get_queue_params --fpid I --qid I'

Get the threshold and bandwidth for (fastpath I, queue I')

 client --cmd get_queue_len --fpid I --qid I'

Get the length (bytes) of (fastpath I, queue I')

 client --cmd bind_queue --fpid I --miid I' --qid_list_type 0 --qid_list Q1 --qid_list Q2 ...

Bind queues Q1, Q2, ... to (fastpath I, meta-interface I')

 client --cmd bind_queue --fpid I --miid I' --qid_list_type 1 --qid_list Q1 --qid_list Q2

Bind queues in the range Q1 to Q2-1 inclusive to (fastpath I, meta-interface I')

 client --cmd set_queue_params --fpid I --qid I' --threshold B --bw K

Set the threshold and bandwidth of (fastpath I, queue I') to B bytes and K Kbps