shortcut-fe: splite to 2 packges and rip off ipv6

package/lean/fast-classifier/Makefile

@@ -0,0 +1,91 @@
+include $(TOPDIR)/rules.mk
+include $(INCLUDE_DIR)/kernel.mk
+
+PKG_NAME:=fast-classifier
+PKG_RELEASE:=1
+
+include $(INCLUDE_DIR)/package.mk
+
+define KernelPackage/$(PKG_NAME)/Default
+  SECTION:=kernel
+  CATEGORY:=Kernel modules
+  SUBMENU:=Network Support
+  DEPENDS:=+kmod-ipt-conntrack +kmod-shortcut-fe
+  TITLE:=Kernel driver for FAST Classifier
+  FILES:=$(PKG_BUILD_DIR)/fast-classifier.ko
+  KCONFIG:=CONFIG_NF_CONNTRACK_CHAIN_EVENTS=y CONFIG_NF_CONNTRACK_MARK=y
+  PROVIDES:=$(PKG_NAME)
+endef
+
+define KernelPackage/$(PKG_NAME)
+  $(call KernelPackage/$(PKG_NAME)/Default)
+endef
+
+define KernelPackage/$(PKG_NAME)-noload
+  $(call KernelPackage/$(PKG_NAME)/Default)
+endef
+
+define KernelPackage/$(PKG_NAME)/Default/description
+FAST Classifier talks to SFE to make decisions about offloading connections
+endef
+
+define KernelPackage/$(PKG_NAME)/description
+$(call KernelPackage/$(PKG_NAME)/Default/description)
+endef
+
+define KernelPackage/$(PKG_NAME)-noload/description
+$(call KernelPackage/$(PKG_NAME)/Default/description)
+
+This package does not load $(PKG_NAME) at boot by default
+endef
+
+define Package/fast-classifier-example
+  TITLE:=Example user space program for fast-classifier
+  DEPENDS:=+libnl +kmod-fast-classifier
+endef
+
+define Package/fast-classifier-example/description
+Example user space program that communicates with fast
+classifier kernel module
+endef
+
+SFE_MAKE_OPTS:=SFE_SUPPORT_IPV6=y
+
+define Build/Compile/kmod
+	+$(MAKE) $(PKG_JOBS) -C "$(LINUX_DIR)" $(strip $(SFE_MAKE_OPTS)) \
+		$(KERNEL_MAKE_FLAGS) \
+		$(PKG_MAKE_FLAGS) \
+		M="$(PKG_BUILD_DIR)" \
+		CONFIG_FAST_CLASSIFIER=m \
+		EXTRA_CFLAGS="$(EXTRA_CFLAGS)" \
+		modules
+endef
+
+define Build/Compile/example
+	$(TARGET_CC) -o $(PKG_BUILD_DIR)/userspace_fast_classifier \
+		-I $(PKG_BUILD_DIR) \
+		-I$(STAGING_DIR)/usr/include/libnl \
+		-I$(STAGING_DIR)/usr/include/libnl3 \
+		-lnl-genl-3 -lnl-3 \
+		$(PKG_BUILD_DIR)/nl_classifier_test.c
+endef
+
+define Build/Compile
+	$(Build/Compile/kmod)
+	$(if $(CONFIG_PACKAGE_fast-classifier-example),$(Build/Compile/example))
+endef
+
+define Build/InstallDev
+	$(INSTALL_DIR) $(1)/usr/include
+	$(CP) $(PKG_BUILD_DIR)/fast-classifier.h $(1)/usr/include/
+endef
+
+
+define Package/fast-classifier-example/install
+	$(INSTALL_DIR) $(1)/sbin
+	$(CP) $(PKG_BUILD_DIR)/userspace_fast_classifier $(1)/sbin/
+endef
+
+$(eval $(call KernelPackage,$(PKG_NAME)))
+$(eval $(call KernelPackage,$(PKG_NAME)-noload))
+$(eval $(call BuildPackage,fast-classifier-example))

package/lean/fast-classifier/src/Makefile

@@ -0,0 +1,10 @@
+obj-$(CONFIG_FAST_CLASSIFIER) += fast-classifier.o
+
+ifeq ($(SFE_SUPPORT_IPV6),)
+SFE_SUPPORT_IPV6=y
+endif
+ccflags-$(SFE_SUPPORT_IPV6) += -DSFE_SUPPORT_IPV6
+
+ccflags-y += -I$(obj)/../shortcut-fe
+
+obj ?= .

package/lean/fast-classifier/src/fast-classifier.c

@@ -36,12 +36,11 @@
 #include <linux/hashtable.h>
 #include <linux/version.h>
 
