One document matched: draft-irtf-samrg-sam-baseline-protocol-04.xml


<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">

<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc strict="yes" ?>
<?rfc toc="yes"?>
<?rfc tocdepth="4"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes" ?>
<?rfc compact="yes" ?>
<?rfc subcompact="no" ?>
<rfc category="exp" docName="draft-irtf-samrg-sam-baseline-protocol-04"
     ipr="trust200902" consensus="yes" submissionType="IRTF">

  <!-- ***** FRONT MATTER ***** -->

  <front>
    <!-- The abbreviated title is used in the page header - it is only necessary if the 
         full title is longer than 39 characters -->

    <title abbrev="ALM Extensions to RELOAD">Application Layer Multicast
    Extensions to RELOAD</title>

    <!-- add 'role="editor"' below for the editors if appropriate -->

    <author fullname="John Buford" initials="J.F." surname="Buford">
      <organization>Avaya Labs Research</organization>

      <address>
        <postal>
          <street>211 Mt. Airy Rd</street>
          <city>Basking Ridge</city>
          <region>New Jersey</region>
          <code>07920</code>
          <country>USA</country>
        </postal>

        <phone>+1 908 848 5675</phone>

        <email>buford@avaya.com</email>

        <!-- uri and facsimile elements may also be added -->
      </address>
    </author>

    <author fullname="Mario Kolberg" initials="M." role="editor"
            surname="Kolberg">
      <organization>University of Stirling</organization>

      <address>
        <postal>
          <street>Dept. Computing Science and Mathematics</street>
          <city>Stirling</city>
          <region></region>
          <code>FK9 4LA</code>
          <country>UK</country>
        </postal>

        <phone>+44 1786 46 7440</phone>
        <email>mkolberg@ieee.org</email>
        <uri>http://www.cs.stir.ac.uk/~mko</uri>

        <!-- uri and facsimile elements may also be added -->
      </address>
    </author>


    <date day="6" month="June" year="2013" />

    <area>IRTF</area>
    <workgroup>SAM Research Group</workgroup>
    <keyword>application layer multicast</keyword>

    <abstract>
      <t>
      We define a RELOAD Usage for Application Layer Multicast as well as 
      a mapping to the RELOAD experimental message type to support ALM.
      The ALM Usage is intended to support a variety of ALM control algorithms
      in an overlay-independent way.
      Two example algorithms are defined, based on Scribe and P2PCast.
      </t>
    </abstract>

 </front>

  <middle>
    <section title="Introduction">
      <t>The concept of scalable adaptive multicast includes both scaling
      properties and adaptability properties. Scalability is intended to
      cover: <list style="symbols">
          <t>large group size</t>

          <t>large numbers of small groups</t>

          <t>rate of group membership change</t>

          <t>admission control for QoS</t>

          <t>use with network layer QoS mechanisms</t>

          <t>varying degrees of reliability</t>

          <t>trees connecting nodes over the global Internet</t>
        </list> 
        
        Adaptability includes <list style="symbols">
          <t>use of different control mechanisms for different multicast trees
          depending on initial application parameters or application classes</t>

          <t>changing multicast tree structure depending on changes in
          application requirements, network conditions, and membership</t>


        </list> </t>

        <t>Application Layer Multicast (ALM) has been demonstrated to be a viable
        multicast technology where native multicast isn't available.  
        Many ALM designs have been proposed.  This ALM Usage focuses on:

        <list style="symbols">
          <t>ALM implemented in RELOAD-based overlays </t>
          <t>Support for a variety of ALM control algorithms </t>
          <t>Providing a basis for defining a separate hybrid-ALM RELOAD Usage </t>
        </list>

        RELOAD <xref target="I-D.ietf-p2psip-base"></xref> has an 
        application extension mechanism in which a new type of application defines a Usage.
        A RELOAD Usage defines a set of data types and rules for their use.
        In addition, this document describes additional message types and a new ALM
        algorithm plugin architectural component.</t>

      <section title="Requirements Language">
        <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
        "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
        document are to be interpreted as described in <xref
        target="RFC2119">RFC 2119</xref>.</t>
      </section>

    </section>

    <section anchor="definitions" title="Definitions">

      <t>We adopt the terminology defined in section 2 of <xref target="I-D.ietf-p2psip-base"></xref>,
      specifically the distinction between Node, Peer, and Client.</t>

      <section title="Overlay Network">
        <t>Overlay network - An application layer virtual or logical network
        in which end points are addressable and that provides connectivity,
        routing, and messaging between end points. Overlay networks are
        frequently used as a substrate for deploying new network services, or
        for providing a routing topology not available from the underlying
        physical network. Many peer-to-peer systems are overlay networks that
        run on top of the Internet. In <xref target="overlay"/>, "P" indicates overlay
        peers, and peers are connected in a logical address space. The links
        shown in the figure represent predecessor/successor links. Depending
        on the overlay routing model, additional or different links may be
        present.</t>

        <figure align="center" anchor="overlay" title="Overlay Network Example">
          <artwork align="left"><![CDATA[
          P    P    P   P     P
        ..+....+....+...+.....+...
       .                          +P
     P+                            .
       .                          +P
        ..+....+....+...+.....+...
          P    P    P   P     P
            ]]></artwork>
        </figure>

      </section>

      <section title="Overlay Multicast">
        <t>Overlay Multicast (OM): Hosts participating in a multicast session
        form an overlay network and utilize unicast connections among pairs of
        hosts for data dissemination <xref target="BUFORD2009"/>, <xref target="KOLBERG2010"/>, <xref target="BUFORD2008"/>. The hosts in overlay multicast
        exclusively handle group management, routing, and tree construction,
        without any support from Internet routers. This is also commonly known
        as Application Layer Multicast (ALM) or End System Multicast (ESM). We
        call systems which use proxies connected in an overlay multicast
        backbone "proxied overlay multicast" or POM.</t>
      </section>

      <section title="Source Specific Multicast (SSM)">
      <t>SSM tree: The creator of the tree is the source. It sends
        data messages to the tree root which are forwarded down the
       tree.</t>
       </section>

      <section title="Any Source Multicast (ASM)">
      <t>ASM tree: A node sending a data message sends the message to
       its parent and its children. Each node receiving a data
       message from one edge forwards it to remaining tree edges it
       is connected to.</t>
       </section>

      <section title="Peer">
        <t>Peer: an autonomous end system that is connected to the physical
        network and participates in and contributes resources to overlay
        construction, routing and maintenance. Some peers may also perform
        additional roles such as connection relays, super nodes, NAT
        traversal assistance, and data storage.</t>
      </section>


    </section>

    <section anchor="Assumptions" title="Assumptions">
      <section title="Overlay">
        <t>Peers connect in a large-scale overlay, which may be used for a
        variety of peer-to-peer applications in addition to multicast
        sessions. Peers may assume additional roles in the overlay beyond
        participation in the overlay and in multicast trees. We assume a
        single structured overlay routing algorithm is used. Any of a variety
        of multi-hop, one-hop, or variable-hop overlay algorithms could be
        used.</t>

        <t>Castro et al. <xref target="CASTRO2003"/> compared multi-hop
        overlays and found that tree-based construction in a single overlay
        out-performed using separate overlays for each multicast session. We
        use a single overlay rather than separate overlays per multicast
        sessions. </t>

        <t>An overlay multicast algorithm may leverage the overlay's mechanism
        for maintaining overlay state in the face of churn. For example, a
        peer may store a number of DHT (Distributed Hash Table) entries. When
        the peer gracefully leaves the overlay, it transfers those entries to
        the nearest peer. When another peer joins which is closer to some of
        the entries than the current peer which holds those entries, than
        those entries are migrated. Overlay churn affects multicast trees as
        well; remedies include automatic migration of the tree state and
        automatic re-join operations for dislocated children nodes.</t>
      </section>

      <section title="Overlay Multicast">
        <t>The overlay supports concurrent multiple multicast trees. The limit
        on number of concurrent trees depends on peer and network resources
        and is not an intrinsic property of the overlay. </t>
      </section>

      <section title="RELOAD">
        <t>We use RELOAD <xref target="I-D.ietf-p2psip-base"></xref> as 
        the Peer-to-Peer overlay for data storage and the mechanism by which the
        peers interconnect and route messages. RELOAD is a generic P2P
        overlay, and application support is defined by profiles called Usages.
        </t>

      </section>

      <section title="NAT">
        <t>Some nodes in the overlay may be in a private address space and
        behind firewalls. We use the RELOAD mechanisms for NAT traversal. We
        permit clients to be leaf nodes in an ALM tree.</t>
      </section>

      <section title="Tree Topology">
        <t>All tree control messages are routed in the overlay.
        Two types of data or media topologies are envisioned:  1) tree edges are paths in the overlay,
        2) tree edges are direct connections between a parent and child peer in the tree,
        formed using the RELOAD AppAttach method.  
        </t>
      </section>
    </section>

    <section title="Architecture Extensions to RELOAD">
      <t>There are two changes as depicted in <xref target="ALMUsage"/>.
      New ALM messages are mapped to RELOAD Message Transport using the RELOAD experimental message type.
      A plug-in for ALM algorithms handles the ALM state and control.
      The ALM Algorithm is under control of the application
      via the Group API <xref target="I-D.irtf-samrg-common-api"></xref>.
      </t>
        <figure align="center" anchor="ALMUsage" title="RELOAD Architecture Extensions">
          <artwork align="left"><![CDATA[
                                                 +---------+
                                                 |Group API|
                                                 +---------+
                                                      |
    ------------------- Application  ------------------------
        +-------+                                     |
        | ALM   |                                     |
        | Usage |                                     |
        +-------+                                     |
     -------------- Messaging Service Boundary --------------
                                                      |
       +--------+      +-----------+---------+    +---------+
       | Storage|<---> | RELOAD    | ALM     |<-->| ALM Alg |
       +--------+      | Message   | Messages|    +---------+
               ^       | Transport |         |
               |       +-----------+---------+
               v          |    |
              +-------------+  |
              | Topology    |  |
              | Plugin      |  |
              +-------------+  |
                 ^             |
                 v             v
              +-------------------+
              | Forwarding &      |
              | Link Management   |
              +-------------------+
    
     ---------- Overlay Link Service Boundary --------------

            ]]></artwork>
        </figure>


      <t>The ALM components interact with RELOAD as follows: 
         <list style="symbols">
          <t>ALM uses the RELOAD data storage functionality to
          store an ALMTree instance when a new ALM tree is created in the overlay, and
          to retrieve ALMTree instance(s) for existing ALM trees.</t>

          <t>ALM applications and management tools may use the RELOAD data storage
          functionality to store diagnostic information about the operation of
          trees, including average number of tree, delay from source to leaf
          nodes, bandwidth use, packet loss rate. In addition, diagnostic
          information may include statistics specific to the tree root, or to
          any node in the tree.</t>
        </list> 
       </t>
    </section>

    <section title="RELOAD ALM Usage">
      <t>Applications of RELOAD are restricted in the data types that can be
      stored in the DHT. The profile of accepted data types for an application
      is referred to as a Usage. RELOAD is designed so that new applications
      can easily define new Usages. New RELOAD Usages are needed for 
      multicast applications since the data types in base RELOAD and existing
      usages are not sufficient.</t>

      <t>We define an ALM Usage in RELOAD. This ALM
      Usage is sufficient for applications which require ALM
      functionality in the overlay. <xref target="ALMUsage"/> shows the internal structure
      of the ALM Usage. This contains the Group API (<xref
      target="I-D.irtf-samrg-common-api"></xref>)
      an ALM algorithm plugin (e.g. Scribe) and the ALM messages which are then 
      sent out to the RELOAD network.</t>

      <t>A RELOAD Usage is required <xref
      target="I-D.ietf-p2psip-base"></xref> to define the following: 
      <list style="symbols">
          <t>Kind-Id and Code points</t>

          <t>data structures for each kind</t>

          <t>access control rules for each kind</t>

          <t>the Resource Name used to hash to the Resource ID that determines where
          the kind is stored</t>

          <t>Addresses restoration of values after recovery from a network
          partition</t>

          <t>the types of connections that can be initiated using AppConnect</t>
        </list>
        </t>

           <t>an ALM GroupID is a RELOAD Node-ID. The owner of an ALM group creates
        a RELOAD Node-ID as specified in <xref
        target="I-D.ietf-p2psip-base"></xref>. This means that a GroupID is
        used as a RELOAD Destination for overlay routing purposes.</t>
   
    </section>

    <section title="ALM Tree Control Signaling">
      <t>Peers use the overlay to support ALM operations such as: 
        <list style="symbols">
          <t>Create tree</t>
          <t>Join</t>
          <t>Leave</t>
          <t>Re-Form or optimize tree</t>
        </list>

      There are a variety of algorithms for peers to form multicast
      trees in the overlay. The approach presented here permits multiple 
      such algorithms to be supported
      in the overlay since different algorithms may be more suitable for
      certain application requirements, and to support
      experimentation. Therefore, overlay messaging corresponding to the set
      of overlay multicast operations MUST carry algorithm identification
      information.</t>

      <t>For example, for small groups, the join point might be directly
      assigned by the rendezvous point, while for large trees the join request
      might be propagated down the tree with candidate parents forwarding
      their position directly to the new node.</t>

      <t>Here is a simplistic notation for forming a multicast tree in the
        overlay. Its main advantage is the use of the overlay for routing 
        both control and data messages. The group creator does not
        have to be the root of the tree or even in the tree. It does not
        consider per node load, admission control, or alternative paths. 
        After the creation of a tree, the groupID is expected to be 
        advertised or distributed out of band, 
        perhaps by publishing in the DHT. Similarly, joining peers will discover 
        the groupID out of band, perhaps by a lookup in the tree.
