From 90bf1c1ff7a22142bcf5c22fd5901d5ab33a8a7c Mon Sep 17 00:00:00 2001
From: Arthur Sfez <asfez@google.com>
Date: Mon, 7 Mar 2022 11:53:51 -0800
Subject: [PATCH] Expose endpoint's state for raw and icmp sockets

The datagram endpoint state is valid and set for these endpoints, so we
can expose them (as we do for udp endpoints).

PiperOrigin-RevId: 433001691
---
 pkg/tcpip/transport/BUILD            |  21 ++++-
 pkg/tcpip/transport/datagram_test.go | 128 +++++++++++++++++++++++++++
 pkg/tcpip/transport/icmp/endpoint.go |   2 +-
 pkg/tcpip/transport/raw/endpoint.go  |   2 +-
 4 files changed, 150 insertions(+), 3 deletions(-)
 create mode 100644 pkg/tcpip/transport/datagram_test.go

diff --git a/pkg/tcpip/transport/BUILD b/pkg/tcpip/transport/BUILD
index af332ed91..ebd5e9fe1 100644
--- a/pkg/tcpip/transport/BUILD
+++ b/pkg/tcpip/transport/BUILD
@@ -1,4 +1,4 @@
-load("//tools:defs.bzl", "go_library")
+load("//tools:defs.bzl", "go_library", "go_test")
 
 package(licenses = ["notice"])
 
@@ -11,3 +11,22 @@ go_library(
     visibility = ["//visibility:public"],
     deps = ["//pkg/tcpip"],
 )
