Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename UPF-EPC to UPF #530

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .fossa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ version: 2
cli:
server: https://app.fossa.com
fetcher: custom
project: upf-epc
project: upf
analyze:
modules:
- name: upf-epc
- name: upf
type: raw
target: ../upf-epc
path: ../upf-epc
target: ../upf
path: ../upf
2 changes: 1 addition & 1 deletion .github/workflows/manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ on:
jobs:
build:
env:
REPO: "ghcr.io/omec-project/upf-epc/bess_build"
REPO: "ghcr.io/omec-project/upf/bess_build"
TAG: "latest"
BESS_DPDK_BRANCH: "dpdk-2011-focal"
DOCKER_PULL: ""
Expand Down
4 changes: 2 additions & 2 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: upf-epc
Upstream-Name: upf
Upstream-Contact: OMEC Developers <omec-dev@opennetworking.org>
Source: https://github.com/omec-project/upf-epc
Source: https://github.com/omec-project/upf

Files: pfcpiface/**/*.pb.go
Copyright: 2016-2017, Nefeli Networks, Inc.
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Multi-stage Dockerfile

# Stage bess-deps: fetch BESS dependencies
FROM ghcr.io/omec-project/upf-epc/bess_build AS bess-deps
FROM ghcr.io/omec-project/upf/bess_build AS bess-deps
# BESS pre-reqs
WORKDIR /bess
ARG BESS_COMMIT=dpdk-2011-focal
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ docker-build:
DOCKER_BUILDKIT=$(DOCKER_BUILDKIT) docker build $(DOCKER_PULL) $(DOCKER_BUILD_ARGS) \
--target $$target \
--tag ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}upf-epc-$$target:${DOCKER_TAG} \
--label org.opencontainers.image.source="https://github.com/omec-project/upf-epc" \
--label org.opencontainers.image.source="https://github.com/omec-project/upf" \
--label org.label.schema.version="${VERSION}" \
--label org.label.schema.vcs.url="${DOCKER_LABEL_VCS_URL}" \
--label org.label.schema.vcs.ref="${DOCKER_LABEL_VCS_REF}" \
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ SPDX-License-Identifier: Apache-2.0
Copyright 2019 Intel Corporation
-->

# upf-epc
# upf