</t>

        <t>As stated earlier, multiple algorithms will co-exist in the
        overlay. <list style="numbers">
            <t>Peer which initiates multicast group: <vspace blankLines="1" />

<figure align="left">
<artwork align="left"><![CDATA[
groupID = create();  // Allocate a unique groupId. 
                     // The root is the nearest
                     // peer in the overlay.
]]></artwork>
              </figure></t>

            <t>Any joining peer: <vspace blankLines="1" /> 
            
<figure align="left">
<artwork align="left"><![CDATA[
joinTree(groupID); // sends "join groupID" message
]]></artwork>
</figure> <vspace blankLines="1" /> 

	    The overlay routes the join
            request using the overlay routing mechanism toward the peer with
            the nearest id to the groupID. This peer is the root. Peers on the
            path to the root join the tree as forwarding points.</t>

            <t>Leave Tree: <vspace blankLines="1" /> leaveTree(groupID) //
            removes this node from the tree <vspace blankLines="1" />
            Propagates a leave message to each child node and to the parent
            node. If the parent node is a forwarding node and this is its last
            child, then it propagates a leave message to its parent. A child
            node receiving a leave message from a parent sends a join message
            to the groupID.</t>

            <t>Message forwarding: <vspace blankLines="1" />
            multicastMsg(groupID, msg);<vspace blankLines="1" />

            For the message forwarding both Any Source Multicast (ASM) and 
            Source Specific Multicast (SSM) approaches may be used.</t>
          </list></t>
      </section>


    <section anchor="sec-protocol" title="ALM Messages Mapped to RELOAD"> 
     <section title="Introduction">
        <t>In this document we define messages for overlay multicast
        tree creation, using an existing protocol (RELOAD) in the P2P-SIP WG
        <xref target="I-D.ietf-p2psip-base"></xref> for a universal structured
        peer-to-peer overlay protocol. RELOAD provides the mechanism to
        support a number of overlay topologies. Hence the overlay
        multicast framework defined in this document can be
        used with P2P-SIP, and makes the SAM framework overlay agnostic.</t>

        <t>As discussed in the SAM requirements 
        document <xref target="I-D.muramoto-irtf-sam-generic-require"></xref>, there are a variety of
        ALM tree formation and tree maintenance algorithms. The intent of this
        specification is to be algorithm agnostic, similar to how RELOAD is
        overlay algorithm agnostic. We assume that all control messages are
        propagated using overlay routed messages.</t>

        <t>The message types needed for ALM behavior are divided into the
        following categories: <list style="symbols">
            <t>Tree life-cycle (create, join, leave, re-form, heartbeat)</t>

            <t>Peer region and multicast properties</t>
          </list></t>

        <t>The message codes are defined in <xref target="MessageCodeIANA"></xref> of this document.  
        Messages are mapped to the RELOAD experimental message type.</t>
        <t>In the following sections the protocol messages as mapped to RELOAD are discussed. Detailed example message 
        flows are provided in <xref target="MessageFlows"></xref>.</t>
        <t>In the following descriptions we use the datatype Dictionary which is a set of
        opaque  values indexed by an opaque key with one value for each key.  A single dictionary entry is represented
        by a DictionaryEntry as defined in Section 7.2.3 of the RELOAD document <xref target="I-D.ietf-p2psip-base"></xref>. 
        The Dictionary datatype is defined as follows:</t>

        <figure>
            <artwork align="left"><![CDATA[
struct {
  DictionaryEntry elements<0..2^16-1>;
  } Dictionary;
]]></artwork>
          </figure>
  
      </section>

      <section title="Tree Lifecycle Messages">
        <t>Peers use the overlay to transmit ALM (application layer multicast)
        operations defined in this section.</t>

        <section anchor="CreateTree" title="Create Tree">
          <t>A new ALM tree is created in the overlay with the identity
          specified by group_id. The common interpretation in a DHT based overlay 
          of group_id is that the peer with peer id closest to and less than 
          the group_id is the root of the tree. However, other overlay types 
          are supported. The tree has no children at the time it is
          created.</t>

          <t>The group_id is generated from a well-known session key to be used
          by other peers to address the multicast tree in the overlay. The
          generation of the group_id from the session_key MUST be done using the
          overlay's id generation mechanism.</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id peer_id;
        opaque session_key<0..2^32-1>;
        node_id group_id;
        Dictionary options;
      } ALMTree;
]]></artwork>
          </figure>

          <t>peer_id: the overlay address of the peer that creates the
          multicast tree.</t>

          <t>session_key: a well-known string that when hashed using the overlay's
          id generation algorithm produces the group_id.</t>

          <t>group_id: the overlay address of the root of the tree</t>

          <t>options: name-value list of properties to be associated with the
          tree, such as the maximum size of the tree, restrictions on peers
          joining the tree, latency constraints, preference for distributed or
          centralized tree formation and maintenance, heartbeat interval.</t>

         <t>Tree creation is subject to access control since it involves a Store operation.
         The NODE-MATCH access policy defined in section 7.3.2 of RELOAD is used.
         </t>

         <t>A successful Create Tree causes an ALMTree structure to be stored in the overlay
         at the node G responsible for the group_id.  This node G performs the
         RELOAD-defined StoreReq operation as a side effect of performing the Create Tree. 
         If the StoreReq fails, the Create Tree fails too.
         </t>
  
         <t>After a successful Create Tree, peers can 
         use the RELOAD Fetch method to retrieve the ALMTree struct at address group_id.
         The ALMTree kind is defined in <xref target="ALMTreeKind"></xref>.
         </t>

       </section>

    <section title="CreateTreeResponse">
      <t>After receiving a CreateTree message from node S, the peer sends a CreateTreeReponse to node S.</t>

      <figure>
            <artwork align="left"><![CDATA[
        struct {  
          Dictionary options;
        } CreateTreeResponse;
]]></artwork>
          </figure>

      <t>options: A node may provide algorithm-dependent parameters about the created tree to the
       requesting node.</t>

     </section>


        <section title="Join">
          <t>Causes the distributed algorithm for peer join of a specific ALM
          group to be invoked. The definition of the Join message is shown below. 
          If successful, the joining peer is notified of one or
          more candidate parent peers in one or more JoinAccept messages. The
          particular ALM join algorithm is not specified in this protocol.</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id peer_id;
        node_id group_id;
        Dictionary options;
      } Join;
]]></artwork>
          </figure>

          <t>peer_id: overlay address of joining/leaving peer</t>

          <t>group_id: the overlay address of the root of the tree</t>

          <t>options: name-value list of options proposed by joining peer</t>
          
