Add individual config options for threaded client/service detection

Add automatic classification options to readme
-  `threaded_service_detection`
-  `threaded_client_detection`

Include threaded client/service detection options in default config

Author: jeverley

README.md

@@ -1,5 +1,5 @@
 # What is DSCP Classify?
-DSCP Classify is an nftables based service for applying DSCP classifications to connections, compatible with OpenWrt's firewall4 for dynamically setting DSCP packet marks (this only works in OpenWrt 22.03 and above).
+DSCP Classify is an nftables based service for applying DSCP class to connections (this only works in OpenWrt 22.03 and above).
 
 This should be used in conjunction with layer-cake SQM queue with ctinfo configured to restore DSCP on the device ingress.
 The dscpclassify service uses the last 8 bits of the conntrack mark (0x000000ff).
@@ -14,13 +14,13 @@ These follow a similar syntax to the OpenWrt firewall config and can match upon
 
 The rules support the use of nft sets, which could be dynamically updated from external sources such as dnsmasq.
 
-### 2. Client DSCP hinting
+### 2. Client class hinting
 The service can be configured to apply the DSCP mark supplied by a non WAN originating client.
 
 This function ignores CS6 and CS7 classes to avoid abuse from inappropriately configed LAN clients such as IoT devices.
 
-### 3. Dynamic classification
-Connections that do not match a user rule or client hint will be dynamically classified by the service to reduce their priority.
+### 3. Automatic classification
+Connections that do not match a user rule or client class hint will be automatically classified by the service to set their priority.
 
 #### Multi-connection client port detection for detecting P2P traffic
 These connections are classified as **Low Effort (LE**) by default and therefore prioritised **below Best Effort** traffic when using the layer-cake qdisc.
@@ -64,28 +64,37 @@ opkg install kmod-sched-ctinfo
 wget "$repo/usr/lib/sqm/layer_cake_ct.qos" -O "/usr/lib/sqm/layer_cake_ct.qos"
 wget "$repo/usr/lib/sqm/layer_cake_ct.qos.help" -O "/usr/lib/sqm/layer_cake_ct.qos.help"
 ```
-# Service configuration
-The user rules in '/etc/config/dscpclassify' use the same syntax as OpenWrt's firewall config, the 'class' option is used to specified the desired DSCP.
-
-A working default configuration is provided with the service which should work for most users.
+# Configuration
+The service configuration is located in '/etc/config/dscpclassify'.
 
-### The service supports the following configuration options
+### A working default configuration is provided with the service which should work for most users.
 
-|Config option | Description | Type | Default|
+#### Global options
+|Option | Description | Type | Default|
 |--- | --- | --- | ---|
 |class_bulk | The class applied to threaded bulk clients | string | le|
 |class_high_throughput | The class applied to threaded high-throughput services | string | af13|
 |client_hints | Adopt the DSCP class supplied by a non-WAN client (this exludes CS6 and CS7 classes to avoid abuse) | boolean | 1|
-|threaded_client_min_bytes | The total bytes before a threaded client port (i.e. P2P) is classified as bulk | uint | 10000|
-|threaded_client_min_connections | The number of established connections for a client port to be considered threaded | uint | 10|
-|threaded_service_min_bytes | The total bytes before a threaded service's connection is classed as high-throughput | uint | 1000000|
-|threaded_service_min_connections | The number of established connections for a service to be considered threaded | uint | 3|
+|threaded_client_detection | Automatically and classify threaded client connections (i.e. P2P) as bulk | boolean | 1|
+|threaded_service_detection | Automatically and classify threaded service connections (i.e. Windows Update/Steam downloads) as bulk | boolean | 1|
 |lan_device | Manually specify devices that the service should treat as LAN | list: string | |
 |lan_zone | Manually specify firewall zones that the service should treat as LAN | list: string | lan|
 |wan_device | Manually specify devices that the service should treat as WAN | list: string | |
 |wan_zone | Manually specify firewall zones that the service should treat as WAN | list: string | wan|
 |wmm | When enabled the service will mark LAN bound packets with DSCP values respective of WMM (RFC-8325) | boolean | 0|
 
+#### Advanced global options (not recommended for most users)
+|Option | Description | Type | Default|
+|--- | --- | --- | ---|
+|threaded_client_min_bytes | The total bytes before a threaded client port (i.e. P2P) is classified as bulk | uint | 10000|
+|threaded_client_min_connections | The number of established connections for a client port to be considered threaded | uint | 10|
+|threaded_service_min_bytes | The total bytes before a threaded service's connection is classed as high-throughput | uint | 1000000|
+|threaded_service_min_connections | The number of established connections for a service to be considered threaded | uint | 3|
+
+# User rules
+The user rules in '/etc/config/dscpclassify' use the same syntax as OpenWrt's firewall config, the 'class' option is used to specified the desired DSCP.
+The OpenWrt firewall syntax is outlined [here](https://openwrt.org/docs/guide-user/firewall/firewall_configuration).
+
 ### Example user rule
 
 ```