[![Go Report Card](https://goreportcard.com/badge/github.com/omec-project/upf-epc)](https://goreportcard.com/report/github.com/omec-project/upf-epc)
[![Go Report Card](https://goreportcard.com/badge/github.com/omec-project/upf)](https://goreportcard.com/report/github.com/omec-project/upf)

[![Build Status](https://jenkins.onosproject.org/buildStatus/icon?job=bess-upf-linerate-tests&subject=Linerate+Tests)](https://jenkins.onosproject.org/job/bess-upf-linerate-tests/)

## Overview

UPF-EPC is a revised version of [ngic-rtc](https://github.com/omec-project/ngic-rtc/tree/central-cp-multi-upfs)'s [dp](https://github.com/omec-project/ngic-rtc/tree/central-cp-multi-upfs/dp).
UPF is a revised version of [ngic-rtc](https://github.com/omec-project/ngic-rtc/tree/central-cp-multi-upfs)'s [dp](https://github.com/omec-project/ngic-rtc/tree/central-cp-multi-upfs/dp).
It works seamlessly with all NFs available in the omec-project's EPC. Like ngic-rtc's dp, it communicates with [cp](https://github.com/omec-project/ngic-rtc/tree/central-cp-multi-upfs/cp) and
conforms to Control User Plane Separated (CUPS) architecture. The prototype is based on the 3GPP TS23501 specifications of EPC and functions as a co-located Service
and Packet Gateway (SPGW-U). This branch is compatible with Aether's control plane.
Expand Down Expand Up @@ -90,4 +90,4 @@ https://user-images.githubusercontent.com/6157640/133918985-c36d4668-4e98-4866-8

## Installation

Please see [INSTALL.md](docs/INSTALL.md) for details on how to set up CP and UPF-EPC.
Please see [INSTALL.md](docs/INSTALL.md) for details on how to set up CP and UPF.
2 changes: 1 addition & 1 deletion cmd/pfcpiface/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ package main

import (
"flag"
"github.com/omec-project/upf-epc/pfcpiface"
"github.com/omec-project/upf/pfcpiface"
log "github.com/sirupsen/logrus"
)

Expand Down
2 changes: 1 addition & 1 deletion core/modules/qos.cc
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ void Qos::ProcessBatch(Context *ctx, bess::PacketBatch *batch) {
// meter if ogate is 0
if (ogate == METER_GATE) {
if (val[j]->p->cir_period == 0 || val[j]->p->pir_period == 0) {
// FIXME: https://github.com/omec-project/upf-epc/issues/376
// FIXME: https://github.com/omec-project/upf/issues/376
DLOG(INFO) << "Detected pir/cir_period zero in rte_meter_trtcm_profile,"
<< " BUG? Setting METER_GREEN_GATE to prevent crash"
<< std::endl;
Expand Down
8 changes: 4 additions & 4 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ SPDX-License-Identifier: Apache-2.0
Copyright 2019 Intel Corporation
-->

# UPF-EPC - Installation Instructions
# UPF - Installation Instructions

## Pre-reqs

Expand All @@ -17,7 +17,7 @@ You need the following dependencies.
* Update [`scripts/docker_setup.sh`](../scripts/docker_setup.sh) and [`conf/up4.bess`](../conf/up4.bess) to run pktgen tests
* Update [`scripts/docker_setup.sh`](../scripts/docker_setup.sh) and [`conf/up4.bess`](../conf/up4.bess) to run sim mode tests

>`scripts/docker_setup.sh` is a quick start guide to set up UPF-EPC for evaluation.
>`scripts/docker_setup.sh` is a quick start guide to set up UPF for evaluation.

## Run

Expand Down Expand Up @@ -81,14 +81,14 @@ localhost:10514 $ tcpdump gtpuEncap out 1 -c 128 -w conf/gtpuEncapOut.pcap

#### Simulation mode

UPF-EPC has a simulation mode that enables testing the pipeline on a single machine,
UPF has a simulation mode that enables testing the pipeline on a single machine,
without the need for external interfaces.

> Note: This mode does not support multiple workers currently.

![ubench-sim](images/ubench-sim.svg)

To start UPF-EPC in simulation mode:
To start UPF in simulation mode:

1. Enable sim mode in configuration files

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Copyright 2022 Open Networking Foundation

## Testing local Go dependencies

The `upf-epc` repository relies on some external Go dependencies, which are not mature yet (e.g. pfcpsim or p4runtime-go-client).
The `upf` repository relies on some external Go dependencies, which are not mature yet (e.g. pfcpsim or p4runtime-go-client).
It's often needed to extend those dependencies first, before adding a new feature to the PFCP Agent. However, when using Go modules and Dockerized environment,
it's hard to test WIP changes to local dependencies. Therefore, this repository come up with a way to use Go vendoring, instead of Go modules, for development purposes.

Expand All @@ -25,5 +25,5 @@ DOCKER_BUILD_ARGS="--build-arg GOFLAGS=-mod=vendor" make docker-build
To run E2E integration tests with the local dependency:

```
DOCKER_BUILD_ARGS="--build-arg GOFLAGS=-mod=vendor" make test-up4-integration
DOCKER_BUILD_ARGS="--build-arg GOFLAGS=-mod=vendor" make test-up4-integration
```
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/omec-project/upf-epc
module github.com/omec-project/upf

go 1.13

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,23 @@ index 9e1b79a3..9b30de34 100644
--- a/protobuf/bess_msg.proto
+++ b/protobuf/bess_msg.proto
@@ -42,6 +42,8 @@ import "error.proto";

package bess.pb;
+option go_package = "github.com/omec-project/upf-epc/pfcpiface/bess_pb";

+option go_package = "github.com/omec-project/upf/pfcpiface/bess_pb";
+
message EmptyRequest {
}

diff --git a/protobuf/error.proto b/protobuf/error.proto
index a018ee8e..04b352c5 100644
--- a/protobuf/error.proto
+++ b/protobuf/error.proto
@@ -31,6 +31,8 @@ syntax = "proto3";

package bess.pb;
+option go_package = "github.com/omec-project/upf-epc/pfcpiface/bess_pb";

+option go_package = "github.com/omec-project/upf/pfcpiface/bess_pb";
+
message Error {
int32 code = 1; // 0 for success, errno (>0) for failure
Expand All @@ -48,23 +48,23 @@ index e00a463a..23d3fc18 100644
+++ b/protobuf/module_msg.proto
@@ -31,6 +31,9 @@
syntax = "proto3";

package bess.pb;
+
+option go_package = "github.com/omec-project/upf-epc/pfcpiface/bess_pb";
+option go_package = "github.com/omec-project/upf/pfcpiface/bess_pb";
+
import "util_msg.proto";

// Module-specific messages.
diff --git a/protobuf/ports/port_msg.proto b/protobuf/ports/port_msg.proto
index ff6e65ed..3e2cff2b 100644
--- a/protobuf/ports/port_msg.proto
+++ b/protobuf/ports/port_msg.proto
@@ -31,6 +31,8 @@ syntax = "proto3";

package bess.pb;
+option go_package = "github.com/omec-project/upf-epc/pfcpiface/bess_pb";

+option go_package = "github.com/omec-project/upf/pfcpiface/bess_pb";
+
message PCAPPortArg {
string dev = 1;
Expand All @@ -74,27 +74,27 @@ index ae1aba05..706a283a 100644
--- a/protobuf/service.proto
+++ b/protobuf/service.proto
@@ -33,6 +33,8 @@ import "bess_msg.proto";

package bess.pb;
+option go_package = "github.com/omec-project/upf-epc/pfcpiface/bess_pb";

+option go_package = "github.com/omec-project/upf/pfcpiface/bess_pb";
+
service BESSControl {

// -------------------------------------------------------------------------
diff --git a/protobuf/util_msg.proto b/protobuf/util_msg.proto
index b1050abf..4df01fc6 100644
--- a/protobuf/util_msg.proto
+++ b/protobuf/util_msg.proto
@@ -32,6 +32,8 @@ syntax="proto3";

package bess.pb;
+option go_package = "github.com/omec-project/upf-epc/pfcpiface/bess_pb";

+option go_package = "github.com/omec-project/upf/pfcpiface/bess_pb";
+
/// The Field message represents one field in a packet -- either stored in metadata or in the packet body.
message Field {
oneof position {
--
--
2.25.1

2 changes: 1 addition & 1 deletion pfcpiface/bess.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (

"google.golang.org/grpc/credentials/insecure"

pb "github.com/omec-project/upf-epc/pfcpiface/bess_pb"
pb "github.com/omec-project/upf/pfcpiface/bess_pb"
"github.com/prometheus/client_golang/prometheus"
log "github.com/sirupsen/logrus"
"github.com/wmnsk/go-pfcp/ie"
Expand Down
2 changes: 1 addition & 1 deletion pfcpiface/conn.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
log "github.com/sirupsen/logrus"
"github.com/wmnsk/go-pfcp/ie"

"github.com/omec-project/upf-epc/pfcpiface/metrics"
"github.com/omec-project/upf/pfcpiface/metrics"
)

const (
Expand Down
2 changes: 1 addition & 1 deletion pfcpiface/messages.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
log "github.com/sirupsen/logrus"
"github.com/wmnsk/go-pfcp/message"

"github.com/omec-project/upf-epc/pfcpiface/metrics"
"github.com/omec-project/upf/pfcpiface/metrics"
)

var errMsgUnexpectedType = errors.New("unable to parse message as type specified")
Expand Down
2 changes: 1 addition & 1 deletion pfcpiface/node.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
reuse "github.com/libp2p/go-reuseport"
log "github.com/sirupsen/logrus"

"github.com/omec-project/upf-epc/pfcpiface/metrics"
"github.com/omec-project/upf/pfcpiface/metrics"
)

// PFCPNode represents a PFCP endpoint of the UPF.
Expand Down
2 changes: 1 addition & 1 deletion pfcpiface/sessions.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"fmt"
"sync"

"github.com/omec-project/upf-epc/pfcpiface/metrics"
"github.com/omec-project/upf/pfcpiface/metrics"
)

type notifyFlag struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/bessmock/bessmock.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package bessmock

import (
"fmt"
"github.com/omec-project/upf-epc/pfcpiface/bess_pb"
"github.com/omec-project/upf/pfcpiface/bess_pb"
"google.golang.org/grpc"
"net"
)
Expand Down
2 changes: 1 addition & 1 deletion pkg/bessmock/bin.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package bessmock

import (
"context"
"github.com/omec-project/upf-epc/pfcpiface/bess_pb"
"github.com/omec-project/upf/pfcpiface/bess_pb"
)

// The methods below are not used by BESS-UPF - we can leave them unimplemented
Expand Down
2 changes: 1 addition & 1 deletion pkg/bessmock/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package bessmock

import (
"context"
"github.com/omec-project/upf-epc/pfcpiface/bess_pb"
"github.com/omec-project/upf/pfcpiface/bess_pb"
)

type bessService struct {
Expand Down
8 changes: 4 additions & 4 deletions ptf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ high-speed traffic generator built on top of DPDK, containing a Python API

## Overview

The aim of implementing a test framework for UPF-EPC is to create a
The aim of implementing a test framework for UPF is to create a
developer-friendly infrastructure for creating either single-packet or
high-speed tests that assess UPF features at a component level.

Expand Down Expand Up @@ -57,12 +57,12 @@ API](https://github.com/cisco-system-traffic-generator/trex-core/blob/master/doc
downlink traffic from 10,000 unique UEs.

## Workflow
Tests require two separate machines to run, since both TRex and UPF-EPC
Tests require two separate machines to run, since both TRex and UPF
use DPDK. Currently, the test workflow is as such:

![Test](docs/test-run.svg)

In **step 1**, rules are installed onto the UPF-EPC instance by the test
In **step 1**, rules are installed onto the UPF instance by the test
framework via BESS gRPC messages.

In **step 2**, TRex or Scapy (depending on the type of test case)
Expand All @@ -72,7 +72,7 @@ In **step 3**, traffic routes through the UPF and back to the machine
hosting TRex, where results are asserted.

## Steps to run tests
The run script assumes that the TRex daemon server and the UPF-EPC
The run script assumes that the TRex daemon server and the UPF
instance are already running on their respective machines. It also
assumes that all config files in `config/` are configured correctly to
route traffic to the UPF.
Expand Down
2 changes: 1 addition & 1 deletion test/integration/basic_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"time"

"github.com/omec-project/pfcpsim/pkg/pfcpsim/session"
"github.com/omec-project/upf-epc/test/integration/providers"
"github.com/omec-project/upf/test/integration/providers"
"github.com/stretchr/testify/require"
"github.com/wmnsk/go-pfcp/ie"
)
Expand Down
2 changes: 1 addition & 1 deletion test/integration/conf.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package integration

import (
"github.com/omec-project/upf-epc/pfcpiface"
"github.com/omec-project/upf/pfcpiface"
"github.com/sirupsen/logrus"
"os"
"runtime"
Expand Down
6 changes: 3 additions & 3 deletions test/integration/framework.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import (
"encoding/json"
"errors"
"github.com/omec-project/pfcpsim/pkg/pfcpsim"
"github.com/omec-project/upf-epc/pfcpiface"
"github.com/omec-project/upf-epc/pkg/bessmock"
"github.com/omec-project/upf-epc/test/integration/providers"
"github.com/omec-project/upf/pfcpiface"
"github.com/omec-project/upf/pkg/bessmock"
"github.com/omec-project/upf/test/integration/providers"
p4_v1 "github.com/p4lang/p4runtime/go/p4/v1"
"github.com/prometheus/client_golang/prometheus"
"github.com/sirupsen/logrus"
Expand Down
2 changes: 1 addition & 1 deletion test/integration/verify.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (

p4rtc "github.com/antoninbas/p4runtime-go-client/pkg/client"
"github.com/antoninbas/p4runtime-go-client/pkg/util/conversion"
"github.com/omec-project/upf-epc/test/integration/providers"
"github.com/omec-project/upf/test/integration/providers"
p4_v1 "github.com/p4lang/p4runtime/go/p4/v1"
"github.com/stretchr/testify/require"
)
Expand Down