<t>RELOAD is a request-response protocol. Consequently, the messages JoinAccept
and JoinReject (defined below) are matching responses for Join. If
JoinReject is received, then no further action on this request is
carried out. If JoinAccept is received, then either a JoinConfirm or a JoinDecline 
message (see below) is sent.  The matching response for JoinConfirm
is JoinConfirmResponse.  The matching response for JoinDecline is
JoinDeclineResponse.</t>

<t>The following list shows the matching request-responses according to the request-response
mechanism defined in RELOAD.</t>

<t><list>
<t>Join -- JoinAccept:  Node C sends a Join request to node P.  If node P accepts, it responds with JoinAccept.</t>
<t>Join -- JoinReject:  Node C sends a Join request to node P.  If node P does not accept the join request, it responds with JoinReject.</t>
<t>JoinConfirm -- JoinConfirmResponse: If node P sent node C a JoinAccept and node C confirms with a JoinConfirm request then Node P then responds with a JoinConfirmResponse.   </t>
<t>JoinDecline -- JoinDeclineResponse: If node P sent node C a JoinAccept and node C declines with a JoinDecline request then Node P then responds with a JoinDeclineResponse. </t>
</list></t>

<t>Thus Join, JoinConfirm, and JoinDecline are treated as requests as defined in
RELOAD, are mapped to the RELOAD exp_a_req message, and are therefore retransmitted until 
either a retry limit is reached or a matching response received.
JoinAccept, JoinReject, JoinConfirmResponse, and JoinDeclineResponse are treated
as message responses as defined above, and are mapped to the RELOAD exp_a_ans message.
</t>

<t>The Join behaviour can be described as follows:</t>

          <figure>
<artwork align="left"><![CDATA[
if(checkAccept(msg)) {
    recvJoins.add(msg.source, msg.group_id)
    SEND(JOINAccept(node_id, msg.source, msg.group_id))
}
]]></artwork>
          </figure>

        </section>

        <section title="Join Accept (Join Response)">
          <t>Tells the requesting joining peer that the indicated peer is
          available to act as its parent in the ALM tree specified by group_id,
          with the corresponding options specified. A peer MAY receive more
          than one JoinAccept from different candidate parent peers in the
          group_id tree. The peer accepts a peer as parent using a JoinConfirm
          message. A JoinAccept which receives neither a JoinConfirm or
          JoinDecline message MUST expire. RELOAD implementations are able to 
          read a local configuration file for settings. It is assumed that 
          this file  contains the timeout value to be used.</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id parent_peer_id;
        node_id child_peer_id;
        node_id group_id;
        Dictionary options;
      } JoinAccept;
]]></artwork>
          </figure>

          <t>parent_peer_id: overlay address of a peer which accepts the joining
          peer</t>

          <t>child_peer_id: overlay address of joining peer</t>

          <t>group_id: the overlay address of the root of the tree</t>

          <t>options: name-value list of options accepted by parent peer</t>
          
        </section>

        <section title="Join Reject (Join Response)">
          <t>A peer receiving a Join message responds with a JoinReject response to indicate the request is rejected.</t>
        </section>

        <section title="Join Confirm">
          <t>A peer receiving a JoinAccept message which it wishes to accept
          MUST explicitly accept it before the expiration of a timer for the JoinAccept message 
          using a JoinConfirm message. The joining peer MUST include only
          those options from the JoinAccept which it also accepts, completing
          the negotiation of options between the two peers.</t>

<figure>
<artwork align="left"><![CDATA[
      struct {  
        node_id child_peer_id;
        node_id parent_peer_id;
        node_id group_id;
        Dictionary options;
      } JoinConfirm;
]]></artwork>
</figure>

          <t>child_peer_id: overlay address of joining peer which is a child of
          the parent peer</t>

          <t>parent_peer_id: overlay address of the peer which is the parent of
          the joining peer</t>

          <t>group_id: the overlay address of the root of the tree</t>

          <t>options: name-value list of options accepted by both peers</t>

<t>The JoinConfirm message behaviour is decribed below:</t>

          <figure>
<artwork align="left"><![CDATA[
if(recvJoins.contains(msg.source,msg.group_id)){
   if !(groups.contains(msg.group_id)) {
      groups.add(msg.group_id)
      SEND(msg,msg.group_id)
   }
   groups[msg.group_id].children.add(msg.source)
   recvJoins.del(msg.source, msg.group_id)
}
]]></artwork>
          </figure>
        </section>


        <section title="Join Confirm Response">
          <t>A peer receiving a JoinConfirm message responds with a JoinConfirmResponse message.</t>
        </section>

        <section title="Join Decline">
          <t>A peer receiving a JoinAccept message which it does not wish to
          accept it MAY explicitly decline it using a JoinDecline message.</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id peer_id;
        node_id parent_peer_id;
        node_id group_id;
      } JoinDecline;
]]></artwork>
          </figure>

          <t>peer_id: overlay address of joining peer which declines the
          JoinAccept</t>

          <t>parent_peer_id: overlay address of the peer which issued a
          JoinAccept to this peer</t>

          <t>group_id: the overlay address of the root of the tree</t>

<t>The behaviour of the JoinDecline message is described as follows:</t>

          <figure>
<artwork align="left"><![CDATA[
if(recvJoins.contains(msg.source,msg.group_id))
   recvJoins.del(msg.source, msg.group_id)
]]></artwork>
          </figure>
        </section>


        <section title="Join Decline Response">
          <t>A peer receiving a JoinConfirm message responds with a JoinDeclineResponse message.</t>
        </section>

        <section title="Leave">
          <t>A peer which is part of an ALM tree identified by group_id which
          intends to detach from either a child or parent peer SHOULD send a
          Leave message to the peer it wishes to detach from. A peer receiving
          a Leave message from a peer which is neither in its parent or child
          lists SHOULD ignore the message.</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id peer_id;
        node_id group_id;
        Dictionary options;
      } Leave;
]]></artwork>
          </figure>

          <t>peer_id: overlay address of leaving peer</t>

          <t>group_id: the overlay address of the root of the tree</t>

          <t>options: name-value list of options</t>

<t>The behaviour of the Leave message can be described as: </t>

          <figure>
