Merge pull request #2 from wmnsk/master

syncing changes from original branch to our fork

Author: gordeyg

README.md

@@ -80,9 +80,9 @@ For the detailed usage of specific version, see README.md under each version's d
 
 | Version | Details                   |
 |---------|---------------------------|
-| GTPv0   | [README.md](v0/README.md) |
-| GTPv1   | [README.md](v1/README.md) |
-| GTPv2   | [README.md](v2/README.md) |
+| GTPv0   | [README.md](gtpv0/README.md) |
+| GTPv1   | [README.md](gtpv1/README.md) |
+| GTPv2   | [README.md](gtpv2/README.md) |
 
 ## Supported Features
 
@@ -93,9 +93,9 @@ Your contribution is welcome to implement helpers for all the types, of course!
 
 | Version           | Messages | IEs   | Networking (state machine)                           | Details                                               |
 |-------------------|----------|-------|------------------------------------------------------|-------------------------------------------------------|
-| GTPv0             | 35.7%    | 81.8% | not implemented yet                                  | [Supported Features](v0/README.md#supported-features) |
-| GTPv1             | 26.6%    | 30.1% | v1-U is functional, <br> v1-C is not implemented yet | [Supported Features](v1/README.md#supported-features) |
-| GTPv2             | 41.0%    | 43.2% | almost functional                                    | [Supported Features](v2/README.md#supported-features) |
+| GTPv0             | 35.7%    | 81.8% | not implemented yet                                  | [Supported Features](gtpv0/README.md#supported-features) |
+| GTPv1             | 26.6%    | 30.1% | v1-U is functional, <br> v1-C is not implemented yet | [Supported Features](gtpv1/README.md#supported-features) |
+| GTPv2             | 41.0%    | 43.2% | almost functional                                    | [Supported Features](gtpv2/README.md#supported-features) |
 | GTP' <br> (Prime) | N/A      | N/A   | N/A                                                  | _not planned_                                         |
 
 ## Disclaimer

examples/gw-tester/enb/enb.go

@@ -21,7 +21,7 @@ import (
 	"google.golang.org/grpc"
 
 	"github.com/wmnsk/go-gtp/examples/gw-tester/s1mme"
-	v1 "github.com/wmnsk/go-gtp/v1"
+	v1 "github.com/wmnsk/go-gtp/gtpv1"
 )
 
 type enb struct {

examples/gw-tester/enb/metrics.go

@@ -49,15 +49,15 @@ func (e *enb) runMetricsCollector() error {
 	mc.messagesSent = promauto.NewCounterVec(
 		prometheus.CounterOpts{
 			Name: "enb_messages_sent_total",
-			Help: "number of messages sent by messagge type",
+			Help: "number of message sent by messagge type",
 		},
 		[]string{"dst", "type"},
 	)
 
 	mc.messagesReceived = promauto.NewCounterVec(
 		prometheus.CounterOpts{
 			Name: "enb_messages_received_total",
-			Help: "number of messages received by messagge type",
+			Help: "number of message received by messagge type",
 		},
 		[]string{"src", "type"},
 	)

examples/gw-tester/mme/handlers.go

@@ -6,15 +6,15 @@ package main
 
 import (
 	"fmt"
+	"github.com/wmnsk/go-gtp/gtpv2/ie"
+	"github.com/wmnsk/go-gtp/gtpv2/message"
 	"log"
 	"net"
 
-	v2 "github.com/wmnsk/go-gtp/v2"
-	"github.com/wmnsk/go-gtp/v2/ies"
-	"github.com/wmnsk/go-gtp/v2/messages"
+	v2 "github.com/wmnsk/go-gtp/gtpv2"
 )
 
-func (m *mme) handleCreateSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg messages.Message) error {
+func (m *mme) handleCreateSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg message.Message) error {
 	log.Printf("Received %s from %s", msg.MessageTypeName(), sgwAddr)
 	if m.mc != nil {
 		m.mc.messagesReceived.WithLabelValues(sgwAddr.String(), msg.MessageTypeName()).Inc()
@@ -31,11 +31,11 @@ func (m *mme) handleCreateSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg mess
 	// assert type to refer to the struct field specific to the message.
 	// in general, no need to check if it can be type-asserted, as long as the MessageType is
 	// specified correctly in AddHandler().
-	csRspFromSGW := msg.(*messages.CreateSessionResponse)
+	csRspFromSGW := msg.(*message.CreateSessionResponse)
 
 	// check Cause value first.
-	if ie := csRspFromSGW.Cause; ie != nil {
-		cause, err := ie.Cause()
+	if causeIE := csRspFromSGW.Cause; causeIE != nil {
+		cause, err := causeIE.Cause()
 		if err != nil {
 			return err
 		}
@@ -51,20 +51,20 @@ func (m *mme) handleCreateSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg mess
 		return &v2.RequiredIEMissingError{Type: msg.MessageType()}
 	}
 
-	if ie := csRspFromSGW.PAA; ie != nil {
-		bearer.SubscriberIP, err = ie.IPAddress()
+	if paaIE := csRspFromSGW.PAA; paaIE != nil {
+		bearer.SubscriberIP, err = paaIE.IPAddress()
 		if err != nil {
 			return err
 		}
 	}
-	if ie := csRspFromSGW.SenderFTEIDC; ie != nil {
-		teid, err := ie.TEID()
+	if fteidcIE := csRspFromSGW.SenderFTEIDC; fteidcIE != nil {
+		teid, err := fteidcIE.TEID()
 		if err != nil {
 			return err
 		}
 		session.AddTEID(v2.IFTypeS11S4SGWGTPC, teid)
 	} else {
-		return &v2.RequiredIEMissingError{Type: ies.FullyQualifiedTEID}
+		return &v2.RequiredIEMissingError{Type: ie.FullyQualifiedTEID}
 	}
 
 	s11sgwTEID, err := session.GetTEID(v2.IFTypeS11S4SGWGTPC)
@@ -79,30 +79,30 @@ func (m *mme) handleCreateSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg mess
 	}
 
 	if brCtxIE := csRspFromSGW.BearerContextsCreated; brCtxIE != nil {
-		for _, ie := range brCtxIE.ChildIEs {
-			switch ie.Type {
-			case ies.EPSBearerID:
-				bearer.EBI, err = ie.EPSBearerID()
+		for _, childIE := range brCtxIE.ChildIEs {
+			switch childIE.Type {
+			case ie.EPSBearerID:
+				bearer.EBI, err = childIE.EPSBearerID()
 				if err != nil {
 					return err
 				}
-			case ies.FullyQualifiedTEID:
-				if ie.Instance() != 0 {
+			case ie.FullyQualifiedTEID:
+				if childIE.Instance() != 0 {
 					continue
 				}
-				it, err := ie.InterfaceType()
+				it, err := childIE.InterfaceType()
 				if err != nil {
 					return err
 				}
-				teid, err := ie.TEID()
+				teid, err := childIE.TEID()
 				if err != nil {
 					return err
 				}
 				session.AddTEID(it, teid)
 			}
 		}
 	} else {
-		return &v2.RequiredIEMissingError{Type: ies.BearerContext}
+		return &v2.RequiredIEMissingError{Type: ie.BearerContext}
 	}
 
 	if err := session.Activate(); err != nil {
@@ -118,7 +118,7 @@ func (m *mme) handleCreateSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg mess
 	return nil
 }
 
-func (m *mme) handleModifyBearerResponse(c *v2.Conn, sgwAddr net.Addr, msg messages.Message) error {
+func (m *mme) handleModifyBearerResponse(c *v2.Conn, sgwAddr net.Addr, msg message.Message) error {
 	log.Printf("Received %s from %s", msg.MessageTypeName(), sgwAddr)
 	if m.mc != nil {
 		m.mc.messagesReceived.WithLabelValues(sgwAddr.String(), msg.MessageTypeName()).Inc()
@@ -129,9 +129,9 @@ func (m *mme) handleModifyBearerResponse(c *v2.Conn, sgwAddr net.Addr, msg messa
 		return err
 	}
 
-	mbRspFromSGW := msg.(*messages.ModifyBearerResponse)
-	if ie := mbRspFromSGW.Cause; ie != nil {
-		cause, err := ie.Cause()
+	mbRspFromSGW := msg.(*message.ModifyBearerResponse)
+	if causeIE := mbRspFromSGW.Cause; causeIE != nil {
+		cause, err := causeIE.Cause()
 		if err != nil {
 			return err
 		}
@@ -143,42 +143,42 @@ func (m *mme) handleModifyBearerResponse(c *v2.Conn, sgwAddr net.Addr, msg messa
 			}
 		}
 	} else {
-		return &v2.RequiredIEMissingError{Type: ies.Cause}
+		return &v2.RequiredIEMissingError{Type: ie.Cause}
 	}
 
 	if brCtxIE := mbRspFromSGW.BearerContextsModified; brCtxIE != nil {
-		for _, ie := range brCtxIE.ChildIEs {
-			switch ie.Type {
-			case ies.FullyQualifiedTEID:
-				if ie.Instance() != 0 {
+		for _, childIE := range brCtxIE.ChildIEs {
+			switch childIE.Type {
+			case ie.FullyQualifiedTEID:
+				if childIE.Instance() != 0 {
 					continue
 				}
-				it, err := ie.InterfaceType()
+				it, err := childIE.InterfaceType()
 				if err != nil {
 					return err
 				}
-				teid, err := ie.TEID()
+				teid, err := childIE.TEID()
 				if err != nil {
 					return err
 				}
 				session.AddTEID(it, teid)
 
-				m.sgw.s1uIP, err = ie.IPAddress()
+				m.sgw.s1uIP, err = childIE.IPAddress()
 				if err != nil {
 					return err
 				}
 			}
 		}
 	} else {
-		return &v2.RequiredIEMissingError{Type: ies.BearerContext}
+		return &v2.RequiredIEMissingError{Type: ie.BearerContext}
 	}
 
 	log.Printf("Bearer modified with S-GW for Subscriber: %s", session.IMSI)
 	m.modified <- struct{}{}
 	return nil
 }
 
-func (m *mme) handleDeleteSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg messages.Message) error {
+func (m *mme) handleDeleteSessionResponse(c *v2.Conn, sgwAddr net.Addr, msg message.Message) error {
 	log.Printf("Received %s from %s", msg.MessageTypeName(), sgwAddr)
 	if m.mc != nil {
 		m.mc.messagesReceived.WithLabelValues(sgwAddr.String(), msg.MessageTypeName()).Inc()

examples/gw-tester/mme/metrics.go

@@ -30,15 +30,15 @@ func (m *mme) runMetricsCollector() error {
 	mc.messagesSent = promauto.NewCounterVec(
 		prometheus.CounterOpts{
 			Name: "mme_messages_sent_total",
-			Help: "number of messages sent by messagge type",
+			Help: "number of message sent by messagge type",
 		},
 		[]string{"dst", "type"},
 	)
 
 	mc.messagesReceived = promauto.NewCounterVec(
 		prometheus.CounterOpts{
 			Name: "mme_messages_received_total",
-			Help: "number of messages received by messagge type",
+			Help: "number of message received by messagge type",
 		},
 		[]string{"src", "type"},
 	)

examples/gw-tester/mme/mme.go

@@ -16,9 +16,9 @@ import (
 	"google.golang.org/grpc"
 
 	"github.com/wmnsk/go-gtp/examples/gw-tester/s1mme"
-	v2 "github.com/wmnsk/go-gtp/v2"
-	"github.com/wmnsk/go-gtp/v2/ies"
-	"github.com/wmnsk/go-gtp/v2/messages"
+	v2 "github.com/wmnsk/go-gtp/gtpv2"
+	"github.com/wmnsk/go-gtp/gtpv2/ie"
+	"github.com/wmnsk/go-gtp/gtpv2/message"
 )
 
 // Session represents a subscriber.
@@ -129,9 +129,9 @@ func (m *mme) run(ctx context.Context) error {
 	log.Printf("Started serving S11 on: %s", m.s11Addr)
 
 	m.s11Conn.AddHandlers(map[uint8]v2.HandlerFunc{
-		messages.MsgTypeCreateSessionResponse: m.handleCreateSessionResponse,
-		messages.MsgTypeModifyBearerResponse:  m.handleModifyBearerResponse,
-		messages.MsgTypeDeleteSessionResponse: m.handleDeleteSessionResponse,
+		message.MsgTypeCreateSessionResponse: m.handleCreateSessionResponse,
+		message.MsgTypeModifyBearerResponse:  m.handleModifyBearerResponse,
+		message.MsgTypeDeleteSessionResponse: m.handleDeleteSessionResponse,
 	})
 
 	// start serving Prometheus, if address is given
@@ -265,30 +265,30 @@ func (m *mme) CreateSession(sess *Session) (*v2.Session, error) {
 
 	session, _, err := m.s11Conn.CreateSession(
 		raddr,
-		ies.NewIMSI(sess.IMSI),
-		ies.NewMSISDN(sess.MSISDN),
-		ies.NewMobileEquipmentIdentity(sess.IMEISV),
-		ies.NewUserLocationInformation(
+		ie.NewIMSI(sess.IMSI),
+		ie.NewMSISDN(sess.MSISDN),
+		ie.NewMobileEquipmentIdentity(sess.IMEISV),
+		ie.NewUserLocationInformation(
 			0, 0, 0, 1, 1, 0, 0, 0,
 			m.enb.mcc, m.enb.mnc, 0, 0, 0, 0, 1, 1, 0, 0,
 		),
-		ies.NewRATType(v2.RATTypeEUTRAN),
-		ies.NewIndicationFromOctets(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00),
+		ie.NewRATType(v2.RATTypeEUTRAN),
+		ie.NewIndicationFromOctets(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00),
 		m.s11Conn.NewSenderFTEID(m.s11IP, ""),
-		ies.NewFullyQualifiedTEID(v2.IFTypeS5S8PGWGTPC, 0, m.pgw.s5cIP, "").WithInstance(1),
-		ies.NewAccessPointName(m.apn),
-		ies.NewSelectionMode(v2.SelectionModeMSorNetworkProvidedAPNSubscribedVerified),
-		ies.NewPDNType(v2.PDNTypeIPv4),
-		ies.NewPDNAddressAllocation(sess.SrcIP),
-		ies.NewAPNRestriction(v2.APNRestrictionNoExistingContextsorRestriction),
-		ies.NewAggregateMaximumBitRate(0, 0),
-		ies.NewBearerContext(
-			ies.NewEPSBearerID(br.EBI),
-			ies.NewBearerQoS(pci, br.PL, pvi, br.QCI, br.MBRUL, br.MBRDL, br.GBRUL, br.GBRDL),
+		ie.NewFullyQualifiedTEID(v2.IFTypeS5S8PGWGTPC, 0, m.pgw.s5cIP, "").WithInstance(1),
+		ie.NewAccessPointName(m.apn),
+		ie.NewSelectionMode(v2.SelectionModeMSorNetworkProvidedAPNSubscribedVerified),
+		ie.NewPDNType(v2.PDNTypeIPv4),
+		ie.NewPDNAddressAllocation(sess.SrcIP),
+		ie.NewAPNRestriction(v2.APNRestrictionNoExistingContextsorRestriction),
+		ie.NewAggregateMaximumBitRate(0, 0),
+		ie.NewBearerContext(
+			ie.NewEPSBearerID(br.EBI),
+			ie.NewBearerQoS(pci, br.PL, pvi, br.QCI, br.MBRUL, br.MBRDL, br.GBRUL, br.GBRDL),
 		),
-		ies.NewFullyQualifiedCSID(m.s11IP, 1),
-		ies.NewServingNetwork(m.mcc, m.mnc),
-		ies.NewUETimeZone(9*time.Hour, 0),
+		ie.NewFullyQualifiedCSID(m.s11IP, 1),
+		ie.NewServingNetwork(m.mcc, m.mnc),
+		ie.NewUETimeZone(9*time.Hour, 0),
 	)
 	if err != nil {
 		return nil, err
@@ -306,10 +306,10 @@ func (m *mme) ModifyBearer(sess *v2.Session, sub *Session) (*v2.Bearer, error) {
 		return nil, err
 	}
 
-	fteid := ies.NewFullyQualifiedTEID(v2.IFTypeS1UeNodeBGTPU, sub.itei, m.enb.s1uIP, "")
+	fteid := ie.NewFullyQualifiedTEID(v2.IFTypeS1UeNodeBGTPU, sub.itei, m.enb.s1uIP, "")
 	if _, err = m.s11Conn.ModifyBearer(
-		teid, sess, ies.NewIndicationFromOctets(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00),
-		ies.NewBearerContext(ies.NewEPSBearerID(sess.GetDefaultBearer().EBI), fteid, ies.NewPortNumber(2125)),
+		teid, sess, ie.NewIndicationFromOctets(0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00),
+		ie.NewBearerContext(ie.NewEPSBearerID(sess.GetDefaultBearer().EBI), fteid, ie.NewPortNumber(2125)),
 	); err != nil {
 		return nil, err
 	}