-#include "sfe_backport.h"
-#include "sfe.h"
-#include "sfe_cm.h"
+#include <sfe_backport.h>
+#include <sfe.h>
+#include <sfe_cm.h>
 #include "fast-classifier.h"
 
-
 typedef enum fast_classifier_exception {
 	FAST_CL_EXCEPTION_PACKET_BROADCAST,
 	FAST_CL_EXCEPTION_PACKET_MULTICAST,
@@ -197,7 +196,7 @@ static atomic_t done_fail_msgs = ATOMIC_INIT(0);
  * 	only implement ingress for now, because for egress we
  * 	want to have the bridge devices qdiscs be used.
  */
-static bool skip_to_bridge_ingress=1;
+static bool skip_to_bridge_ingress;
 
 /*
  * fast_classifier_incr_exceptions()

package/lean/shortcut-fe/Makefile

@@ -15,7 +15,7 @@ include $(TOPDIR)/rules.mk
 include $(INCLUDE_DIR)/kernel.mk
 
 PKG_NAME:=shortcut-fe
-PKG_RELEASE:=10
+PKG_RELEASE:=2
 
 include $(INCLUDE_DIR)/package.mk
 
@@ -23,17 +23,27 @@ define KernelPackage/shortcut-fe
   SECTION:=kernel
   CATEGORY:=Kernel modules
   SUBMENU:=Network Support
-  DEPENDS:=@IPV6
+  DEPENDS:=
   TITLE:=Kernel driver for SFE
   FILES:=$(PKG_BUILD_DIR)/shortcut-fe.ko $(PKG_BUILD_DIR)/shortcut-fe-ipv6.ko
-  KCONFIG:=CONFIG_NF_CONNTRACK_EVENTS=y CONFIG_SHORTCUT_FE=y 
-  AUTOLOAD:=$(call AutoProbe,shortcut-fe shortcut-fe-ipv6)
+  KCONFIG:=CONFIG_NF_CONNTRACK_EVENTS=y \
+	   CONFIG_NF_CONNTRACK_TIMEOUT=y \
+	   CONFIG_SHORTCUT_FE=y \
+	   CONFIG_XFRM=y
+  AUTOLOAD:=$(call AutoLoad,09,shortcut-fe shortcut-fe-ipv6)
 endef
 
 define KernelPackage/shortcut-fe/Description
 Shortcut is an in-Linux-kernel IP packet forwarding engine.
 endef
 
+define KernelPackage/shortcut-fe/install
+	$(INSTALL_DIR) $(1)/etc/init.d
+	$(INSTALL_BIN) ./files/etc/init.d/shortcut-fe $(1)/etc/init.d
+	$(INSTALL_DIR) $(1)/usr/bin
+	$(INSTALL_BIN) ./files/usr/bin/sfe_dump $(1)/usr/bin
+endef
+
 define KernelPackage/shortcut-fe-cm
   SECTION:=kernel
   CATEGORY:=Kernel modules
@@ -41,81 +51,31 @@ define KernelPackage/shortcut-fe-cm
   DEPENDS:=+kmod-ipt-conntrack +kmod-shortcut-fe
   TITLE:=Kernel driver for SFE
   FILES:=$(PKG_BUILD_DIR)/shortcut-fe-cm.ko
-  KCONFIG:=CONFIG_NF_CONNTRACK_CHAIN_EVENTS=y CONFIG_NF_CONNTRACK_MARK=y
-  AUTOLOAD:=$(call AutoProbe,shortcut-fe-cm)
+  KCONFIG:=CONFIG_NF_CONNTRACK_CHAIN_EVENTS=y
 endef
 
 define KernelPackage/shortcut-fe-cm/Description
 Simple connection manager for the Shortcut forwarding engine.
 endef
 
-define KernelPackage/fast-classifier
-  SECTION:=kernel
-  CATEGORY:=Kernel modules
-  SUBMENU:=Network Support
-  DEPENDS:=+kmod-ipt-conntrack +kmod-shortcut-fe
-  TITLE:=Kernel driver for FAST Classifier
-  FILES:=$(PKG_BUILD_DIR)/fast-classifier.ko
-  KCONFIG:=CONFIG_NF_CONNTRACK_CHAIN_EVENTS=y CONFIG_NF_CONNTRACK_MARK=y
-  AUTOLOAD:=$(call AutoLoad,z,fast-classifier)
-  PROVIDES:=$(PKG_NAME)
-endef
-
-define KernelPackage/fast-classifier/description
-FAST Classifier connection manager for Shortcut forwarding engine. 
-It talks to SFE to make decisions about offloading connections.
-endef
-
-define Package/fast-classifier-example
-  TITLE:=Example user space program for fast-classifier
-  DEPENDS:=+libnl +kmod-fast-classifier
-endef
-
-define Package/fast-classifier-example/description
-Example user space program that communicates with fast
-classifier kernel module
-endef
-
-MAKE_OPTS:= \
-		ARCH="$(LINUX_KARCH)" \
-		CROSS_COMPILE="$(TARGET_CROSS)" \
-		M="$(PKG_BUILD_DIR)" \
-		EXTRA_CFLAGS="$(EXTRA_CFLAGS)"
+EXTRA_CFLAGS+=-DSFE_SUPPORT_IPV6
 
 define Build/Compile
-	$(MAKE) -C "$(LINUX_DIR)" \
-		$(MAKE_OPTS) \
+	+$(MAKE) $(PKG_JOBS) -C "$(LINUX_DIR)" \
+		$(KERNEL_MAKE_FLAGS) \
+		$(PKG_MAKE_FLAGS) \
+		M="$(PKG_BUILD_DIR)" \
+		EXTRA_CFLAGS="$(EXTRA_CFLAGS)" \
+		SFE_SUPPORT_IPV6=1 \
 		modules
-	$(if $(CONFIG_PACKAGE_fast-classifier-example),$(Build/Compile/fast-classifier-example))
 endef
 
-define Build/Compile/fast-classifier-example
-	$(TARGET_CC) -o $(PKG_BUILD_DIR)/userspace_fast_classifier \
-		-I $(PKG_BUILD_DIR) \
-		-I$(STAGING_DIR)/usr/include/libnl \
-		-I$(STAGING_DIR)/usr/include/libnl3 \
-		-lnl-genl-3 -lnl-3 \
-		$(PKG_BUILD_DIR)/nl_classifier_test.c
-endef
-
-ifneq ($(CONFIG_PACKAGE_kmod-shortcut-fe)$(CONFIG_PACKAGE_kmod-shortcut-fe-cm)$(CONFIG_PACKAGE_kmod-fast-classifier),)
+ifneq ($(CONFIG_PACKAGE_kmod-shortcut-fe)$(CONFIG_PACKAGE_kmod-shortcut-fe-cm),)
 define Build/InstallDev
 	$(INSTALL_DIR) $(1)/usr/include/shortcut-fe
 	$(CP) -rf $(PKG_BUILD_DIR)/sfe.h $(1)/usr/include/shortcut-fe
-ifneq ($(CONFIG_PACKAGE_kmod-fast-classifier),)
-	$(INSTALL_DIR) $(1)/usr/include
-	$(CP) $(PKG_BUILD_DIR)/fast-classifier.h $(1)/usr/include/
-endif
 endef
 endif
 
-define Package/fast-classifier-example/install
-	$(INSTALL_DIR) $(1)/sbin
-	$(CP) $(PKG_BUILD_DIR)/userspace_fast_classifier $(1)/sbin/
-endef
-
 $(eval $(call KernelPackage,shortcut-fe))
 $(eval $(call KernelPackage,shortcut-fe-cm))
-$(eval $(call KernelPackage,fast-classifier))
-#$(eval $(call BuildPackage,fast-classifier-example))
-

package/lean/shortcut-fe/files/etc/init.d/shortcut-fe

@@ -0,0 +1,48 @@
+#!/bin/sh /etc/rc.common
+#
+# Copyright (c) 2014-2015 The Linux Foundation. All rights reserved.
+# Permission to use, copy, modify, and/or distribute this software for
+# any purpose with or without fee is hereby granted, provided that the
+# above copyright notice and this permission notice appear in all copies.
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+#SFE connection manager has a lower priority, it should be started after other connection manager
+#to detect the existence of connection manager with higher priority
+START=72
+
+have_cm() {
+	[ -d "/sys/kernel/debug/ecm" ] && echo 1 && return
+
+	echo 0
+}
+
+#load shortcut-fe connection manager
+load_sfe_cm() {
+	local kernel_version=$(uname -r)
+
+	#shortcut-fe-drv.ko is not needed because other connection manager is not enabled
+	[ -d "/sys/module/shortcut_fe_drv" ] && rmmod shortcut_fe_drv
+
+	[ -e "/lib/modules/$kernel_version/shortcut-fe-cm.ko" ] && {
+		[ -d /sys/module/shortcut_fe_cm ] || insmod /lib/modules/$kernel_version/shortcut-fe-cm.ko
+	}
+	[ -e "/lib/modules/$kernel_version/fast-classifier.ko" ] && {
+		[ -d /sys/module/fast_classifier ] || insmod /lib/modules/$kernel_version/fast-classifier.ko
+	}
+}
+
+start() {
+	[ "$(have_cm)" = "1" ] || load_sfe_cm
+}
+
+stop() {
+	[ -d /sys/module/shortcut_fe_cm ] && rmmod shortcut_fe_cm
+	[ -d /sys/module/fast_classifier ] && rmmod fast_classifier
+}

package/lean/shortcut-fe/files/usr/bin/sfe_dump

@@ -0,0 +1,35 @@
+#!/bin/sh
+#
+# Copyright (c) 2015 The Linux Foundation. All rights reserved.
+# Permission to use, copy, modify, and/or distribute this software for
+# any purpose with or without fee is hereby granted, provided that the
+# above copyright notice and this permission notice appear in all copies.
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+#@sfe_dump
+#@example : sfe_dump (ipv4|ipv6)
+sfe_dump(){
+	[ -e "/dev/sfe_ipv4" ] || {
+		dev_num=$(cat /sys/sfe_ipv4/debug_dev)
+		mknod /dev/sfe_ipv4 c $dev_num 0
+	}
+	[ -e "/dev/sfe_ipv6" ] || {
+		dev_num=$(cat /sys/sfe_ipv6/debug_dev)
+		mknod /dev/sfe_ipv6 c $dev_num 0
+	}
+	cat /dev/sfe_$1
+}
+
+if [ -z "$1" ]; then
+	sfe_dump ipv4
+	sfe_dump ipv6
+else
+	sfe_dump $1
+fi

package/lean/shortcut-fe/src/Kconfig

@@ -12,4 +12,3 @@ config SHORTCUT_FE
 	  called shortcut-fe.
 
 	  If unsure, say N.
-	default y

package/lean/shortcut-fe/src/Makefile

@@ -2,13 +2,22 @@
 # Makefile for Shortcut FE.
 #
 
-obj-m += shortcut-fe.o shortcut-fe-ipv6.o shortcut-fe-cm.o fast-classifier.o
+obj-m += shortcut-fe.o
+
+ifdef SFE_SUPPORT_IPV6
+obj-m += shortcut-fe-ipv6.o
+endif
+
+obj-m += shortcut-fe-cm.o
 
 shortcut-fe-objs := \
 	sfe_ipv4.o
 
+ifdef SFE_SUPPORT_IPV6
 shortcut-fe-ipv6-objs := \
 	sfe_ipv6.o
+endif
 
 shortcut-fe-cm-objs := \
 	sfe_cm.o
+

package/lean/shortcut-fe/src/README

@@ -1,122 +0,0 @@
-Shortcut Forwarding Engine
---------------------------
-
-Welcome to "Shortcut" :-)
-
-Here's a quick FAQ:
-
-
-Q) What is Shortcut?
-
-A) Shortcut is an in-Linux-kernel IP packet forwarding engine.  It's designed
-to offer very high speed IP packet forwarding based on IP connection tracking.
-It's dramatically faster than the standard netfilter-based NAT forwarding path
-but is designed to synchronise state back to netfilter/conntrack so that it
-doesn't need to deal with all of the complexities of special cases.
-
-
-Q) What versions of IP does it support?
-
-A) The current version only supports IPv4 but will be extended to support IPv6 in
-the future.
-
-
-Q) What transport protocols does it support?
-
-A) TCP and UDP.  It also knows enough about ICMP to spot ICMP error messages
-related to TCP and UDP and handle things accordingly.
-
-
-Q) Is there a design spec for this software?
-
-A) Not at the moment.  I'll write one when I get more time.  The code is
-intended to be a good tutorial though - it's very heavily commented.  If you
-find yourself reading something and not understanding it then I take that to
-mean I've probably not done a sufficently good job of explaining what it's
-doing in the comments.  Let me know - I will try to fix it :-)
-
-
-Q) Why was it written?
-
-A) It was written as a demonstration of what can be done to provide high
-performance forwarding inside the kernel.  There were two initial motivations:
-
-1) To provide a platform to enable research into how QoS analysis systems can
-offload work and avoid huge Linux overheads.
-
-2) To provide a tool to investigate the behaviour of various processors, SoCs
-and software sets so that we can characterize and design new network processor
-SoCs.
-
-
-Q) How much faster is it than the Linux kernel forwarding path?
-
-A) At the time of pushing this to github it's been tested on a QCA AP135.
-This has a Scorpion (QCA Scopion, not the QMC one :-)) SoC, QCA9550.  The
-SoC's processor is a MIPS74K running at 720 MHz and with a DDR2 memory
-subsystem that offers a peak of 600 MT/s (16-bit transfers).
-
-Running IPv4 NAT forwarding of UDP between the board's 2 GMAC ports and
-using a SmartBits 200 as a traffic generator Linux is able to forward 70k PPS.
-Once the SFE code is invoked this will increase to 350k PPS!
-
-There's also a slightly hacky mode which causes SFE to bypass the Linux
-bridge layer, but this isn't really ready for use because it doesn't have
-sufficient MAC address checks or integration of statistics back to the
-Ethernet bridge, but that runs at 436k PPS.
-
-
-Q) Are there any diagnostics?
-
-A) Yes, this is a research tool after all!  There's a complex way to do this
-that's more general purpose and a simple one - here's the simple one:
-
-	mknod /dev/sfe c 253 0
-
-The file /dev/sfe is an XML-ish output and provides details of all the
-network connections currently being offloaded.  It also reports the numbers
-of packets that took various "exception" paths within the code.  In addition
-it provides a summary of the number of connections, attempts to accelerate
-connections, cancel accelerations, etc.  It also reports the numbers of
-packets that were forwarded and not forwarded by the engine and has some
-stats on the effectiveness of the hashing algorithm it uses.
-
-
-Q) How does the code interact with Linux?
-
-A) There are four minor patches required to make this software run with
-Linux.  These are currently against a 3.3.8 or 3.4.0 kernel:
-
-* (net/core/dev.c) adds a hook to allow packets to be extracted out.
-
-* (net/netfilter/nf_conntrack_proto_tcp.c) exposes a state variable inside
-  netfilter that's necessary to enable TCP sequence and ACK checking within
-  the offload path.  Note that this specific patch is against the QCA QSDK
-  patched version of 3.3.8 - there's a slightly braindead "performance"
-  patch in that kernel, courtesy of the OpenWrt community that makes the
-  Linux forwarding path slightly faster at the expense of losing
-  functionality :-(
-
-* (net/Kconfig) adds the shortcut-fe option.
-
-* (net/Makefile) adds the shortcut-fe build support.
-
-Once these are applied and the module is loaded then everything else
-is automatic :-)  The patches are in this git repo.
-
-
-Q) Are any of the pieces reused from other projects?
-
-A) Yes!  Some of the forwarding concepts are reused from the Ubicom Network
-Accelerator that morphed into part of the Akronite NSS.  This code has all
-been substantially changed though to accomodate Linux's needs.
-
-There are also some pieces that I borrowed from the QCA "FastNAT" software
-written by Xiaoping Fan <xfan@qca.qualcomm.com>.  Xiaoping's code was the
-first actual demonstration within QCA that this in-kernel concept could yield
-signficant performance gains.
-
-
-Enjoy!
-Dave Hudson <dhudson@qti.qualcomm.com>
-

package/lean/shortcut-fe/src/sfe_cm.h

@@ -175,7 +175,7 @@ void sfe_ipv4_register_sync_rule_callback(sfe_sync_rule_callback_t callback);
 void sfe_ipv4_update_rule(struct sfe_connection_create *sic);
 void sfe_ipv4_mark_rule(struct sfe_connection_mark *mark);
 
-
+#ifdef SFE_SUPPORT_IPV6
 /*
  * IPv6 APIs used by connection manager
  */
@@ -186,7 +186,42 @@ void sfe_ipv6_destroy_all_rules_for_dev(struct net_device *dev);
 void sfe_ipv6_register_sync_rule_callback(sfe_sync_rule_callback_t callback);
 void sfe_ipv6_update_rule(struct sfe_connection_create *sic);
 void sfe_ipv6_mark_rule(struct sfe_connection_mark *mark);
+#else
+static inline int sfe_ipv6_recv(struct net_device *dev, struct sk_buff *skb)
+{
+	return 0;
+}
 
+static inline int sfe_ipv6_create_rule(struct sfe_connection_create *sic)
+{
+	return 0;
+}
+
+static inline void sfe_ipv6_destroy_rule(struct sfe_connection_destroy *sid)
+{
+	return;
+}
+
+static inline void sfe_ipv6_destroy_all_rules_for_dev(struct net_device *dev)
+{
+	return;
+}
+
+static inline void sfe_ipv6_register_sync_rule_callback(sfe_sync_rule_callback_t callback)
+{
+	return;
+}
+
+static inline void sfe_ipv6_update_rule(struct sfe_connection_create *sic)
+{
+	return;
+}
+
+static inline void sfe_ipv6_mark_rule(struct sfe_connection_mark *mark)
+{
+	return;
+}
+#endif
 
 /*
  * sfe_ipv6_addr_equal()