Add BALANCE_PROVIDERS option

Signed-off-by: Tom Eastep <teastep@shorewall.net>

Shorewall/Perl/Shorewall/Config.pm

@@ -904,6 +904,7 @@ sub initialize( $;$$) {
 	  VERBOSE_MESSAGES => undef ,
 	  ZERO_MARKS => undef ,
 	  FIREWALL => undef ,
+	  BALANCE_PROVIDERS => undef ,
 	  #
 	  # Packet Disposition
 	  #
@@ -5279,6 +5280,7 @@ sub update_config_file( $ ) {
     }
 
     update_default( 'USE_DEFAULT_RT', 'No' );
+    update_default( 'BALANCE_PROVIDERS', 'Yes' );
     update_default( 'EXPORTMODULES',  'No' );
     update_default( 'RESTART',        'reload' );
     update_default( 'PAGER',          $shorewallrc1{DEFAULT_PAGER} );
@@ -6286,6 +6288,9 @@ sub get_configuration( $$$$ ) {
     default_yes_no 'RESTORE_DEFAULT_ROUTE'      , 'Yes';
     default_yes_no 'AUTOMAKE'                   , '';
     default_yes_no 'TRACK_PROVIDERS'            , '';
+    default_yes_no 'BALANCE_PROVIDERS'          , 'Yes';
+
+    $config{BALANCE_PROVIDERS} = '' unless $config{USE_DEFAULT_RT};
 
     unless ( ( $config{NULL_ROUTE_RFC1918} || '' ) =~ /^(?:blackhole|unreachable|prohibit)$/ ) {
 	default_yes_no( 'NULL_ROUTE_RFC1918', '' );

Shorewall/Perl/Shorewall/Providers.pm

@@ -519,11 +519,11 @@ sub process_a_provider( $ ) {
     my ( $loose, $track, $balance, $default, $default_balance, $optional, $mtu, $tproxy, $local, $load, $what, $hostroute, $persistent );
 
     if ( $pseudo ) {	
-	( $loose, $track,                   $balance , $default, $default_balance,                $optional,                           $mtu, $tproxy , $local, $load, $what ,      $hostroute,        $persistent ) =
+	( $loose, $track,                   $balance , $default, $default_balance,                   $optional,                           $mtu, $tproxy , $local, $load, $what ,      $hostroute,        $persistent ) =
-	( 0,      0                       , 0 ,        0,        0,                               1                                  , ''  , 0       , 0,      0,     'interface', 0,                 0);
+	( 0,      0                       , 0 ,        0,        0,                                  1                                  , ''  , 0       , 0,      0,     'interface', 0,                 0);
     } else {
-	( $loose, $track,                   $balance , $default, $default_balance,                $optional,                           $mtu, $tproxy , $local, $load, $what      , $hostroute,        $persistent  )=
+	( $loose, $track,                   $balance , $default, $default_balance,                   $optional,                           $mtu, $tproxy , $local, $load, $what      , $hostroute,        $persistent  )=
-	( 0,      $config{TRACK_PROVIDERS}, 0 ,        0,        $config{USE_DEFAULT_RT} ? 1 : 0, interface_is_optional( $interface ), ''  , 0       , 0,      0,     'provider',  1,                 0);
+	( 0,      $config{TRACK_PROVIDERS}, 0 ,        0,        $config{BALANCE_PROVIDERS} ? 1 : 0, interface_is_optional( $interface ), ''  , 0       , 0,      0,     'provider',  1,                 0);
     }
 
     unless ( $options eq '-' ) {

Shorewall/Samples/Universal/shorewall.conf

@@ -140,6 +140,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall/Samples/one-interface/shorewall.conf

@@ -151,6 +151,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall/Samples/three-interfaces/shorewall.conf

@@ -148,6 +148,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall/Samples/two-interfaces/shorewall.conf

@@ -151,6 +151,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall/configfiles/shorewall.conf

@@ -140,6 +140,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall/manpages/shorewall.conf.xml

@@ -443,6 +443,23 @@
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><emphasis role="bold">BALANCE_PROVIDERS=</emphasis>[<emphasis
+        role="bold">Yes</emphasis>|<emphasis role="bold">No</emphasis>]</term>
+
+        <listitem>
+          <para>Added in Shorewall 5.1.1. When USE_DEFAULT_RT=Yes, this option
+          determines whether the <option>balance</option> provider option (see
+          <ulink
+          url="shorewall-providers.html">shorewall-providers(5)</ulink>) is
+          the default. When BALANCE_PROVIDERS=Yes (the default), then the
+          <option>balance</option> option is assumed unless the
+          <option>fallback</option>, <option>loose</option>,
+          <option>load</option> or <option>tproxy</option> option is
+          specified.</para>
+        </listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><emphasis role="bold">BASIC_FILTERS=</emphasis>[<emphasis
         role="bold">Yes</emphasis>|<emphasis role="bold">No</emphasis>]</term>
@@ -2831,8 +2848,12 @@ INLINE          -       -       -       ;; -j REJECT
             </listitem>
 
             <listitem>
-              <para><emphasis role="bold">balance</emphasis> is assumed unless
+              <para>If running Shorewall 5.1.0 or earlier or if
-              <emphasis role="bold">loose</emphasis> is specified.</para>
+              BALANCE_PROVIDERS=Yes (Shorewall 5.1.1 or later), then the
+              <emphasis role="bold">balance</emphasis> provider option is
+              assumed unless the <option>fallback</option>,
+              <option>loose</option>, <option>load</option> or
+              <option>tproxy</option> option is specified.</para>
             </listitem>
 
             <listitem>

Shorewall6/Samples6/Universal/shorewall6.conf

@@ -133,6 +133,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall6/Samples6/one-interface/shorewall6.conf

@@ -134,6 +134,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall6/Samples6/three-interfaces/shorewall6.conf

@@ -133,6 +133,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall6/Samples6/two-interfaces/shorewall6.conf

@@ -133,6 +133,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall6/configfiles/shorewall6.conf

@@ -133,6 +133,8 @@ AUTOHELPERS=Yes
 
 AUTOMAKE=Yes
 
+BALANCE_PROVIDERS=No
+
 BASIC_FILTERS=No
 
 BLACKLIST="NEW,INVALID,UNTRACKED"

Shorewall6/manpages/shorewall6.conf.xml

@@ -374,6 +374,23 @@
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><emphasis role="bold">BALANCE_PROVIDERS=</emphasis>[<emphasis
+        role="bold">Yes</emphasis>|<emphasis role="bold">No</emphasis>]</term>
+
+        <listitem>
+          <para>Added in Shorewall 5.1.1. When USE_DEFAULT_RT=Yes, this option
+          determines whether the <option>balance</option> provider option (see
+          <ulink
+          url="shorewall6-providers.html">shorewall6-providers(5)</ulink>) is
+          the default. When BALANCE_PROVIDERS=Yes (the default), then the
+          <option>balance</option> option is assumed unless the
+          <option>fallback</option>, <option>loose</option>,
+          <option>load</option> or <option>tproxy</option> option is
+          specified.</para>
+        </listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><emphasis role="bold">BASIC_FILTERS=</emphasis>[<emphasis
         role="bold">Yes</emphasis>|<emphasis role="bold">No</emphasis>]</term>
@@ -2475,8 +2492,12 @@ INLINE          -       -       -       ;; -j REJECT
             </listitem>
 
             <listitem>
-              <para><emphasis role="bold">balance</emphasis> is assumed unless
+              <para>If running Shorewall 5.1.0 or earlier or if
-              <emphasis role="bold">loose</emphasis> is specified.</para>
+              BALANCE_PROVIDERS=Yes (Shorewall 5.1.1 or later), then the
+              <emphasis role="bold">balance</emphasis> provider option is
+              assumed unless the <option>fallback</option>,
+              <option>loose</option>, <option>load</option> or
+              <option>tproxy</option> option is specified.</para>
             </listitem>
 
             <listitem>

docs/MultiISP.xml

@@ -484,6 +484,18 @@ fi</programlisting>
                         url="FAQ.htm#faq58">FAQ 58</ulink>.</para>
                       </note></para>
                   </important>
+
+                  <para>Prior to Shorewall 5.1.1, <emphasis
+                  role="bold">balance=1</emphasis> is the default when
+                  USE_DEFAULT_RT=Yes and neither the
+                  <option>fallback</option>, <option>loose</option>,
+                  <option>load</option> or <option>tproxy</option> option is
+                  specified. Beginning with Shorewall 5.1.1, <emphasis
+                  role="bold">balance=1</emphasis> is the default when both
+                  USE_DEFAULT_RT=Yes and BALANCE_PROVIDERS=Yes and neither the
+                  <option>fallback</option>, <option>loose</option>,
+                  <option>load</option> nor <option>tproxy</option> option is
+                  specified.</para>
                 </listitem>
               </varlistentry>