snet: API function/type renaming (scionproto#3690)

- Rename UDPAddrFromString to ParseUDPAddr - Rename SCIONPacket to Packet, SCIONPacketInfo to PacketInfo - Remove snet.Conn interface, rename SCIONConn to Conn This breaks the API. Contributes scionproto#3136 Closes scionproto#3675
stygerma · Apr 22, 2020 · 92f9a72 · 92f9a72
1 parent d29d366
commit 92f9a72
Show file tree

Hide file tree

Showing 34 changed files with 127 additions and 147 deletions.
diff --git a/go/border/rctrl/ctrl.go b/go/border/rctrl/ctrl.go
@@ -39,7 +39,7 @@ const (
 )
 
 var (
-	snetConn snet.Conn
+	snetConn *snet.Conn
 	ia       addr.IA
 	logger   log.Logger
 )

diff --git a/go/cs/beaconing/originator_test.go b/go/cs/beaconing/originator_test.go
@@ -91,7 +91,7 @@ func TestOriginatorRun(t *testing.T) {
 				msgsMtx.Lock()
 				defer msgsMtx.Unlock()
 				msgs = append(msgs, msg{
-					pkt: ipkt.(*snet.SCIONPacket),
+					pkt: ipkt.(*snet.Packet),
 					ov:  iov.(*net.UDPAddr),
 				})
 				return nil
@@ -159,7 +159,7 @@ func TestOriginatorRun(t *testing.T) {
 }
 
 type msg struct {
-	pkt *snet.SCIONPacket
+	pkt *snet.Packet
 	ov  *net.UDPAddr
 }
 

diff --git a/go/cs/beaconing/propagator_test.go b/go/cs/beaconing/propagator_test.go
@@ -194,7 +194,7 @@ func TestPropagatorRun(t *testing.T) {
 					msgsMtx.Lock()
 					defer msgsMtx.Unlock()
 					msgs = append(msgs, msg{
-						pkt: ipkt.(*snet.SCIONPacket),
+						pkt: ipkt.(*snet.Packet),
 						ov:  iov.(*net.UDPAddr),
 					})
 					return nil

diff --git a/go/cs/keepalive/sender_test.go b/go/cs/keepalive/sender_test.go
@@ -61,10 +61,10 @@ func TestSenderRun(t *testing.T) {
 		Signer:       createTestSigner(t, priv),
 		TopoProvider: topoProvider,
 	}
-	pkts := make([]*snet.SCIONPacket, 0, len(topoProvider.Get().IFInfoMap()))
+	pkts := make([]*snet.Packet, 0, len(topoProvider.Get().IFInfoMap()))
 	conn.EXPECT().WriteTo(gomock.Any(), gomock.Any()).Times(cap(pkts)).DoAndReturn(
 		func(ipkts, _ interface{}) error {
-			pkts = append(pkts, ipkts.(*snet.SCIONPacket))
+			pkts = append(pkts, ipkts.(*snet.Packet))
 			return nil
 		},
 	)

diff --git a/go/cs/onehop/network.go b/go/cs/onehop/network.go
@@ -47,11 +47,11 @@ type ohpPacketConn struct {
 	snet.PacketConn
 }
 
-func (c *ohpPacketConn) WriteTo(pkt *snet.SCIONPacket, ov *net.UDPAddr) error {
+func (c *ohpPacketConn) WriteTo(pkt *snet.Packet, ov *net.UDPAddr) error {
 	return c.PacketConn.WriteTo(
-		&snet.SCIONPacket{
+		&snet.Packet{
 			Bytes: pkt.Bytes,
-			SCIONPacketInfo: snet.SCIONPacketInfo{
+			PacketInfo: snet.PacketInfo{
 				Destination: pkt.Destination,
 				Source:      pkt.Source,
 				Path:        pkt.Path,

diff --git a/go/cs/onehop/sender.go b/go/cs/onehop/sender.go
@@ -80,13 +80,13 @@ func (s *Sender) Send(msg *Msg, nextHop *net.UDPAddr) error {
 }
 
 // CreatePkt creates a scion packet with a one-hop path and the payload.
-func (s *Sender) CreatePkt(msg *Msg) (*snet.SCIONPacket, error) {
+func (s *Sender) CreatePkt(msg *Msg) (*snet.Packet, error) {
 	path, err := s.CreatePath(msg.Ifid, msg.InfoTime)
 	if err != nil {
 		return nil, err
 	}
-	pkt := &snet.SCIONPacket{
-		SCIONPacketInfo: snet.SCIONPacketInfo{
+	pkt := &snet.Packet{
+		PacketInfo: snet.PacketInfo{
 			Destination: msg.Dst,
 			Source: snet.SCIONAddress{
 				IA:   s.IA,

diff --git a/go/cs/onehop/sender_test.go b/go/cs/onehop/sender_test.go
@@ -110,10 +110,10 @@ func TestSenderSend(t *testing.T) {
 		}
 		// Read from connection to unblock sender.
 		ov := &net.UDPAddr{IP: net.IP{127, 0, 0, 42}, Port: 1337}
-		var pkt *snet.SCIONPacket
+		var pkt *snet.Packet
 		conn.EXPECT().WriteTo(gomock.Any(), ov).DoAndReturn(
 			func(ipkt, _ interface{}) error {
-				pkt = ipkt.(*snet.SCIONPacket)
+				pkt = ipkt.(*snet.Packet)
 				return nil
 			},
 		)
@@ -136,7 +136,7 @@ func testPacket() *Msg {
 	}
 }
 
-func checkTestPkt(t *testing.T, s *Sender, msg *Msg, pkt *snet.SCIONPacket) {
+func checkTestPkt(t *testing.T, s *Sender, msg *Msg, pkt *snet.Packet) {
 
 	SoMsg("dst", pkt.Destination, ShouldResemble, msg.Dst)
 	SoMsg("src", pkt.Source, ShouldResemble, snet.SCIONAddress{

diff --git a/go/integration/cert_req/main.go b/go/integration/cert_req/main.go
@@ -66,7 +66,7 @@ func addFlags() {
 }
 
 type client struct {
-	conn snet.Conn
+	conn *snet.Conn
 	msgr infra.Messenger
 }
 

diff --git a/go/integration/end2end/main.go b/go/integration/end2end/main.go
@@ -116,7 +116,7 @@ func (s server) run() {
 	log.Debug("Listening", "local", fmt.Sprintf("%v:%d", integration.Local.Host, port))
 	// Receive ping message
 	for {
-		var p snet.SCIONPacket
+		var p snet.Packet
 		var ov net.UDPAddr
 		if err := conn.ReadFrom(&p, &ov); err != nil {
 			log.Error("Error reading packet", "err", err)
@@ -210,8 +210,8 @@ func (c client) ping(ctx context.Context, n int) error {
 	// API guarantees return values are ok
 	_, _ = rand.Read(debugID[:])
 	return c.conn.WriteTo(
-		&snet.SCIONPacket{
-			SCIONPacketInfo: snet.SCIONPacketInfo{
+		&snet.Packet{
+			PacketInfo: snet.PacketInfo{
 				Destination: snet.SCIONAddress{
 					IA:   remote.IA,
 					Host: addr.HostFromIP(remote.Host.IP),
@@ -261,7 +261,7 @@ func (c client) getRemote(ctx context.Context, n int) error {
 
 func (c client) pong(ctx context.Context) error {
 	c.conn.SetReadDeadline(getDeadline(ctx))
-	var p snet.SCIONPacket
+	var p snet.Packet
 	var ov net.UDPAddr
 	if err := c.conn.ReadFrom(&p, &ov); err != nil {
 		return common.NewBasicError("Error reading packet", err)

diff --git a/go/lib/infra/infraenv/infraenv.go b/go/lib/infra/infraenv/infraenv.go
@@ -324,7 +324,7 @@ func InitInfraEnvironmentFunc(topologyPath string, f func()) {
 // inform local SCION state (CS informing the local SD).
 type ignoreSCMP struct{}
 
-func (ignoreSCMP) Handle(pkt *snet.SCIONPacket) error {
+func (ignoreSCMP) Handle(pkt *snet.Packet) error {
 	// Always reattempt reads from the socket.
 	return nil
 }
diff --git a/go/lib/pktdisp/disp.go b/go/lib/pktdisp/disp.go
@@ -35,7 +35,7 @@ type DispatchFunc func(*DispPkt)
 // PktDispatcher listens on c, and calls f for every packet read.
 // N.B. the DispPkt passed to f is reused, so applications should make a copy if
 // this is a problem.
-func PktDispatcher(c snet.Conn, f DispatchFunc, pktDispStop chan struct{}) {
+func PktDispatcher(c *snet.Conn, f DispatchFunc, pktDispStop chan struct{}) {
 	fatal.Check()
 	var err error
 	var n int

diff --git a/go/lib/sciond/pathprobe/paths.go b/go/lib/sciond/pathprobe/paths.go
@@ -142,7 +142,7 @@ func (p Prober) GetStatuses(ctx context.Context,
 	return scmpH.statuses, nil
 }
 
-func (p Prober) send(scionConn snet.Conn, path snet.Path) error {
+func (p Prober) send(scionConn *snet.Conn, path snet.Path) error {
 	addr := &snet.SVCAddr{
 		IA:      p.DstIA,
 		Path:    path.Path(),
@@ -157,7 +157,7 @@ func (p Prober) send(scionConn snet.Conn, path snet.Path) error {
 	return nil
 }
 
-func (p Prober) receive(scionConn snet.Conn) error {
+func (p Prober) receive(scionConn *snet.Conn) error {
 	b := make([]byte, 1500, 1500)
 	_, _, err := scionConn.ReadFrom(b)
 	if err == nil {
@@ -182,7 +182,7 @@ type scmpHandler struct {
 	statuses map[string]Status
 }
 
-func (h *scmpHandler) Handle(pkt *snet.SCIONPacket) error {
+func (h *scmpHandler) Handle(pkt *snet.Packet) error {
 	hdr, ok := pkt.L4Header.(*scmp.Hdr)
 	if ok {
 		path, err := h.path(pkt)
@@ -199,7 +199,7 @@ func (h *scmpHandler) Handle(pkt *snet.SCIONPacket) error {
 	return nil
 }
 
-func (h *scmpHandler) path(pkt *snet.SCIONPacket) (string, error) {
+func (h *scmpHandler) path(pkt *snet.Packet) (string, error) {
 	path := pkt.Path.Copy()
 	if err := path.Reverse(); err != nil {
 		return "", common.NewBasicError("unable to reverse path on received packet", err)

diff --git a/go/lib/sigdisp/disp.go b/go/lib/sigdisp/disp.go
@@ -28,7 +28,7 @@ import (
 	"github.com/scionproto/scion/go/lib/snet"
 )
 
-func Init(conn snet.Conn, useid bool) {
+func Init(conn *snet.Conn, useid bool) {
 	useID = useid
 	go func() {
 		defer log.HandlePanic()

diff --git a/go/lib/snet/conn.go b/go/lib/snet/conn.go
@@ -52,19 +52,18 @@ func (e *OpError) Error() string {
 	return e.scmp.String()
 }
 
-var _ net.Conn = (*SCIONConn)(nil)
-var _ net.PacketConn = (*SCIONConn)(nil)
-var _ Conn = (*SCIONConn)(nil)
+var _ net.Conn = (*Conn)(nil)
+var _ net.PacketConn = (*Conn)(nil)
 
-type SCIONConn struct {
+type Conn struct {
 	conn PacketConn
 	scionConnBase
 	scionConnWriter
 	scionConnReader
 }
 
-func newSCIONConn(base *scionConnBase, querier PathQuerier, conn PacketConn) *SCIONConn {
-	c := &SCIONConn{
+func newConn(base *scionConnBase, querier PathQuerier, conn PacketConn) *Conn {
+	c := &Conn{
 		conn:          conn,
 		scionConnBase: *base,
 	}
@@ -73,7 +72,7 @@ func newSCIONConn(base *scionConnBase, querier PathQuerier, conn PacketConn) *SC
 	return c
 }
 
-func (c *SCIONConn) SetDeadline(t time.Time) error {
+func (c *Conn) SetDeadline(t time.Time) error {
 	if err := c.scionConnReader.SetReadDeadline(t); err != nil {
 		return err
 	}
@@ -83,6 +82,6 @@ func (c *SCIONConn) SetDeadline(t time.Time) error {
 	return nil
 }
 
-func (c *SCIONConn) Close() error {
+func (c *Conn) Close() error {
 	return c.conn.Close()
 }
diff --git a/go/lib/snet/dispatcher.go b/go/lib/snet/dispatcher.go
@@ -76,7 +76,7 @@ type SCMPHandler interface {
 	//
 	// If the handler mutates the packet, the changes are seen by snet
 	// connection method callers.
-	Handle(pkt *SCIONPacket) error
+	Handle(pkt *Packet) error
 }
 
 // NewSCMPHandler creates a default SCMP handler that forwards revocations to the revocation
@@ -98,7 +98,7 @@ type scmpHandler struct {
 	revocationHandler RevocationHandler
 }
 
-func (h *scmpHandler) Handle(pkt *SCIONPacket) error {
+func (h *scmpHandler) Handle(pkt *Packet) error {
 	hdr, ok := pkt.L4Header.(*scmp.Hdr)
 	if !ok {
 		return common.NewBasicError("scmp handler invoked with non-scmp packet", nil, "pkt", pkt)
@@ -119,7 +119,7 @@ func (h *scmpHandler) Handle(pkt *SCIONPacket) error {
 	return nil
 }
 
-func (h *scmpHandler) handleSCMPRev(hdr *scmp.Hdr, pkt *SCIONPacket) error {
+func (h *scmpHandler) handleSCMPRev(hdr *scmp.Hdr, pkt *Packet) error {
 	scmpPayload, ok := pkt.Payload.(*scmp.Payload)
 	if !ok {
 		return common.NewBasicError("Unable to type assert payload to SCMP payload", nil,

diff --git a/go/lib/snet/interface.go b/go/lib/snet/interface.go
@@ -18,31 +18,13 @@ package snet
 import (
 	"context"
 	"net"
-	"time"
 
 	"github.com/scionproto/scion/go/lib/addr"
 )
 
 type Network interface {
-	Listen(ctx context.Context, network string, listen *net.UDPAddr, svc addr.HostSVC) (Conn, error)
+	Listen(ctx context.Context, network string, listen *net.UDPAddr,
+		svc addr.HostSVC) (*Conn, error)
 	Dial(ctx context.Context, network string, listen *net.UDPAddr, remote *UDPAddr,
-		svc addr.HostSVC) (Conn, error)
-}
-
-// Conn represents a SCION connection.
-type Conn interface {
-	Read(b []byte) (int, error)
-	ReadFrom(b []byte) (int, net.Addr, error)
-	Write(b []byte) (int, error)
-	WriteTo(b []byte, address net.Addr) (int, error)
-	Close() error
-	LocalAddr() net.Addr
-	SVC() addr.HostSVC
-	// RemoteAddr returns the remote network address.
-	RemoteAddr() net.Addr
-	// SetDeadline sets read and write deadlines. Implements the net.Conn
-	// SetDeadline method.
-	SetDeadline(deadline time.Time) error
-	SetReadDeadline(deadline time.Time) error
-	SetWriteDeadline(deadline time.Time) error
+		svc addr.HostSVC) (*Conn, error)
 }
diff --git a/go/lib/snet/mock_snet/snet.go b/go/lib/snet/mock_snet/snet.go