@@ -100,7 +109,6 @@ config rule
 	option counter '0'
 ```
 The counter option can be enabled to count the number of matched connections for a rule.
-The OpenWrt firewall syntax is outlined [here](https://openwrt.org/docs/guide-user/firewall/firewall_configuration).
 
 # SQM configuration
 

etc/config/dscpclassify

@@ -2,8 +2,8 @@ config global 'global'
 	option class_bulk 'le'
 	option class_high_throughput 'af13'
 	option client_hints '1'
-	option threaded_client_min_bytes '10000'
-	option threaded_service_min_bytes '1000000'
+	option threaded_client_detection '1'
+	option threaded_service_detection '1'
 	option wmm '0'
 
 config ipset

etc/init.d/dscpclassify

@@ -20,8 +20,10 @@ CLASS_BULK=le
 CLASS_HIGH_THROUGHPUT=af13
 CLIENT_HINTS=1
 DYNAMIC_CLASSIFY=1
+THREADED_CLIENT_DETECTION=1
 THREADED_CLIENT_MIN_BYTES=10000
 THREADED_CLIENT_MIN_CONNECTIONS=10
+THREADED_SERVICE_DETECTION=1
 THREADED_SERVICE_MIN_BYTES=1000000
 THREADED_SERVICE_MIN_CONNECTIONS=3
 WMM=0
@@ -639,13 +641,14 @@ destroy_threaded_client_rules() {
 }
 
 create_threaded_client_rules() {
-	local class_bulk threaded_client_min_bytes threaded_client_min_connections
+	local class_bulk dynamic_classify threaded_client_detection threaded_client_min_bytes threaded_client_min_connections
 
 	config_get_bool dynamic_classify global dynamic_classify $DYNAMIC_CLASSIFY
-	[ "$dynamic_classify" = 1 ] || {
+	config_get_bool threaded_client_detection global threaded_client_detection $THREADED_CLIENT_DETECTION
+	if [ "$dynamic_classify" != 1 ] || [ "$threaded_client_detection" != 1 ]; then
 		destroy_threaded_client_rules
 		return 0
-	}
+	fi
 
 	config_get threaded_client_min_connections global threaded_client_min_connections $THREADED_CLIENT_MIN_CONNECTIONS
 	if ! check_uint "$threaded_client_min_connections" || [ "$threaded_client_min_connections" -lt 2 ]; then
@@ -702,13 +705,14 @@ destroy_threaded_service_rules() {
 }
 
 create_threaded_service_rules() {
-	local class_high_throughput threaded_service_min_bytes threaded_service_min_connections
+	local class_high_throughput dynamic_classify threaded_service_detection threaded_service_min_bytes threaded_service_min_connections
 
 	config_get_bool dynamic_classify global dynamic_classify $DYNAMIC_CLASSIFY
-	[ "$dynamic_classify" = 1 ] || {
+	config_get_bool threaded_service_detection global threaded_service_detection $THREADED_SERVICE_DETECTION
+	if [ "$dynamic_classify" != 1 ] || [ "$threaded_service_detection" != 1 ]; then
 		destroy_threaded_service_rules
 		return 0
-	}
+	fi
 
 	config_get threaded_service_min_connections global threaded_service_min_connections $THREADED_SERVICE_MIN_CONNECTIONS
 	if ! check_uint "$threaded_service_min_connections" || [ "$threaded_service_min_connections" -lt 2 ]; then