<artwork align="left"><![CDATA[
groups[msg.group_id].children.remove(msg.source)
if (groups[msg.group].children = 0)
      SEND(msg,groups[msg.group_id].parent)
]]></artwork>
          </figure>
        </section>


        <section title="Leave Response">
          <t>A peer receiving a Leave message responds with a LeaveResponse message.</t>
        </section>

        <section title="Re-Form or Optimize Tree">
          <t>This triggers a reorganization of either the entire tree or only
          a sub-tree. It MAY include hints to specific peers of recommended
          parent or child peers to reconnect to. A peer receiving this message
          MAY ignore it, MAY propagate it to other peers in its subtree, and
          MAY invoke local algorithms for selecting preferred parent and/or
          child peers.</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id group_id;
        node_id peer_id;
        Dictionary options;
      } Reform;
]]></artwork>
          </figure>

          <t>group_id: the overlay address of the root of the tree</t>

          <t>peer_id: if omitted, then the tree is reorganized starting from
          the root, otherwise it is reorganized only at the sub-tree
          identified by peer_id.</t>

          <t>options: name-value list of options</t>
        </section>

        <section title="Reform Response">
          <t>A peer receiving a Reform message responds with a ReformResponse</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        Dictionary options;
      } ReformResponse;
]]></artwork>
          </figure>

         <t>options: algorithm dependent information about the results of the reform operation</t>
        </section>

        <section title="Heartbeat">
          <t>A child node signals to its adjacent parent nodes in the tree that it is
          alive. If a parent node does not receive a Heartbeat message within N
          heartbeat time intervals, it MUST treat this as an explicit Leave
          message from the unresponsive peer. N is configurable. RELOAD implementations 
          are able to read a local configuration file for settings. It is assumed that 
          this file  contains the value for N to be used.</t>

          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id peer_id_src;
        node_id peer_id_dst;
        node_id group_id;
        Dictionary   options;
      } Heartbeat;
]]></artwork>
          </figure>

          <t>peer_id_src: source of heartbeat</t>
          <t>peer_id_dst: destination of heartbeat</t>
          <t>group_id: overlay address of the root of the tree</t>
          <t>options: an algorithm may use the heartbeat message to provide state information to adjacent nodes in the tree</t>
       </section>

        <section title="Heartbeat Response">
          <t>A parent node responds with a Heartbeat Response to a Heartbeat from a child node indicating
          that it has received the Heartbeat message.
         </t>
       </section>

      <section title="NodeQuery">

       <t>The NodeQuery message is used to obtain information about the state and performance 
       of the tree on a per node basis.  A set of nodes could be queried to construct a centralized 
       view of the multicast trees, similar to a web crawler.</t>

      <figure>
       <artwork align="left"><![CDATA[
        struct {  
          node_id peer_id_src;
          node_id peer_id_dst;
        } NodeQuery;
]]></artwork>
      </figure>

          <t>peer_id_src: source of query</t>
          <t>peer_id_dst: destination of query</t>
       </section>

<section title="NodeQuery Response">
<t>The response to a NodeQuery message contains a NodeStatistics instance for this node.</t>

<figure>
<artwork align="left"><![CDATA[
public struct {
   uint32        node_lifetime;
   uint32        total_number_trees;
   uint16        number_algorithms_supported;
   uint8         algorithms_supported[32];
   TreeData      max_tree_data;
   uint16        active_number_trees;
   TreeData      tree_data<0..2^8-1>;
   ImplementationInfo  imp_info;
}  NodeStatistics;
]]></artwork>
          </figure>

<t><list>
<t>node_lifetime:  time the node has been alive in seconds since last restart</t>
<t>total_number_trees:   total number of trees this node has been part of during the node lifetime</t>
<t>number_algorithms_supported:  value between 0..2^16-1 corresponding to the number of algorithms supported</t>
<t>algorithms_supported:   list of algorithms, each byte encoded using the corresponding algorithm code</t>
<t>max_tree_data:  data about tree with largest number of nodes that this node was part of. 
NodeQuery can be used to crawl all the nodes in an ALM tree to fill this field. This is intended to 
support monitoring, algorithm design, and general experimentation with ALM in RELOAD.
</t>
<t>active_number_trees:  current number of trees that the node is part of</t>
<t>tree_data:  details of each active tree, the number of such is specified by the number_active_trees.</t>
<t>impl_info:  information about the implementation of this usage</t>
</list></t>

<figure>
<artwork align="left"><![CDATA[
public struct {
  uint32       tree_id;
  uint8        algorithm;
  NodeId       tree_root;
  uint8        number_parents;
  NodeId       parent<0..2^8-1>;
  Uint16       number_children_nodes;
  NodeId       children<0..2^16-1>;
  Uint32       path_length_to_root;
  Uint32       path_delay_to_root;
  Uint32       path_delay_to_child;
} TreeData;
]]></artwork>
          </figure>

<t><list>
<t>tree_id:  the id of the tree</t>
<t>algorithm:  code identifying the multicast algorithm used by this tree</t>
<t>tree_root:  node_id of tree root, or 0 if unknown</t>
<t>number_parents:   0 .. 2^8-1 indicates number of parent nodes for this node</t>
<t>parent:  the RELOAD NodeId of each parent node</t>
<t>number_children_nodes:    0..2^16-1 indicates number of children</t>
<t>children:  the RELOAD NodeId of each child node</t>
<t>path_length_to_root:  number of overlay hops to the root of the tree</t>
<t>path_delay_to_root:  RTT in millisec. to root node</t>
<t>path_delay_to_child:  last measured RTT in msec to child node with largest RTT.</t>
</list></t>


<figure>
<artwork align="left"><![CDATA[
public struct {
  uint32       join_confim_timeout;
  uint32       heartbeat_interval;
  uint32       heartbeat_reponse_timeout;
  uint16       info_length;
  uint8        info<0..2^16-1>;
} ImplementationInfo;
]]></artwork>
</figure>

<t><list>
<t>join_confirm_timeout: The default time for join confirm/decline, intended to provide sufficient
time for a join request to receive all responses and confirm the best choice.  Default value is 5000 msec.
An implementation can change this value.</t>
<t>heartbeat interval: The default heartbeat interval is 2000 msec. Different interoperating implementations could use different intervals.</t>
<t>heartbeat timeout interval: The default heartbeat timeout is 5000 msec, and is the max time between heartbeat reports from an adjacent node in the tree at which point the heartbeat is missed.</t>
<t>info_length: length of the info field</t>
<t>info: implementation specific information, such as name of implementation, build version, and implementation specific features</t>
</list></t>

 </section>   

<section title="Push">
          <t>A peer sends arbitrary multicast data to other peers in the tree.  Nodes in the tree forward this message to adjacent nodes in the tree in an algorithm dependent way.</t>

      <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id group_id;
        uint8  priority;
        uint32 length;
        uint8  data<0..2^32-1>;
      } Push;
]]></artwork>
          </figure>

          <t>group_id: overlay address of root of the ALM tree</t>
          <t>priority: the relative priority of the message, highest priority is 255. A node may ignore this field</t>
          <t>length: length of the data field in bytes</t>

          <t>data: the data</t>

<t>In pseudocode the behaviour of Push can be described as:</t>

          <figure>
<artwork align="left"><![CDATA[
foreach(groups[msg.group_id].children as node_id)
     SEND(msg,node_id)
if memberOf(msg.group_id)
     invokeMessageHandler(msg.group_id, msg)
]]></artwork>
          </figure>

        </section>


    <section title="PushResponse">
      <t>After receiving a Push message from node S, the receiving peer sends a PushReponse to node S.</t>

      <figure>
            <artwork align="left"><![CDATA[
      struct {  
        Dictionary options;
      } PushResponse;
]]></artwork>
          </figure>

      <t>options: A node may provide feedback to the sender about previous push messages in some window,
      for example, the last N push messages.  The feedback could include, for each push message received,
      the number of adjacent nodes which were forwarded the push message, and the number of adjacent nodes
      from which a PushResponse was received.</t>

     </section>
 
</section>   
    </section>

    <section anchor="Scribe" title="Scribe Algorithm">

    <section title="Overview">
      <t>
     <xref target="ScribeMapping"/> shows a mapping between RELOAD ALM  messages (as defined in 
     Section 5 of this document) and Scribe messages as defined in <xref target="CASTRO2002"></xref>. </t>

    
        <figure align="center" anchor="ScribeMapping" title="Mapping to Scribe Messages">
          <artwork align="left"><![CDATA[
   +---------+-------------------+-----------------+
   | Section |RELOAD ALM Message | Scribe Message  |
   +---------+-------------------+-----------------+
   | 7.2.1   | CreateALMTree     | Create          |
   +---------+-------------------+-----------------+
   | 7.2.2   | Join              | Join            |
   +---------+-------------------+-----------------+
   | 7.2.3   | JoinAccept        |                 |
   +---------+-------------------+-----------------+
   | 7.2.4   | JoinConfirm       |                 |
   +---------+-------------------+-----------------+
   | 7.2.5   | JoinDecline       |                 |
   +---------+-------------------+-----------------+
   | 7.2.6   | Leave             | Leave           |
   +---------+-------------------+-----------------+
   | 7.2.7   | Reform            |                 |
   +---------+-------------------+-----------------+
   | 7.2.8   | Heartbeat         |                 |
   +---------+-------------------+-----------------+
   | 7.2.9   | NodeQuery         |                 |
   +---------+-------------------+-----------------+
   | 7.2.10  | Push              | Multicast       |
   +---------+-------------------+-----------------+
   |         | Note 1            | deliver         |
   +---------+-------------------+-----------------+
   |         | Note 1            | forward         |
   +---------+-------------------+-----------------+
   |         | Note 1            | route           |
   +---------+-------------------+-----------------+
   |         | Note 1            | send            |
   +---------+-------------------+-----------------+
            ]]></artwork>
        </figure>
    
     <t>Note 1: These Scribe messages are handled by RELOAD messages.</t>

      <t>The following sections describe the Scribe algorithm in more detail.</t>
      
    </section>
      
        <section title="Create">

