Implement interleaving 8620

Author: JoTurk

association.go

@@ -2643,7 +2643,7 @@ func TestAssocHandleInit(t *testing.T) {
 		init.numInboundStreams = 1002
 		init.initiateTag = 5678
 		init.advertisedReceiverWindowCredit = 512 * 1024
-		setSupportedExtensions(&init.chunkInitCommon)
+		setSupportedExtensions(&init.chunkInitCommon, false)
 
 		_, err := assoc.handleInit(pkt, init)
 		if expectErr {

association_test.go

@@ -0,0 +1,72 @@
+// SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
+// SPDX-License-Identifier: MIT
+
+package sctp
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestChunkIDataMarshalUnmarshal(t *testing.T) {
+	t.Run("beginning fragment", func(t *testing.T) {
+		orig := &chunkPayloadData{
+			iData:                  true,
+			tsn:                    1,
+			streamIdentifier:       2,
+			messageIdentifier:      5,
+			fragmentSequenceNumber: 0,
+			payloadType:            PayloadTypeWebRTCBinary,
+			userData:               []byte("abc"),
+			beginningFragment:      true,
+			endingFragment:         true,
+		}
+
+		raw, err := orig.marshal()
+		assert.NoError(t, err)
+
+		parsed := &chunkPayloadData{}
+		err = parsed.unmarshal(raw)
+		assert.NoError(t, err)
+		assert.True(t, parsed.isIData())
+		assert.Equal(t, orig.tsn, parsed.tsn)
+		assert.Equal(t, orig.streamIdentifier, parsed.streamIdentifier)
+		assert.Equal(t, orig.messageIdentifier, parsed.messageIdentifier)
+		assert.Equal(t, orig.fragmentSequenceNumber, parsed.fragmentSequenceNumber)
+		assert.Equal(t, orig.payloadType, parsed.payloadType)
+		assert.Equal(t, orig.userData, parsed.userData)
+		assert.True(t, parsed.beginningFragment)
+		assert.True(t, parsed.endingFragment)
+	})
+
+	t.Run("middle fragment", func(t *testing.T) {
+		orig := &chunkPayloadData{
+			iData:                  true,
+			tsn:                    2,
+			streamIdentifier:       3,
+			messageIdentifier:      7,
+			fragmentSequenceNumber: 4,
+			payloadType:            PayloadTypeWebRTCBinary,
+			userData:               []byte("def"),
+			beginningFragment:      false,
+			endingFragment:         false,
+		}
+
+		raw, err := orig.marshal()
+		assert.NoError(t, err)
+
+		parsed := &chunkPayloadData{}
+		err = parsed.unmarshal(raw)
+		assert.NoError(t, err)
+		assert.True(t, parsed.isIData())
+		assert.Equal(t, orig.tsn, parsed.tsn)
+		assert.Equal(t, orig.streamIdentifier, parsed.streamIdentifier)
+		assert.Equal(t, orig.messageIdentifier, parsed.messageIdentifier)
+		assert.Equal(t, orig.fragmentSequenceNumber, parsed.fragmentSequenceNumber)
+		assert.Equal(t, PayloadTypeUnknown, parsed.payloadType)
+		assert.Equal(t, orig.userData, parsed.userData)
+		assert.False(t, parsed.beginningFragment)
+		assert.False(t, parsed.endingFragment)
+	})
+}

chunk_i_data_test.go

@@ -0,0 +1,147 @@
+// SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
+// SPDX-License-Identifier: MIT
+
+package sctp
+
+import (
+	"encoding/binary"
+	"errors"
+	"fmt"
+)
+
+// This chunk be used by the data sender to inform the data
+// receiver to adjust its cumulative received TSN.
+//
+//  0                   1                   2                   3
+//  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// |   Type = 194  |  Flags = 0x00 |        Length = Variable      |
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// |                      New Cumulative TSN                       |
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// |         Stream Identifier    |       Reserved            |U| |
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// |                       Message Identifier                      |
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// \                                                               /
+// /                                                               \
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// |         Stream Identifier    |       Reserved            |U| |
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// |                       Message Identifier                      |
+// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+// https://www.rfc-editor.org/rfc/rfc8260.html#section-2.3.1
+
+type chunkIForwardTSN struct {
+	chunkHeader
+
+	// This indicates the new cumulative TSN to the data receiver.
+	newCumulativeTSN uint32
+
+	streams []chunkIForwardTSNStream
+}
+
+const (
+	iForwardTSNEntryLength = 8
+)
+
+// I-FORWARD-TSN chunk errors.
+var (
+	ErrIForwardTSNChunkTooShort = errors.New("i-forward-tsn chunk too short")
+)
+
+func (c *chunkIForwardTSN) unmarshal(raw []byte) error {
+	if err := c.chunkHeader.unmarshal(raw); err != nil {
+		return err
+	}
+
+	if len(c.raw) < newCumulativeTSNLength {
+		return ErrIForwardTSNChunkTooShort
+	}
+
+	c.newCumulativeTSN = binary.BigEndian.Uint32(c.raw[0:])
+
+	offset := newCumulativeTSNLength
+	remaining := len(c.raw) - offset
+	for remaining > 0 {
+		s := chunkIForwardTSNStream{}
+		if err := s.unmarshal(c.raw[offset:]); err != nil {
+			return fmt.Errorf("%w: %v", ErrMarshalStreamFailed, err) //nolint:errorlint
+		}
+
+		c.streams = append(c.streams, s)
+
+		offset += s.length()
+		remaining -= s.length()
+	}
+
+	return nil
+}
+
+func (c *chunkIForwardTSN) marshal() ([]byte, error) {
+	out := make([]byte, newCumulativeTSNLength)
+	binary.BigEndian.PutUint32(out[0:], c.newCumulativeTSN)
+
+	for _, s := range c.streams {
+		b, err := s.marshal()
+		if err != nil {
+			return nil, fmt.Errorf("%w: %v", ErrMarshalStreamFailed, err) //nolint:errorlint
+		}
+		out = append(out, b...) //nolint:makezero // TODO: fix
+	}
+
+	c.typ = ctIForwardTSN
+	c.raw = out
+
+	return c.chunkHeader.marshal()
+}
+
+func (c *chunkIForwardTSN) check() (abort bool, err error) {
+	return true, nil
+}
+
+// String makes chunkIForwardTSN printable.
+func (c *chunkIForwardTSN) String() string {
+	res := fmt.Sprintf("New Cumulative TSN: %d\n", c.newCumulativeTSN)
+	for _, s := range c.streams {
+		res += fmt.Sprintf(" - si=%d mid=%d unordered=%v\n", s.identifier, s.messageIdentifier, s.unordered)
+	}
+
+	return res
+}
+
+type chunkIForwardTSNStream struct {
+	identifier        uint16
+	unordered         bool
+	messageIdentifier uint32
+}
+
+func (s *chunkIForwardTSNStream) length() int {
+	return iForwardTSNEntryLength
+}
+
+func (s *chunkIForwardTSNStream) unmarshal(raw []byte) error {
+	if len(raw) < iForwardTSNEntryLength {
+		return ErrIForwardTSNChunkTooShort
+	}
+	s.identifier = binary.BigEndian.Uint16(raw[0:])
+	flags := binary.BigEndian.Uint16(raw[2:])
+	s.unordered = flags&0x1 != 0
+	s.messageIdentifier = binary.BigEndian.Uint32(raw[4:])
+
+	return nil
+}
+
+func (s *chunkIForwardTSNStream) marshal() ([]byte, error) { // nolint:unparam
+	out := make([]byte, iForwardTSNEntryLength)
+
+	binary.BigEndian.PutUint16(out[0:], s.identifier)
+	if s.unordered {
+		binary.BigEndian.PutUint16(out[2:], 0x1)
+	} else {
+		binary.BigEndian.PutUint16(out[2:], 0x0)
+	}
+	binary.BigEndian.PutUint32(out[4:], s.messageIdentifier)
+
+	return out, nil
+}

chunk_i_forward_tsn.go

@@ -0,0 +1,60 @@
+// SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
+// SPDX-License-Identifier: MIT
+
+package sctp
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func testChunkIForwardTSN() []byte {
+	return []byte{0xc2, 0x0, 0x0, 0x8, 0x0, 0x0, 0x0, 0x3}
+}
+
+func TestChunkIForwardTSN_Success(t *testing.T) {
+	tt := []struct {
+		binary []byte
+	}{
+		{testChunkIForwardTSN()},
+		{[]byte{0xc2, 0x0, 0x0, 0x10, 0x0, 0x0, 0x0, 0x3, 0x0, 0x4, 0x0, 0x1, 0x0, 0x0, 0x0, 0x5}},
+		{[]byte{
+			0xc2, 0x0, 0x0, 0x40, 0x0, 0x0, 0x0, 0x3,
+			0x0, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x5,
+			0x0, 0x6, 0x0, 0x1, 0x0, 0x0, 0x0, 0x7,
+			0x0, 0x8, 0x0, 0x1, 0x0, 0x0, 0x0, 0x9,
+			0x0, 0xa, 0x0, 0x1, 0x0, 0x0, 0x0, 0xb,
+			0x0, 0xc, 0x0, 0x1, 0x0, 0x0, 0x0, 0xd,
+			0x0, 0xe, 0x0, 0x1, 0x0, 0x0, 0x0, 0xf,
+			0x0, 0x10, 0x0, 0x1, 0x0, 0x0, 0x0, 0x11,
+		}},
+	}
+
+	for i, tc := range tt {
+		actual := &chunkIForwardTSN{}
+		err := actual.unmarshal(tc.binary)
+		assert.NoErrorf(t, err, "failed to unmarshal #%d", i)
+
+		b, err := actual.marshal()
+		assert.NoError(t, err)
+		assert.Equalf(t, tc.binary, b, "test %d not equal", i)
+	}
+}
+
+func TestChunkIForwardTSNUnmarshal_Failure(t *testing.T) {
+	tt := []struct {
+		name   string
+		binary []byte
+	}{
+		{"chunk header to short", []byte{0xc2}},
+		{"missing New Cumulative TSN", []byte{0xc2, 0x0, 0x0, 0x4}},
+		{"missing stream info", []byte{0xc2, 0x0, 0x0, 0x10, 0x0, 0x0, 0x0, 0x3, 0x0, 0x4, 0x0, 0x1}},
+	}
+
+	for i, tc := range tt {
+		actual := &chunkIForwardTSN{}
+		err := actual.unmarshal(tc.binary)
+		assert.Errorf(t, err, "expected unmarshal #%d: '%s' to fail.", i, tc.name)
+	}
+}