+
+go_test(
+    name = "datagram_test",
+    size = "small",
+    srcs = ["datagram_test.go"],
+    deps = [
+        ":transport",
+        "//pkg/tcpip",
+        "//pkg/tcpip/header",
+        "//pkg/tcpip/link/loopback",
+        "//pkg/tcpip/network/ipv4",
+        "//pkg/tcpip/stack",
+        "//pkg/tcpip/testutil",
+        "//pkg/tcpip/transport/icmp",
+        "//pkg/tcpip/transport/raw",
+        "//pkg/tcpip/transport/udp",
+        "//pkg/waiter",
+    ],
+)
diff --git a/pkg/tcpip/transport/datagram_test.go b/pkg/tcpip/transport/datagram_test.go
new file mode 100644
index 000000000..19c32613c
--- /dev/null
+++ b/pkg/tcpip/transport/datagram_test.go
@@ -0,0 +1,128 @@
+// Copyright 2022 The gVisor Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package datagram_test has tests shared by datagram-based transport endpoints.
+package datagram_test
+
+import (
+	"fmt"
+	"testing"
+
+	"gvisor.dev/gvisor/pkg/tcpip"
+	"gvisor.dev/gvisor/pkg/tcpip/header"
+	"gvisor.dev/gvisor/pkg/tcpip/link/loopback"
+	"gvisor.dev/gvisor/pkg/tcpip/network/ipv4"
+	"gvisor.dev/gvisor/pkg/tcpip/stack"
+	"gvisor.dev/gvisor/pkg/tcpip/testutil"
+	"gvisor.dev/gvisor/pkg/tcpip/transport"
+	"gvisor.dev/gvisor/pkg/tcpip/transport/icmp"
+	"gvisor.dev/gvisor/pkg/tcpip/transport/raw"
+	"gvisor.dev/gvisor/pkg/tcpip/transport/udp"
+	"gvisor.dev/gvisor/pkg/waiter"
+)
+
+func TestStateUpdates(t *testing.T) {
+	const nicID = 1
+
+	for _, test := range []struct {
+		name           string
+		createEndpoint func(*stack.Stack) (tcpip.Endpoint, error)
+	}{
+		{
+			name: "UDP",
+			createEndpoint: func(s *stack.Stack) (tcpip.Endpoint, error) {
+				ep, err := s.NewEndpoint(udp.ProtocolNumber, ipv4.ProtocolNumber, &waiter.Queue{})
+				if err != nil {
+					return nil, fmt.Errorf("s.NewEndpoint(%d, %d, _) failed: %s", udp.ProtocolNumber, ipv4.ProtocolNumber, err)
+				}
+				return ep, nil
+			},
+		},
+		{
+			name: "ICMP",
+			createEndpoint: func(s *stack.Stack) (tcpip.Endpoint, error) {
+				ep, err := s.NewEndpoint(icmp.ProtocolNumber4, ipv4.ProtocolNumber, &waiter.Queue{})
+				if err != nil {
+					return nil, fmt.Errorf("s.NewEndpoint(%d, %d, _) failed: %s", icmp.ProtocolNumber4, ipv4.ProtocolNumber, err)
+				}
+				return ep, nil
+			},
+		},
+		{
+			name: "RAW",
+			createEndpoint: func(s *stack.Stack) (tcpip.Endpoint, error) {
+				ep, err := s.NewRawEndpoint(udp.ProtocolNumber, ipv4.ProtocolNumber, &waiter.Queue{}, true /* associated */)
+				if err != nil {
+					return nil, fmt.Errorf("s.NewRawEndpoint(%d, %d, _, true) failed: %s", udp.ProtocolNumber, ipv4.ProtocolNumber, err)
+				}
+				return ep, nil
+			},
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			s := stack.New(stack.Options{
+				NetworkProtocols:   []stack.NetworkProtocolFactory{ipv4.NewProtocol},
+				TransportProtocols: []stack.TransportProtocolFactory{udp.NewProtocol, icmp.NewProtocol4},
+				RawFactory:         &raw.EndpointFactory{},
+			})
+			if err := s.CreateNIC(nicID, loopback.New()); err != nil {
+				t.Fatalf("s.CreateNIC(%d, loopback.New()) failed: %s", nicID, err)
+			}
+			ep, err := test.createEndpoint(s)
+			if err != nil {
+				t.Fatalf("test.createEndpoint(_) failed: %s", err)
+			}
+			// The endpoint may be closed during the test, but closing twice is
+			// expected to be a no-op.
+			defer ep.Close()
+
+			if got, want := transport.DatagramEndpointState(ep.State()), transport.DatagramEndpointStateInitial; got != want {
+				t.Errorf("got ep.State() = %s, want = %s", got, want)
+			}
+
+			addr := tcpip.ProtocolAddress{
+				Protocol:          ipv4.ProtocolNumber,
+				AddressWithPrefix: testutil.MustParse4("1.2.3.4").WithPrefix(),
+			}
+			if err := s.AddProtocolAddress(nicID, addr, stack.AddressProperties{}); err != nil {
+				t.Fatalf("AddProtocolAddress(%d, %#v, {}): %s", nicID, addr, err)
+			}
+			s.SetRouteTable([]tcpip.Route{
+				{
+					Destination: header.IPv4EmptySubnet,
+					NIC:         nicID,
+				},
+			})
+
+			if err := ep.Bind(tcpip.FullAddress{}); err != nil {
+				t.Fatalf("ep.Bind(...) failed: %s", err)
+			}
+			if got, want := transport.DatagramEndpointState(ep.State()), transport.DatagramEndpointStateBound; got != want {
+				t.Errorf("got ep.State() = %s, want = %s", got, want)
+			}
+
+			if err := ep.Connect(tcpip.FullAddress{NIC: nicID, Addr: testutil.MustParse4("1.0.0.1"), Port: 12345}); err != nil {
+				t.Fatalf("ep.Connect(...) failed: %s", err)
+			}
+			if got, want := transport.DatagramEndpointState(ep.State()), transport.DatagramEndpointStateConnected; got != want {
+				t.Errorf("got ep.State() = %s, want = %s", got, want)
+			}
+
+			ep.Close()
+			if got, want := transport.DatagramEndpointState(ep.State()), transport.DatagramEndpointStateClosed; got != want {
+				t.Errorf("got ep.State() = %s, want = %s", got, want)
+			}
+		})
+	}
+}
diff --git a/pkg/tcpip/transport/icmp/endpoint.go b/pkg/tcpip/transport/icmp/endpoint.go
index f939bd966..1fcc4d0ac 100644
--- a/pkg/tcpip/transport/icmp/endpoint.go
+++ b/pkg/tcpip/transport/icmp/endpoint.go
@@ -770,7 +770,7 @@ func (*endpoint) HandleError(stack.TransportError, *stack.PacketBuffer) {}
 // State implements tcpip.Endpoint.State. The ICMP endpoint currently doesn't
 // expose internal socket state.
 func (e *endpoint) State() uint32 {
-	return 0
+	return uint32(e.net.State())
 }
 
 // Info returns a copy of the endpoint info.
diff --git a/pkg/tcpip/transport/raw/endpoint.go b/pkg/tcpip/transport/raw/endpoint.go
index 089de7f7a..c13919955 100644
--- a/pkg/tcpip/transport/raw/endpoint.go
+++ b/pkg/tcpip/transport/raw/endpoint.go
@@ -713,7 +713,7 @@ func (e *endpoint) HandlePacket(pkt *stack.PacketBuffer) {
 
 // State implements socket.Socket.State.
 func (e *endpoint) State() uint32 {
-	return 0
+	return uint32(e.net.State())
 }
 
 // Info returns a copy of the endpoint info.