<t>
This message will create a group with group_id. This message MUST be delivered 
to the node whose node_id is closest to the group_id. This node becomes the 
rendezvous point and root for the new multicast tree. 
Groups MAY have multiple sources of multicast messages.
</t>
</section>

<section title="Join">
<t>
To join a multicast tree a node SHALL send a JOIN request with the group_id as the key. This message
gets routed by the overlay to the rendezvous point of the tree. If an intermediate node is already
a forwarder for this tree, it SHALL add the joining node as a child. Otherwise the node SHALL create
a child table for the group and add the joining node. It SHALL then send the JOIN request towards the 
rendevous point terminating the JOIN message from the child.
</t>
<t>
To adapt the Scribe algorithm into the ALM Usage proposed here, after a JOIN request is accepted, a JOINAccept
message MUST be returned to the joining node.
</t>

 </section>


        <section title="Leave">

<t>
When leaving a multicast group a node SHALL change its local state to indicate that it left the group.
If the node has no children in its table it MUST send a LEAVE request to its parent, from where it SHALL travel
up the multicast tree and stop at a node which has still children remaining after removing 
the leaving node.
</t>
        </section>


<section title="JoinConfirm">
<t>
This message is not part of the Scribe protocol, but required by the basic 
protocol proposed in this document. Thus the usage MUST send this message to confirm a
joining node accepting its parent node.
</t>
</section>

        <section title="JoinDecline">
<t>
Like JoinConfirm, this message is not part of the Scribe protocol. Thus the usage MUST send this 
message if a peer receiving a JoinAccept message wishes to decline it.
</t>
        </section>

        <section title="Multicast">
<t>
A message to be multicast to a group MUST be sent to the rendevous node from where it is 
forwarded down the tree. If a node is a member of the tree rather than just a forwarder
it SHALL pass the multicast data up to the application.
</t>
       </section>
   </section>


    <section anchor="P2PCast" title="P2PCast Algorithm">

    <section title="Overview">

<t>
P2PCast <xref target="P2PCAST"/> creates a forest of related trees to increase load balancing. 
P2PCast is independent of the underlying P2P substrate. Its goals and approach 
are similar to Splitstream <xref target="SPLITSTREAM"/> (which assumes Pastry as the P2P overlay).
In P2PCast the content provider splits the stream of data into f stripes. 
Each tree in the forest of multicast trees is an (almost) full tree of arity
f. These trees are conceptually separate: every node of the system appears 
once in each tree, with the content provider being the source in all
of them. To ensure that each peer contributes as much bandwidth as it 
receives, every node is a leaf in all the trees except for one, in which the
node will serve as an internal node (proper tree of this node). The remainder of this
section will assume f=2 for the discussion. This is to keep the complexity 
for the description down. However, the algorithm scales for any number f.
</t>

<t>P2PCast distinguishes the following types of nodes:</t>

<t><list style="symbols">
<t>Incomplete Nodes: A node with less than f children in its proper stripe;</t>
<t>Only-Child Nodes: A node whose parent (in any multicast tree) is an incomplete
node; </t>
<t>Complete Nodes: A node with exactly f children in its proper stripe </t>
<t>Special Node: A single node which is a leaf in all multicast trees of the forest </t>
</list>
</t>
</section>

    <section title="Message Mapping">
      <t>
     <xref target="P2PCastMapping"/> shows a mapping between RELOAD ALM  messages (as defined in 
     Section 5 of this document) and P2PCast messages as defined in <xref target="P2PCAST"></xref>. </t>

    
        <figure align="center" anchor="P2PCastMapping" title="Mapping to P2PCast Messages">
          <artwork align="left"><![CDATA[
    +---------+-------------------+-----------------+
    | Section |RELOAD ALM Message | P2PCast Message |
    +---------+-------------------+-----------------+
    | 7.2.1   | CreateALMTree     | Create          |
    +---------+-------------------+-----------------+
    | 7.2.2   | Join              | Join            |
    +---------+-------------------+-----------------+
    | 7.2.3   | JoinAccept        |                 |
    +---------+-------------------+-----------------+
    | 7.2.4   | JoinConfirm       |                 |
    +---------+-------------------+-----------------+
    | 7.2.5   | JoinDecline       |                 |
    +---------+-------------------+-----------------+
    | 7.2.6   | Leave             | Leave           |
    +---------+-------------------+-----------------+
    | 7.2.7   | Reform            | Takeon          |
    |         |                   | Substitute      |
    |         |                   | Search          |
    |         |                   | Replace         |
    |         |                   | Direct          |
    |         |                   | Update          |
    +---------+-------------------+-----------------+
    | 7.2.8   | Heartbeat         |                 |
    +---------+-------------------+-----------------+
    | 7.2.9   | NodeQuery         |                 |
    +---------+-------------------+-----------------+
    | 7.2.10  | Push              | Multicast       |
    +---------+-------------------+-----------------+
            ]]></artwork>
        </figure>
    
      <t>The following sections describe the mapping of the P2PCast messages in more detail.</t>
      
    </section>


<section title="Create">

<t>
This message will create a group with group_id. This message MUST be delivered 
to the node whose node_id is closest to the group_id. This node becomes the 
rendezvous point and root for the new multicast tree. The rendezvous point will maintain f subtrees.
</t>

</section>

<section title="Join">
<t>
To join a multicast tree a joining node N MUST send a JOIN request to a random node A already part of the tree.
Depending of the type of A the joining algorithm continues as follows:</t>

