Merge branch 'main' into svsa

.github/workflows/bench.yml

@@ -0,0 +1,50 @@
+name: Benchmark
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  deployments: write
+  pull-requests: write
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+
+      - name: Run benchmark
+        run: go test ./... -benchmem -bench ^Benchmark -benchtime=300000x | tee bench.log
+
+      - name: Check benchmark result
+        if: github.event_name == 'pull_request'
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Go Benchmark
+          tool: go
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          output-file-path: bench.log
+          alert-threshold: '200%'
+          comment-on-alert: true
+          fail-on-alert: true
+          summary-always: true
+          alert-comment-cc-users: '@pulsejet'
+
+      - name: Store benchmark result
+        uses: benchmark-action/github-action-benchmark@v1
+        if: github.event_name != 'pull_request'
+        with:
+          name: Go Benchmark
+          tool: go
+          output-file-path: bench.log
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          fail-on-alert: true

.github/workflows/build.yml

@@ -12,9 +12,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-22.04, ubuntu-24.04,
-             macos-13, macos-14,
-             windows-2022]
+        os: [ubuntu-latest, macos-latest, windows-latest]
       fail-fast: false
     steps:
       - name: Checkout repository

.github/workflows/lint.yml

@@ -1,6 +1,7 @@
 name: lint
 on:
   push:
+    branches: ["main"]
   pull_request:
 
 jobs:

README.md

