libtpa: init

libtpa(Transport Protocol Acceleration) is a DPDK based userspace tcp
stack implementation.

Check README and docs for more information.

Signed-off-by: Yuanhan Liu <[email protected]>

.gitignore

@@ -0,0 +1,9 @@
+*.swp
+GPATH
+GRTAGS
+GTAGS
+perf.data*
+version.h
+build-info.h
+core
+build

CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contribution
+
+You can either send us a GitHub pull request, or send patches to the [mailing
+list](https://groups.google.com/g/libtpa), [email protected]. Note that
+it's encouraged to send emails though.
+
+# Coding Style
+Libtpa basically follows the [DPDK coding style](https://doc.dpdk.org/guides/contributing/coding_style.html),
+with a noticeable exception on function definition: the function type
+should not be on a line by itself. For example:
+
+```c
+static char *function(int a1, int a2, float fl, int a4)
+{
+```

LICENSE

@@ -0,0 +1,11 @@
+Copyright (c) 2021-2023 ByteDance Ltd. and/or its Affiliates
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -0,0 +1,90 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2021-2023, ByteDance Ltd. and/or its Affiliates
+# Author: Yuanhan Liu <[email protected]>
+
+MAKEFLAGS += --no-print-directory
+
+export TPA_VERSION   = 1.0-rc0
+export BUILD_MODE   ?= release
+export DPDK_VERSION ?= v20.11.3
+export NIC_TYPE     ?= mlnx
+
+include buildtools/vars.mk
+
+SUBDIRS = lib src test tools tpad app
+
+.PHONY: all install clean distclean $(SUBDIRS) dpdk gtags scan-build so summary static
+
+all: summary $(SUBDIRS)
+
+$(SUBDIRS):
+	$(MAKE) -C $@
+
+test tools app: src lib
+lib src: dpdk
+tpad: tools lib
+tools app: static
+
+dpdk:
+	$(Q)bash ./buildtools/build-dpdk.sh
+
+$(LIBTPA_SO): src lib
+	$(Q)echo "  LD $(notdir $@)"
+	$(Q)$(CC) -shared -o $@ -L$(DPDK_LD_PATH)			\
+	     -Wl,--whole-archive					\
+	     $(OBJ_ROOT)/src/tpa-core.a				\
+	     $(OBJ_ROOT)/lib/tpa-lib.a				\
+	     $(DPDK_LD_PATH)/librte_*.a					\
+	     -Wl,--no-whole-archive					\
+	     $(LDFLAGS)
+	$(Q)bash ./buildtools/gen-pkg-config-file
+
+so: $(LIBTPA_SO)
+
+static: src lib
+	$(Q)echo "  AR libtpa.a"
+	$(Q)echo create $(LIBTPA_A)                >  /tmp/tpa.mri
+	$(Q)echo addlib $(OBJ_ROOT)/src/tpa-core.a >> /tmp/tpa.mri
+	$(Q)echo addlib $(OBJ_ROOT)/lib/tpa-lib.a  >> /tmp/tpa.mri
+	$(Q)for i in $(DPDK_LD_PATH)/librte_*.a; do \
+		echo addlib $$i			   >> /tmp/tpa.mri; \
+	done
+	$(Q)echo save 				   >> /tmp/tpa.mri
+	$(Q)ar -M < /tmp/tpa.mri
+	$(Q)bash ./buildtools/gen-pkg-config-file
+
+summary: $(SUBDIRS) static
+	$(Q)echo ":: built $(shell buildtools/get-ver.sh): mode=$(BUILD_MODE) dpdk=$(DPDK_VERSION)"
+
+install: $(SUBDIRS) static
+	$(Q)echo "  INSTALL -> $(INSTALL_ROOT)"
+	$(Q)mkdir -p $(INSTALL_ROOT)
+	$(Q)echo $(shell buildtools/get-ver.sh) > $(INSTALL_ROOT)/version
+	$(Q)install $(BUILD_ROOT)/libtpa*   $(INSTALL_ROOT)
+	$(Q)install $(BIN_ROOT)/app/*          $(INSTALL_ROOT)
+	$(Q)install $(BIN_ROOT)/tpad/*      $(INSTALL_ROOT)
+	$(Q)install $(BIN_ROOT)/tools/*        $(INSTALL_ROOT)
+	$(Q)install $(SRC_ROOT)/include/api/*  $(INSTALL_ROOT)
+	$(Q)install $(BIN_ROOT)/tools/tpa   /usr/bin/tpa
+	$(Q)install $(BIN_ROOT)/app/*          /usr/bin
+	$(Q)install $(BUILD_ROOT)/libtpa.pc /usr/share/pkgconfig
+
+scan-build: clean
+	scan-build make
+
+gtags:
+	git ls-files | gtags -f -
+
+html:
+	sphinx-build doc build/html
+
+html_pub:
+	sphinx-build doc /var/www/html/libtpa-doc
+
+clean:
+	$(Q)echo "  CLEAN"
+	$(Q)rm -rf $(BIN_ROOT) $(OBJ_ROOT) $(LIBTPA_A) $(LIBTPA_SO)
+
+distclean:
+	$(Q)echo "  DISTCLEAN"
+	$(Q)rm -rf $(BUILD_ROOT)

README.md

@@ -0,0 +1,67 @@
+Libtpa(Transport Protocol Acceleration) is a DPDK based userspace TCP
+stack implementation.
+
+Libtpa is fast. It boosts the [redis benchmark](doc/redis.rst) performance
+more than 5 times, from 0.21m rps to 1.14m rps. Meanwhile, the p99 latency
+is greatly decreased, from 0.815ms to 0.159ms.
+
+Libtpa is also sort of stable, all kudos to the comprehensive testing.
+Libtpa has more than 200 tests. Together with the testing arguments
+matrix, it can result in a big variety of test cases. Therefore,
+most of the bugs are captured before deployment.
+
+:warning: Although libtpa has been tested heavily inside Bytedance **data center**,
+it's still recommended to run as much testing as you can before deployment,
+for libtpa is still under active development and it's just v1.0-**rc0**
+being released. Tons of changes have been made since the last stable release.
+
+# Embedded TCP Stack
+
+There are two things that might be kind of special about libtpa.
+
+The first one is that libtpa is an embedded TCP stack implementation that
+supports run-to-completion mode only. It creates no datapath thread
+by itself. Instead, it's embedded in the application thread.
+
+# Acceleration for Specific TCP Connections
+
+The other special thing about libtpa is that it's not a standalone
+TCP/IP stack implementation. Instead, it lives together with the host
+TCP/IP stack: libtpa just takes control of the specific TCP connections
+needed to be accelerated. Taking redis as an example, if redis is
+accelerated by libtpa, then all TCP connections belonging to redis will
+go to libtpa.  All other connections (TCP or none TCP, such as UDP)
+go to where it belongs: the host stack.
+
+There is a huge advantage about that. If libtpa crashes, except the
+application accelerated by libtpa is affected, none other workloads
+would be affected.
+
+Having said that, it requires some special support from NIC. Section
+Requirements gives a bit more information about that.
+
+# Requirements
+
+Due to the novel design described above (to just accelerate some specific
+TCP connections), libtpa requires [flow bifurcation](https://doc.dpdk.org/guides/howto/flow_bifurcation.html) support from NIC.
+
+Most NICs have flow bifurcation support with the help of SR-IOV.
+But they require some internal DPDK/Linux patches (or even firmwares)
+to satisfy the libtpa needs.
+
+On the other hand, Mellanox NIC has native flow bifurcation support
+that doesn't require SR-IOV. More importantly, it doesn't require any
+internal stuff. Libtpa works well with Mellanox NIC just with the
+upstream DPDK.
+
+Therefore, libtpa currently only supports Mellanox NIC.
+
+# What's Next
+
+You might want to check below docs for more detailed information:
+
+-  [quick start guide](doc/quick_start.rst)
+-  [user guide](doc/user_guide.rst)
+-  [programming guide](doc/prog_guide.rst)
+-  [contribution guide](CONTRIBUTING.md)
+-  [internals](doc/internals.rst)

app/Makefile

@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2021-2023, ByteDance Ltd. and/or its Affiliates
+# Author: Yuanhan Liu <[email protected]>
+
+SUBDIRS = swing techo tperf
+
+.PHONY: all $(SUBDIRS)
+
+all: $(SUBDIRS)
+
+$(SUBDIRS):
+	$(MAKE) -C $@

app/app.mk

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2021-2023, ByteDance Ltd. and/or its Affiliates
+# Author: Yuanhan Liu <[email protected]>
+
+PKG_CONFIG = PKG_CONFIG_PATH=$(SRC_ROOT)/build pkg-config
+
+CFLAGS += -I$(SRC_ROOT)/include/lib -Iinclude
+CFLAGS += $(shell $(PKG_CONFIG) --cflags libtpa-internal)
+
+LDFLAGS := $(shell $(PKG_CONFIG) --libs --static libtpa-internal)
+LDFLAGS += -lm
+
+OBJ_DIR = $(OBJ_ROOT)/app/$(APP)
+BIN_DIR = $(BIN_ROOT)/app
+
+OBJS = $(SRCS:%.c=$(OBJ_DIR)/%.o)
+DEPS = $(SRCS:%.c=$(OBJ_DIR)/%.d)
+
+BIN = $(BIN_DIR)/$(APP)
+
+all: $(BIN)
+
+$(BIN): $(OBJS) | OUT_DIRS
+	$(Q)echo "  LD $(notdir $@)"
+	$(Q)$(CC) $^ -o $@ $(LDFLAGS)
+
+$(OBJS): $(OBJ_DIR)/%.o: %.c | OUT_DIRS
+	$(Q)echo "  CC $(notdir $@)"
+	$(Q)$(CC) $(CFLAGS) -MMD -MP -c $< -o $@
+
+OUT_DIRS:
+	$(Q)mkdir -p $(OBJ_DIR) $(BIN_DIR)

app/swing/Makefile

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2021-2023, ByteDance Ltd. and/or its Affiliates
+# Author: Yuanhan Liu <[email protected]>
+
+SRCS := swing.c
+APP  := swing
+
+include ../app.mk