<t><list style="symbols">
<t>Incomplete Nodes: Node A will arbitrarily select for which tree it wants to serve as an internal node, 
and adopt N in that tree. In the other tree node N will adopt node A as a child (taking node A's place in the tree) 
thus becoming an internal node in the stripe that node A didn't choose.</t>

<t>Only-Child Nodes: As this node has a parent which is an incomplete node, the joining node will be 
redirected to the parent node and will handle the request as detailed above.</t>

<t>Complete Nodes: The contacted node A must be a leaf in the other tree. If node A is a leaf node in Stripe 1,
node N will become an internal node in Stripe 1, taking the place of node A, adopting it at the
same time. To find a place for itself in the other stripe, node N starts a random walk
down the subtree rooted at the sibling of node A (if node A is the root and thus does not have siblings, 
node N is sent directly to a leaf in that tree), which ends as soon as node N finds an incomplete
node or a leaf. In this case node N is adopted by the incomplete node. </t>

<t>Special Node: as this node is a leaf in all subtrees, the joining node MAY adopt the node 
in one tree and become a child in the other.</t>
</list>
</t>
<t>
P2PCast uses defined messages for communication between nodes during reorganisation. To use P2PCast in this context, 
these messages are encapsulated by the message type REFORM. In doing so, the P2PCast message is to be included in 
the options parameter of REFORM. The following reorganisation messages are defined by P2PCast:
</t>

<t><list>
<t>TAKEON: To take another peer as a child</t>
<t>SUBSTITUTE: To take the place of a child of some peer</t>
<t>SEARCH: To obtain the child of a node in a particular stripe</t>
<t>REPLACE: Different from SUBSTITUTE in that the node which makes us its child sheds off a random child</t>
<t>DIRECT: To direct a node to its would-be parent</t>
<t>UPDATE: A node sends its updated state to its children</t>
</list></t>

<t>To adapt the P2PCast algorithm into the ALM Usage proposed here, after a JOIN request is accepted, a JOINAccept
message MUST be returned to the joining node (one for every subtree).</t>

</section>

<section title="Leave">

<t>
When leaving a multicast group a node will change its local state to indicate that it left the group.
Disregarding the case where the leaving node is the root of the tree, the leaving node must be 
complete or incomplete in its proper tree. In the other trees the node is a leaf and can just 
disappear by notifying its parent.

For the proper tree, if the node is incomplete, it is replaced by its child. However, if the node is 
complete, a gap is created which is filled by a random child. If this child is incomplete, it can 
simply fill the gap. However, if it is complete, it needs to shed a random child. This child is directed to 
its sibling, which sheds a random child. This process ripples down the tree until the next-to-last level 
is reached. The shed node is then taken as a child by the parent of the deleted node in the other stripe.
</t>

<t>Again, for the reorganisation of the tree, the REFORM message type is used as defined in the previous section.</t>

</section>


<section title="JoinConfirm">

<t>
This message is not part of the P2PCast protocol, but required by the basic 
protocol defined in this document. Thus the usage MUST send this message to confirm a
joining node accepting its parent node. As with Join and JoinAccept, this MUST be 
carried out for every subtree.
</t>
        </section>

        <section title="Multicast">

<t>
A message to be multicast to a group MUST be sent to the rendezvous node from where it is 
forwarded down the tree by being split into k stripes. Each stripe is then sent via a subtree. 
If a receiving node is a member of the tree rather than just a forwarder
it SHALL pass the multicast data up to the application.
</t>

</section>
</section>

<section anchor="MessageCodes" title="Message Format">

<t>
All messages are mapped to the RELOAD experimental message type.
The mapping is given in the following table.  The message codes are given
in <xref target="MessageCodeIANA"/>.
The format of the body of a message is given in <xref target="MessageCodes2"/>.
</t>

        <figure align="center" anchor="MessageCodes2" title="RELOAD Message Code mapping">
          <artwork align="left"><![CDATA[
   +-------------------------+------------------+
   | Message                 |RELOAD Code Point |
   +-------------------------+------------------+
   | CreateALMTree           | exp_a_req        |
   +-------------------------+------------------+
   | CreateALMTreeResponse   | exp_a_ans        |
   +-------------------------+------------------+
   | Join                    | exp_a_req        |
   +-------------------------+------------------+
   | JoinAccept              | exp_a_ans        |
   +-------------------------+------------------+
   | JoinReject              | exp_a_ans        |
   +-------------------------+------------------+
   | JoinConfirm             | exp_a_req        |
   +-------------------------+------------------+
   | JoinConfirmResponse     | exp_a_ans        |
   +-------------------------+------------------+
   | JoinDecline             | exp_a_req        |
   +-------------------------+------------------+
   | JoinDeclineResponse     | exp_a_ans        |
   +-------------------------+------------------+
   | Leave                   | exp_a_req        |
   +-------------------------+------------------+
   | LeaveResponse           | exp_a_ans        |
   +-------------------------+------------------+
   | Reform                  | exp_a_req        |
   +-------------------------+------------------+
   | ReformResponse          | exp_a_ans        |
   +-------------------------+------------------+
   | Heartbeat               | exp_a_req        |
   +-------------------------+------------------+
   | HeartbeatResponse       | exp_a_ans        |
   +-------------------------+------------------+
   | NodeQuery               | exp_a_req        |
   +-------------------------+------------------+
   | NodeQueryResponse       | exp_a_ans        |
   +-------------------------+------------------+
   | Push                    | exp_a_req        |
   +-------------------------+------------------+
   | PushResponse            | exp_a_ans        |
   +-------------------------+------------------+
]]></artwork>
        </figure>

 <t>For Data Kind-IDs, the RELOAD specification states: "Code points in the range 0xf0000001 to 0xfffffffe are reserved 
 for private use".  ALM Usage Kind-IDs are defined in the private use range.</t>
     
    <t>All ALM Usage messages map to the RELOAD Message Extension mechanism.</t>

      <t>Code points for the kinds defined in this document MUST NOT conflict with any defined code points for RELOAD. 
      RELOAD defines exp_a_req, exp_a_ans for experimental purposes.  This specification uses only these message types 
      for all ALM messages. RELOAD defines the MessageContents data structure. The ALM mapping uses the fields as follows:</t>

<t><list style="symbols">
  <t>message_code:  exp_a_req  for requests and exp_a_ans for responses</t>
  <t>message_body:  contains one instance of ALMHeader followed by one instance of ALMMessageContents</t>
  <t>extensions: unused</t>
</list></t>

<section anchor="ALMHeaderDef" title="ALMHeader Definition">

<figure>
<artwork align="left"><![CDATA[
 struct {
    uint32           sam_token;
    uint16           alm_algorithm_id;
    uint8             version;
}  ALMHeader;
]]></artwork>
          </figure>

<t>The fields in ALMHeader are used as follows:</t>

<t><list>
<t>sam_token:   The first four bytes identify this message as an ALM message.
This field MUST contain the value 0xd3414d42 (the string "SAMB" with the high bit
of the first byte set.</t>

<t>alm_algorithm_id:  The ALM Algorith ID of the ALM algorithm being used.  Each multicast tree uses only one algorithm.
Trees with different ALM algorithms can co-exist, and can share the same nodes.  ALM Algorithm ID
codes are defined in <xref target="ALMAlgorithmTypesIANA"/></t>

<t>version:  The version of the ALM protocol being used.   This is a fixed point
integer between 0.1 and 25.4  This document describes version 1.0 with a value of 0xa.</t>
</list>
</t>
</section>

<section anchor="ALMMessageContents" title="ALMMessageContents Definition">

<figure>
<artwork align="left"><![CDATA[
struct {
   uint16       alm_message_code;
   opaque       alm_message_body;
} ALMMessageContents;
]]></artwork>
          </figure>

<t>The fields in ALMMessageContents are used as follows:</t>

<t><list>
<t>alm_message_code: This indicates the message being sent.  The message codes are listed in 
<xref target="MessageCodeIANA"></xref>.</t>

<t>alm_message_body: The message body itself, represented as a variable-length string of bytes. The
bytes themselves are dependent on the code value. See <xref target="Scribe"></xref> and 
<xref target="P2PCast"></xref> describing the various ALM methods for the definitions of the 
payload contents.</t>
</list></t>
</section>

<section anchor="ResponseCodes" title="Response Codes">

<t>Response codes are defined in section 6.3.3.1 in RELOAD. This specification maps to RELOAD 
ErrorResponse as follows:</t>

<t>ErrorResponse.error_code = Error_Exp_A;</t>

<t>Error_info contains an ALMErrorResponse instance.</t>

<figure>
<artwork align="left"><![CDATA[
public struct {
   uint16   alm_error_code;
   opaque   alm_error_info<0..2^16-1>;
} ALMErrorResponse;
]]></artwork>
          </figure>
 

<t>alm_error_code: The following error code values are defined.    
Numeric values for these are defined in section <xref target="ErrorCodeIANA"/>.</t>

<t><list>
<t>Error_Unknown_Algorithm:  The multicast algorithm is not known or not supported.</t>
<t>Error_Child_Limit_Reached:    The maximum number of children nodes has been reached for this node</t>
<t>Error_Node_Bandwidth_Reached:  The overall data bandwidth limit through this node has been reached</t>
<t>Error_Node_Conn_Limit_Reached:  The total number of connections to this node has been reached</t>
<t>Error_Link_Cap_Limit_Reached:  The capacity of a link has been reached</t>
<t>Error_Node_Mem_Limit_Reached:    An internal memory capacity of the node has been reached</t>
<t>Error_Node_CPU_Cap_Limit_Reached:  An internal processing capacity of the node has been reached</t>
<t>Error_Path_Limit_Reached:  The maximum path length in hopcount over the multicast tree has been reached</t>
<t>Error_Path_Delay_Limit_Reached:  The maximum path length in message delay over the multicast tree has been reached</t>
<t>Error_Tree_Fanout_Limit_Reached:  The maximum fanout of a multicast tree has been reached</t>
<t>Error_Tree_Depth_Limit_Reached:  The maximum height of a multicast tree has been reached</t>
<t>Error_Other:   A human-readable description is placed in the alm_error_info field.</t>
</list></t>
</section>

 </section>


    <section title="Examples" anchor="MessageFlows">
      <t>All peers in the examples are assumed to have completed bootstrapping.  "Pn" refers to peer N.  
        "GroupID" refers to a peer responsible for storing the ALMTree instance with GroupID.
      </t>
      <section title="Create Tree">

      <t>A node with "NODE-MATCH" rights sends a request CreateTree to the group-id node,
      which also has NODE-MATCH rights for its own address.
      The group-id node determines whether to create the new tree, and if so, performs a
      local StoreReq.  If the CreateTree succeeds, the ALMTree instance can be retrieved using Fetch. An example
      message flow for ceating a tree is depicted in <xref target="CreateTreeExample"/>.</t>

        <figure align="center" anchor="CreateTreeExample" title="Message flow example for CreateTree.">
          <artwork align="left"><![CDATA[
     P1      P2      P3       P4      GroupID
     |       |       |        |       |
     |       |       |        |       |
     |       |       |        |       |
     | CreateTree    |        |       |
     |------------------------------->|
     |       |       |        |       |
     |       |       |        |       | StoreReq
     |       |       |        |       |--+
     |       |       |        |       |  |
     |       |       |        |       |  |
     |       |       |        |       |<-+
     |       |       |        |       | StoreResponse
     |       |       |        |       |--+
     |       |       |        |       |  |
     |       |       |        |       |  |
     |       |       |        |       |<-+
     |       |       |        |       |
     |       |       |        |       |
     |       |    CreateTreeResponse  |
     |<-------------------------------|
     |       |       |        |       |
     |       |       |        |       |
     | Fetch         |        |       |
     |------------------------------->|
     |       |       |        |       |
     |       |       |        |       |
     |       |         FetchResponse  |
     |<-------------------------------|
     |       |       |        |       |
]]></artwork>
        </figure>
      </section>


      <section title="Join Tree">
     <t>P1 joins node GroupID as child node. P2 joins the tree as a child of P1.
     P4 joins the tree as a child of P1. The corresponding message flow is shown in <xref target="JoinTreeExample"/>.</t>

        <figure align="center" anchor="JoinTreeExample" title="Message flow example for tree Join.">
          <artwork align="left"><![CDATA[
     P1      P2      P3       P4      GroupID
     |       |       |        |       |
     |       |       |        |       |
     | Join                           |
     |------------------------------->|
     |       |       |        |       |
     | JoinAccept                     |
     |<-------------------------------|
     |       |       |        |       |
     |       |       |        |       |
     |       |Join                    |
     |       |----------------------->|
     |       |       |        |       |
     |                            Join|
     |<-------------------------------|
     |       |       |        |       |
     |JoinAccept     |        |       |
     |------>|       |        |       |
     |       |       |        |       |
     |JoinConfirm    |        |       |
     |<------|       |        |       |
     |       |       |        |       |
     |       |       |        |Join   |
     |       |       |        |------>|
     |       |       |        |  Join |
     |<-------------------------------|
     |       |       |        |       |
     | Join  |       |        |       |
     |------>|       |        |       |
     |       |       |        |       |
     | JoinAccept    |        |       |
     |----------------------->|       |
     |       |       |        |       |
     |       | JoinAccept     |       |
     |       |--------------->|       |
     |       |       |        |       |
     |       |       |        |       |
     |       |   Join Confirm |       |
     |<-----------------------|       |
     |       |       |        |       |
     |       |   Join Decline |       |
     |       |<---------------|       |
     |       |       |        |       |
     |       |       |        |       |
]]></artwork>
        </figure>
      </section>

      <section title="Leave Tree">
      
      
        <figure align="center" anchor="LeaveTreeExample" title="Message flow example for Leave tree.">
          <artwork align="left"><![CDATA[
     P1      P2      P3       P4      GroupID
     |       |       |        |       |
     |       |       |        |       |
     |       |       |  Leave |       |
     |<-----------------------|       |
     |       |       |        |       |
     | LeaveResponse |        |       |
     |----------------------->|       |
     |       |       |        |       |
     |       |       |        |       |
]]></artwork>
        </figure>
      </section>

       <section title="Push Data">

      <t>The multicast data is pushed recursively P1 => GroupID => P1 => P2, P4
         following the tree topology created in the Join example above. An example 
         message flow is shown in <xref target="PushDataExample"/>.</t>

        <figure align="center" anchor="PushDataExample" title="Message flow example for pushing data.">
          <artwork align="left"><![CDATA[
     P1      P2      P3       P4      GroupID
     |       |       |        |       |
     | Push  |       |        |       |
     |------------------------------->|
     |       |       |        |       |
     |       |       |    PushResponse|
     |<-------------------------------|
     |       |       |        |       |
     |       |       |        |   Push|
     |<-------------------------------|
     |       |       |        |       |
     | PushResponse  |        |       |
     |------------------------------->|
     |       |       |        |       |
     |Push   |       |        |       |
     |------>|       |        |       |
     |       |       |        |       |
     |PushResponse   |        |       |
     |<------|       |        |       |
     |       |       |        |       |
     | Push  |       |        |       |
     |----------------------->|       |
     |       |       |        |       |
     |       |   PushResponse |       |
     |<-----------------------|       |
     |       |       |        |       |
     |       |       |        |       |
     |       |       |        |       |
            ]]></artwork>
        </figure>
      </section>

    </section>

    <section title="Kind Definitions">
       <section anchor="ALMTreeKind" title="ALMTree Kind Definition">
        <t>This section defines the ALMTree kind per section 7.4.5 in RELOAD.  An instance of the ALMTree kind is stored in the overlay for each ALM tree instance. It is stored at the address group_id.</t>
        <t>Kind-Id: 0xf0000001  (This is a private-use code-point per section 14.6 of RELOAD.)  The Resource Name for the ALMTree Kind-ID is the session_key used to identify the ALM tree.</t>
        <t>Data Model The data model is the ALMTree structure. </t>
        <t>Access Control  NODE-MATCH.  The node performing the store operation is required to have NODE-MATCH access. </t>
        <t>Meaning: The meaning of the fields is given in <xref target="CreateTree"></xref>.</t>
          <figure>
            <artwork align="left"><![CDATA[
      struct {  
        node_id peer_id;
        opaque session_key<0..2^32-1>;
        node_id group_id;
        Dictionary options;
      } ALMTree;
]]></artwork>
          </figure>
      </section>
    </section>

    <section title="RELOAD Configuration File Extensions">
      <t>There are no ALM parameters defined for the RELOAD configuration file.</t>
    </section>

    <section title="Change History">
        <t><list style="symbols">
            <t>Version 02: Remove Hybrid ALM material.  Define ALMTree kind.  Define new RELOAD messages.  Define RELOAD architecture extensions. Add Scribe as base algorithm for ALM usage. Define code points. Define preliminary ALM-specific security issues.</t>
           <t>Version 03: Add P2Pcast Algorithm.</t>
           <t>Version 04: Add mapping to RELOAD experimental message.  Modified IANA considerations section.
            Changed category of id from Informational to Experimental. 
            New algorithm identification coding.  New message coding. Added push message. 
            Create Tree access policy changed to use NODE-MATCH. Create Tree StoreReq clarified. Updated 
            the diagrams in the Examples section. Added a Push data example. Defined the ALMTree kind.</t>
          </list></t>
    </section>


    <section anchor="IANA" title="IANA Considerations">
      <t>This section contains the new code points registered by this document.  [NOTE TO IANA/RFC-EDITOR: Please
         replace RFC-to-be with the RFC number for this specification in the following list. ]
      </t> 
      <section anchor="ALMAlgorithmTypesIANA" title="ALM Algorithm Types">
       <t>IANA SHALL create a "SAM ALM Algorithm ID" Registry.
          Entries in this registry are 16-bit integers denoting Application Layer Multicast algorithms
          as described in section <xref target="ALMHeaderDef" /> of [RFC-to-be]. 
          Code points in the range 0x3 to 0x7fff SHALL be registered vi RFC 5226 Expert Review.
          Code points in the range 0x7fff to 0xfffe are reserved for private use.
          The initial contents of this registry are:
       </t>
        <figure align="center" anchor="ALMAlgorithmTypes2">
          <artwork align="left"><![CDATA[
   +----------------+-------------------+-----------+
   | Algorithm Name | ALM Algorith ID   | RFC       |
   +----------------+-------------------+-----------+
   | INVALID-ALG    |                 0 | RFC-to-be |
   | SCRIBE-SAM     |                 1 | RFC-to-be |
   | P2PCAST-SAM    |                 2 | RFC-to-be |
   | Reserved       |       0x3..0xffff | RFC-to-be |
   +----------------+-------------------+-----------+
]]></artwork>
        </figure>

       <t>These values have been made available for the purposes of experimentation.
       These values are not meant for vendor specific use of any sort and MUST NOT be used for operational deployments.
       </t>
      </section>

      <section anchor="MessageCodeIANA" title="Message Code Registration">
       <t>IANA SHALL create a "SAM ALM Message Code" Registry.
        Entries in this registry are 16-bit integers denoting message codes as 
        described in section <xref target="ALMMessageContents"/> of [RFC-to-be].
        Code points in the range 0x14 to 0x7fff SHALL be registered vi RFC 5226 Expert Review.
        Code points in the range 0x7fff to 0xfffe are reserved for private use.
        The initial contents of this registry are:
       </t>
        <figure align="center" anchor="MessageCodes3" >
          <artwork align="left"><![CDATA[
   +-------------------------+----------------------+-----------+
   | Message Code Name       | Message Code Value   | RFC       |
   +-------------------------+----------------------+-----------+
   | InvalidMessageCode      |                    0 | RFC-to-be |
   | CreateALMTRee           |                    1 | RFC-to-be |
   | CreateALMTreeResponse   |                    2 | RFC-to-be |
   | Join                    |                    3 | RFC-to-be |
   | JoinAccept              |                    4 | RFC-to-be |
   | JoinReject              |                    5 | RFC-to-be |
   | JoinConfirm             |                    6 | RFC-to-be |
   | JoinConfirmResponse     |                    7 | RFC-to-be |
   | JoinDecline             |                    8 | RFC-to-be |
   | JoinDeclineResponse     |                    9 | RFC-to-be |
   | Leave                   |                   10 | RFC-to-be |
   | LeaveResponse           |                   11 | RFC-to-be |
   | Reform                  |                   12 | RFC-to-be |
   | ReformResponse          |                   13 | RFC-to-be |
   | Heartbeat               |                   14 | RFC-to-be |
   | HeartbeatResponse       |                   15 | RFC-to-be |
   | NodeQuery               |                   16 | RFC-to-be |
   | NodeQueryResponse       |                   17 | RFC-to-be |
   | Push                    |                   18 | RFC-to-be |
   | PushResponse            |                   19 | RFC-to-be |
   | Reserved                |         0x14..0xffff | RFC-to-be |
   +-------------------------+----------------------+-----------+
]]></artwork>
        </figure>
       <t>These values have been made available for the purposes of experimentation.
       These values are not meant for vendor specific use of any sort and MUST NOT be used for operational deployments.
       </t>

      </section>

      <section anchor="ErrorCodeIANA" title="Error Code Registration">
       <t>IANA SHALL create a "SAM ALM Error Code" Registry.
        Entries in this registry are 16-bit integers denoting error codes as 
        described in section <xref target="ResponseCodes"/> of [RFC-to-be].
        Code points in the range 0x14 to 0x7fff SHALL be registered vi RFC 5226 Expert Review.
        Code points in the range 0x7fff to 0xfffe are reserved for private use.
        The initial contents of this registry are:
       </t>
        <figure align="center" anchor="ErrMessageCodes2" >
          <artwork align="left"><![CDATA[
   +----------------------------------+--------------+-----------+
   | Error Code Name                  | Code Value   | RFC       |
   +----------------------------------+--------------+-----------+
   | InvalidErrorCode                 |            0 | RFC-to-be |
   | Error_Unknown_Algorithm          |            1 | RFC-to-be |
   | Error_Child_Limit_Reached        |            2 | RFC-to-be |
   | Error_Node_Bandwidth_Reached     |            3 | RFC-to-be |
   | Error_Node_Conn_Limit_Reached    |            4 | RFC-to-be |
   | Error_Link_Cap_Limit_Reached     |            5 | RFC-to-be |
   | Error_Node_Mem_Limit_Reached     |            6 | RFC-to-be |
   | Error_Node_CPU_Cap_Limit_Reached |            7 | RFC-to-be |
   | Error_Path_Limit_Reached         |            8 | RFC-to-be |
   | Error_Path_Delay_Limit_Reached   |            9 | RFC-to-be |
   | Error_Tree_Fanout_Limit_Reached  |           10 | RFC-to-be |
   | Error_Tree_Depth_Limit_Reached   |           11 | RFC-to-be |
   | Error_Other                      |           12 | RFC-to-be |
   | Reserved                         | 0x14..0xffff | RFC-to-be |
   +----------------------------------+--------------+-----------+
]]></artwork>
        </figure>
       <t>These values have been made available for the purposes of experimentation.
       These values are not meant for vendor specific use of any sort and MUST NOT be used for operational deployments.
       </t>

      </section>


    </section>

    <section anchor="Security" title="Security Considerations">
      <t>Overlays are vulnerable to DOS and collusion attacks. We are not
      solving overlay security issues. We assume the node authentication model as defined in <xref
      target="I-D.ietf-p2psip-base"></xref>.</t>
      <t>ALM Usage specific security issues: <list style="symbols">
          <t>Right to create GroupID at some node_id </t>
          <t>Right to store Tree info at some Location in the DHT </t>
          <t>Limit on # messages / sec and bandwidth use </t>
          <t>Right to join an ALM tree </t>
         </list></t>
    </section>
    <section title="Acknowledgement">
        <t>Marc Petit-Huguenin, Michael Welzl, Joerg Ott, and Lars Eggert provided important comments on earlier versions of this document.</t>
   </section>
  </middle>

  <back>
    <references title="Informative References">
      <!-- Here we use entities that we defined at the beginning. -->

      <?rfc include="reference.RFC.2119"?>
      <?rfc include="reference.RFC.0792"?>
      <?rfc include="reference.RFC.3376"?>
      <?rfc include="reference.RFC.3810"?>
      <?rfc include="reference.RFC.4605"?>
      <?rfc include="reference.RFC.4607"?>
      <?rfc include="reference.RFC.5058"?>

      <?rfc include="reference.RFC.1930"?>
      <?rfc include="reference.RFC.3552"?>
      <?rfc include="reference.RFC.4286"?>
      <?rfc include="reference.RFC.1112"?>

      <?rfc include="reference.I-D.ietf-mboned-auto-multicast"?>
      <?rfc include="reference.I-D.ietf-p2psip-base"?>
      <?rfc include="reference.I-D.ietf-p2psip-sip"?>
      <?rfc include="reference.I-D.matuszewski-p2psip-security-overview"?>
      <?rfc include="reference.I-D.irtf-p2prg-rtc-security"?>
      <?rfc include="reference.I-D.irtf-samrg-common-api"?>
      <?rfc include="reference.I-D.irtf-sam-hybrid-overlay-framework"?>
      <?rfc include="reference.I-D.muramoto-irtf-sam-generic-require"?>


      <reference anchor="AGU1984" target="http://dl.acm.org/citation.cfm?id=802060">
        <front>
          <title>Datagram Routing for Internet Multicasting</title>
          <author initials="L." surname="Aguilar"></author>
          <date month="March" year="1984" />
        </front>

        <seriesInfo name="ACM Sigcomm 84" value="1984" />
      </reference>

      <reference anchor="CASTRO2002"
                 target="http://research.microsoft.com/en-us/um/people/antr/past/jsac.pdf">
        <front>
          <title>Scribe: A large-scale and decentralized application-level multicast infrastructure</title>
          <author initials="M." surname="Castro"></author>
          <author initials="P." surname="Druschel"></author>
          <author initials="A.-M." surname="Kermarrec"></author>
          <author initials="A." surname="Rowstron"></author>
          <date month="October" year="2002" />
        </front>

        <seriesInfo name="IEEE Journal on Selected Areas in Communications"
                    value="vol.20, No.8" />
      </reference>

      <reference anchor="CASTRO2003"
                 target="http://research.microsoft.com/en-us/um/people/mcastro/publications/infocom-compare.pdf">
        <front>
          <title>An Evaluation of Scalable Application-level Multicast Built Using Peer-to-peer overlays</title>
          <author initials="M." surname="Castro"></author>
          <author initials="M." surname="Jones"></author>
          <author initials="A.-M." surname="Kermarrec"></author>
          <author initials="A." surname="Rowstron"></author>
          <author initials="M." surname="Theimer"></author>
          <author initials="H." surname="Wang"></author>
          <author initials="A." surname="Wolman"></author>
          <date month="April" year="2003" />
        </front>

        <seriesInfo name="Proceedings of IEEE INFOCOM" value="2003" />
      </reference>

      <reference anchor="HE2005" target="http://ieeexplore.ieee.org/xpl/freeabs_all.jsp?arnumber=1284204&abstractAccess=no&userType=inst">
        <front>
          <title>Dynamic Host-Group/Multi-Destination Routing for Multicast Sessions</title>
          <author initials="Q." surname="He" />
          <author initials="M." surname="Ammar" />
          <date day="" month="" year="2005"/>
        </front>

        <seriesInfo name="J. Telecommunication Systems" value="vol. 28, pp. 409-433" />
      </reference>

      <reference anchor="SPLITSTREAM"
                 target="http://research.microsoft.com/en-us/um/people/antr/PAST/SplitStream-sosp.pdf">
        <front>
          <title>SplitStream: High-bandwidth multicast in a cooperative environment</title>
          <author initials="M." surname="Castro"></author>
          <author initials="P." surname="Druschel"></author>
          <author initials="A." surname="Nandi"></author>
          <author initials="A.-M." surname="Kermarrec"></author>
          <author initials="A." surname="Rowstron"></author>
          <author initials="A." surname="Singh"></author>
          <date month="October" year="2003" />
        </front>

        <seriesInfo name="SOSP'03,Lake Bolton, New York" value="2003"/>
      </reference>

      <reference anchor="P2PCAST" target="http://www.scs.stanford.edu/~reddy/research/p2pcast/report.pdf">
        <front>
          <title>P2PCast: A Peer-to-Peer Multicast Scheme for Streaming Data</title>

          <author initials="A." surname="Nicolosi" />
          <author initials="S." surname="Annapureddy" />
          <date month="May" year="2003" />
        </front>

        <seriesInfo name="Stanford Secure Computer Systems Group Report" value="2003" />
      </reference>

      <reference anchor="BUFORD2009" target="http://www.sciencedirect.com/science/book/9780123742148">
        <front>
          <title>P2P Networking and Applications (Chapter 9)</title>
          <author initials="J." surname="Buford"></author>
          <author initials="H." surname="Yu"></author>
          <author initials="E.K." surname="Lua"></author>
          <date year="2009" />
        </front>

        <seriesInfo name="Morgan Kaufman" value="2009" />
      </reference>

      <reference anchor="KOLBERG2010" target="http://link.springer.com/content/pdf/10.1007%2F978-0-387-09751-0_30.pdf">
        <front>
          <title>Employing Multicast in P2P Networks</title>
          <author initials="M." surname="Kolberg"></author>
          <date year="2010" />
        </front>

        <seriesInfo name="Handbook of Peer-to-Peer Networking (Ed. X.Shen, H. Yu, J. Buford, M. Akon)" value="2010" />
      </reference>

      <reference anchor="BUFORD2008" target="http://www.tandfonline.com/doi/abs/10.1081/E-EWMC-120043583">
        <front>
          <title>Peer-to-Peer Overlay Multicast</title>
          <author initials="J." surname="Buford"></author>
          <author initials="H." surname="Yu"></author>
          <date year="2008" />
        </front>

        <seriesInfo name="Encyclopedia of Wireless and Mobile Communications" value="2008" />
      </reference>
    </references>

  </back>
</rfc>

PAFTECH AB 2003-20262026-04-24 15:49:31