@@ -9,6 +9,8 @@
 [![build](https://github.com/named-data/ndnd/actions/workflows/build.yml/badge.svg)](https://github.com/named-data/ndnd/actions/workflows/build.yml)
 [![test](https://github.com/named-data/ndnd/actions/workflows/test.yml/badge.svg)](https://github.com/named-data/ndnd/actions/workflows/test.yml)
 [![Go Report Card](https://goreportcard.com/badge/github.com/named-data/ndnd)](https://goreportcard.com/report/github.com/named-data/ndnd)
+[![Benchmark](https://img.shields.io/badge/benchmark-graph-8A2BE2?logo=github)](https://named-data.github.io/ndnd/dev/bench/index.html)
+
 [![release](https://img.shields.io/github/v/release/named-data/ndnd)](https://github.com/named-data/ndnd/releases)
 [![MIT license](https://img.shields.io/badge/license-MIT-blue)](./LICENSE.md)
 [![Go Reference](https://pkg.go.dev/badge/github.com/named-data/ndnd.svg)](https://pkg.go.dev/github.com/named-data/ndnd)

dv/dv/advert_data.go

@@ -82,7 +82,7 @@ func (a *advertModule) dataHandler(nName enc.Name, seqNo uint64, data enc.Wire)
 	}
 
 	// Parse the advertisement
-	advert, err := tlv.ParseAdvertisement(enc.NewWireReader(data), false)
+	advert, err := tlv.ParseAdvertisement(enc.NewWireView(data), false)
 	if err != nil {
 		log.Error(a, "Failed to parse advertisement", "err", err)
 		return

dv/dv/advert_sync.go

@@ -11,6 +11,7 @@ import (
 	spec "github.com/named-data/ndnd/std/ndn/spec_2022"
 	spec_svs "github.com/named-data/ndnd/std/ndn/svs/v3"
 	"github.com/named-data/ndnd/std/object"
+	"github.com/named-data/ndnd/std/types/optional"
 	"github.com/named-data/ndnd/std/utils"
 )
 
@@ -70,7 +71,7 @@ func (a *advertModule) sendSyncInterestImpl(prefix enc.Name) (err error) {
 
 	// Make Data packet
 	dataCfg := &ndn.DataConfig{
-		ContentType: utils.IdPtr(ndn.ContentTypeBlob),
+		ContentType: optional.Some(ndn.ContentTypeBlob),
 	}
 	data, err := a.dv.engine.Spec().MakeData(syncName, dataCfg, sv.Encode(), signer)
 	if err != nil {
@@ -80,9 +81,9 @@ func (a *advertModule) sendSyncInterestImpl(prefix enc.Name) (err error) {
 
 	// Make SVS Sync Interest
 	intCfg := &ndn.InterestConfig{
-		Lifetime: utils.IdPtr(1 * time.Second),
+		Lifetime: optional.Some(1 * time.Second),
 		Nonce:    utils.ConvertNonce(a.dv.engine.Timer().Nonce()),
-		HopLimit: utils.IdPtr(uint(2)), // use localhop w/ this
+		HopLimit: utils.IdPtr(byte(2)), // use localhop w/ this
 	}
 	interest, err := a.dv.engine.Spec().MakeInterest(syncName, intCfg, data.Wire, nil)
 	if err != nil {
@@ -100,7 +101,7 @@ func (a *advertModule) sendSyncInterestImpl(prefix enc.Name) (err error) {
 
 func (a *advertModule) OnSyncInterest(args ndn.InterestHandlerArgs, active bool) {
 	// If there is no incoming face ID, we can't use this
-	if args.IncomingFaceId == nil {
+	if !args.IncomingFaceId.IsSet() {
 		log.Warn(a, "Received Sync Interest with no incoming face ID, ignoring")
 		return
 	}
@@ -112,7 +113,7 @@ func (a *advertModule) OnSyncInterest(args ndn.InterestHandlerArgs, active bool)
 	}
 
 	// Decode Sync Data
-	data, sigCov, err := spec.Spec{}.ReadData(enc.NewWireReader(args.Interest.AppParam()))
+	data, sigCov, err := spec.Spec{}.ReadData(enc.NewWireView(args.Interest.AppParam()))
 	if err != nil {
 		log.Warn(a, "Failed to parse Sync Data", "err", err)
 		return
@@ -131,14 +132,14 @@ func (a *advertModule) OnSyncInterest(args ndn.InterestHandlerArgs, active bool)
 
 			// Decode state vector
 			svWire := data.Content()
-			params, err := spec_svs.ParseSvsData(enc.NewWireReader(svWire), false)
+			params, err := spec_svs.ParseSvsData(enc.NewWireView(svWire), false)
 			if err != nil || params.StateVector == nil {
 				log.Warn(a, "Failed to parse StateVec", "err", err)
 				return
 			}
 
 			// Process the state vector
-			go a.onStateVector(params.StateVector, *args.IncomingFaceId, active)
+			go a.onStateVector(params.StateVector, args.IncomingFaceId.Unwrap(), active)
 		},
 	})
 }

dv/dv/mgmt.go

@@ -9,6 +9,7 @@ import (
 	"github.com/named-data/ndnd/std/ndn"
 	mgmt "github.com/named-data/ndnd/std/ndn/mgmt_2022"
 	sig "github.com/named-data/ndnd/std/security/signer"
+	"github.com/named-data/ndnd/std/types/optional"
 	"github.com/named-data/ndnd/std/utils"
 )
 
@@ -48,8 +49,8 @@ func (dv *Router) mgmtOnStatus(args ndn.InterestHandlerArgs) {
 
 	name := args.Interest.Name()
 	cfg := &ndn.DataConfig{
-		ContentType: utils.IdPtr(ndn.ContentTypeBlob),
-		Freshness:   utils.IdPtr(time.Second),
+		ContentType: optional.Some(ndn.ContentTypeBlob),
+		Freshness:   optional.Some(time.Second),
 	}
 
 	data, err := dv.engine.Spec().MakeData(name, cfg, status.Encode(), nil)
@@ -76,8 +77,8 @@ func (dv *Router) mgmtOnRib(args ndn.InterestHandlerArgs) {
 		data, err := dv.engine.Spec().MakeData(
 			args.Interest.Name(),
 			&ndn.DataConfig{
-				ContentType: utils.IdPtr(ndn.ContentTypeBlob),
-				Freshness:   utils.IdPtr(1 * time.Second),
+				ContentType: optional.Some(ndn.ContentTypeBlob),
+				Freshness:   optional.Some(1 * time.Second),
 			},
 			res.Encode(),
 			signer)
@@ -102,7 +103,7 @@ func (dv *Router) mgmtOnRib(args ndn.InterestHandlerArgs) {
 		return
 	}
 
-	params, err := mgmt.ParseControlParameters(enc.NewBufferReader(advC.Val), false)
+	params, err := mgmt.ParseControlParameters(enc.NewBufferView(advC.Val), false)
 	if err != nil || params.Val == nil || params.Val.Name == nil {
 		log.Warn(dv, "Failed to parse readvertised name", "err", err)
 		return
@@ -126,9 +127,9 @@ func (dv *Router) mgmtOnRib(args ndn.InterestHandlerArgs) {
 	res.Val.StatusText = "Readvertise command successful"
 	res.Val.Params = &mgmt.ControlArgs{
 		Name:   params.Val.Name,
-		FaceId: utils.IdPtr(uint64(1)), // NFD compatibility
-		Origin: utils.IdPtr(uint64(65)),
-		Cost:   utils.IdPtr(uint64(0)),
-		Flags:  utils.IdPtr(uint64(0)),
+		FaceId: optional.Some(uint64(1)), // NFD compatibility
+		Origin: optional.Some(uint64(65)),
+		Cost:   optional.Some(uint64(0)),
+		Flags:  optional.Some(uint64(0)),
 	}
 }

dv/dv/router.go

@@ -16,6 +16,7 @@ import (
 	"github.com/named-data/ndnd/std/security/keychain"
 	"github.com/named-data/ndnd/std/security/trust_schema"
 	ndn_sync "github.com/named-data/ndnd/std/sync"
+	"github.com/named-data/ndnd/std/types/optional"
 	"github.com/named-data/ndnd/std/utils"
 )
 
@@ -223,8 +224,8 @@ func (dv *Router) configureFace() (err error) {
 		Module: "faces",
 		Cmd:    "update",
 		Args: &mgmt.ControlArgs{
-			Mask:  utils.IdPtr(mgmt.FaceFlagLocalFieldsEnabled),
-			Flags: utils.IdPtr(mgmt.FaceFlagLocalFieldsEnabled),
+			Mask:  optional.Some(mgmt.FaceFlagLocalFieldsEnabled),
+			Flags: optional.Some(mgmt.FaceFlagLocalFieldsEnabled),
 		},
 		Retries: -1,
 	})
@@ -275,8 +276,8 @@ func (dv *Router) register() (err error) {
 			Cmd:    "register",
 			Args: &mgmt.ControlArgs{
 				Name:   prefix,
-				Cost:   utils.IdPtr(uint64(0)),
-				Origin: utils.IdPtr(config.NlsrOrigin),
+				Cost:   optional.Some(uint64(0)),
+				Origin: optional.Some(config.NlsrOrigin),
 			},
 			Retries: -1,
 		})
@@ -307,14 +308,14 @@ func (dv *Router) register() (err error) {
 // createFaces creates faces to all neighbors.
 func (dv *Router) createFaces() {
 	for i, neighbor := range dv.config.Neighbors {
-		var mtu *uint64 = nil
+		var mtu optional.Optional[uint64]
 		if neighbor.Mtu > 0 {
-			mtu = utils.IdPtr(neighbor.Mtu)
+			mtu = optional.Some(neighbor.Mtu)
 		}
 
 		faceId, created, err := dv.nfdc.CreateFace(&mgmt.ControlArgs{
-			Uri:             utils.IdPtr(neighbor.Uri),
-			FacePersistency: utils.IdPtr(uint64(mgmt.PersistencyPermanent)),
+			Uri:             optional.Some(neighbor.Uri),
+			FacePersistency: optional.Some(uint64(mgmt.PersistencyPermanent)),
 			Mtu:             mtu,
 		})
 		if err != nil {
@@ -333,9 +334,9 @@ func (dv *Router) createFaces() {
 			Cmd:    "register",
 			Args: &mgmt.ControlArgs{
 				Name:   dv.config.AdvertisementSyncActivePrefix(),
-				Cost:   utils.IdPtr(uint64(1)),
-				Origin: utils.IdPtr(config.NlsrOrigin),
-				FaceId: utils.IdPtr(faceId),
+				Cost:   optional.Some(uint64(1)),
+				Origin: optional.Some(config.NlsrOrigin),
+				FaceId: optional.Some(faceId),
 			},
 			Retries: 3,
 		})
@@ -351,14 +352,14 @@ func (dv *Router) destroyFaces() {
 
 		dv.engine.ExecMgmtCmd("rib", "unregister", &mgmt.ControlArgs{
 			Name:   dv.config.AdvertisementSyncActivePrefix(),
-			Origin: utils.IdPtr(config.NlsrOrigin),
-			FaceId: utils.IdPtr(neighbor.FaceId),
+			Origin: optional.Some(config.NlsrOrigin),
+			FaceId: optional.Some(neighbor.FaceId),
 		})
 
 		// only destroy faces that we created
 		if neighbor.Created {
 			dv.engine.ExecMgmtCmd("faces", "destroy", &mgmt.ControlArgs{
-				FaceId: utils.IdPtr(neighbor.FaceId),
+				FaceId: optional.Some(neighbor.FaceId),
 			})
 		}
 	}

dv/nfdc/nfdc.go

@@ -75,11 +75,11 @@ func (m *NfdMgmtThread) CreateFace(args *mgmt.ControlArgs) (uint64, bool, error)
 	// don't check error here, as the face may already exist (409)
 
 	res, ok := raw.(*mgmt.ControlResponse)
-	if !ok || res == nil || res.Val == nil || res.Val.Params == nil || res.Val.Params.FaceId == nil {
+	if !ok || res == nil || res.Val == nil || res.Val.Params == nil || !res.Val.Params.FaceId.IsSet() {
 		return 0, false, fmt.Errorf("failed to create face: %+v", err)
 	}
 
-	faceId := *res.Val.Params.FaceId
+	faceId := res.Val.Params.FaceId.Unwrap()
 	created := res.Val.StatusCode == 200
 
 	return faceId, created, nil

dv/table/fib.go

@@ -5,7 +5,7 @@ import (
 	"github.com/named-data/ndnd/dv/nfdc"
 	enc "github.com/named-data/ndnd/std/encoding"
 	mgmt "github.com/named-data/ndnd/std/ndn/mgmt_2022"
-	"github.com/named-data/ndnd/std/utils"
+	"github.com/named-data/ndnd/std/types/optional"
 )
 
 type FibEntry struct {
@@ -116,8 +116,8 @@ func (fib *Fib) UpdateH(nameH uint64, name enc.Name, newEntries []FibEntry) bool
 				Cmd:    "unregister",
 				Args: &mgmt.ControlArgs{
 					Name:   name,
-					FaceId: utils.IdPtr(oldEntry.FaceId),
-					Origin: utils.IdPtr(config.NlsrOrigin),
+					FaceId: optional.Some(oldEntry.FaceId),
+					Origin: optional.Some(config.NlsrOrigin),
 				},
 				Retries: 3,
 			})
@@ -138,9 +138,9 @@ func (fib *Fib) UpdateH(nameH uint64, name enc.Name, newEntries []FibEntry) bool
 			Cmd:    "register",
 			Args: &mgmt.ControlArgs{
 				Name:   name,
-				FaceId: utils.IdPtr(entry.FaceId),
-				Cost:   utils.IdPtr(entry.Cost),
-				Origin: utils.IdPtr(config.NlsrOrigin),
+				FaceId: optional.Some(entry.FaceId),
+				Cost:   optional.Some(entry.Cost),
+				Origin: optional.Some(config.NlsrOrigin),
 			},
 			Retries: 3,
 		})

dv/table/neighbor_table.go

@@ -9,7 +9,7 @@ import (
 	enc "github.com/named-data/ndnd/std/encoding"
 	"github.com/named-data/ndnd/std/log"
 	mgmt "github.com/named-data/ndnd/std/ndn/mgmt_2022"
-	"github.com/named-data/ndnd/std/utils"
+	"github.com/named-data/ndnd/std/types/optional"
 )
 
 type NeighborTable struct {
@@ -158,9 +158,9 @@ func (ns *NeighborState) routeRegister(faceId uint64) {
 			Cmd:    "register",
 			Args: &mgmt.ControlArgs{
 				Name:   route,
-				FaceId: utils.IdPtr(faceId),
-				Origin: utils.IdPtr(config.NlsrOrigin),
-				Cost:   utils.IdPtr(uint64(0)),
+				FaceId: optional.Some(faceId),
+				Origin: optional.Some(config.NlsrOrigin),
+				Cost:   optional.Some(uint64(0)),
 			},
 			Retries: 3,
 		})
@@ -188,8 +188,8 @@ func (ns *NeighborState) routeUnregister() {
 			Cmd:    "unregister",
 			Args: &mgmt.ControlArgs{
 				Name:   route,
-				FaceId: utils.IdPtr(ns.faceId),
-				Origin: utils.IdPtr(config.NlsrOrigin),
+				FaceId: optional.Some(ns.faceId),
+				Origin: optional.Some(config.NlsrOrigin),
 			},
 			Retries: 1,
 		})

dv/table/prefix_table.go

@@ -104,7 +104,7 @@ func (pt *PrefixTable) Withdraw(name enc.Name) {
 
 // Applies ops from a list. Returns if dirty.
 func (pt *PrefixTable) Apply(wire enc.Wire) (dirty bool) {
-	ops, err := tlv.ParsePrefixOpList(enc.NewWireReader(wire), true)
+	ops, err := tlv.ParsePrefixOpList(enc.NewWireView(wire), true)
 	if err != nil {
 		log.Warn(pt, "Failed to parse PrefixOpList", "err", err)
 		return false