### Optimizing 3proxy for high load

Precaution 1: 3proxy was not initially developed for high load and is positioned as a SOHO product, the main reason is "one connection - one thread" model 3proxy uses. 3proxy is known to work with above 200,000 connections under proper configuration, but use it in production environment under high loads at your own risk and do not expect too much.

Precaution 2: This documentation is incomplete and is not sufficient. High loads may require very specific system tuning including, but not limited to specific or cusomized kernels, builds, settings, sysctls, options, etc. All this is not covered by this documentation.

#### Configuring 'maxconn'

A number of simulatineous connections per service is limited by 'maxconn' option. Default maxconn value since 3proxy 0.8 is 500. You may want to set 'maxconn' to higher value. Under this configuration:

    maxconn 1000
    proxy -p3129
    proxy -p3128
    socks

maxconn for every service is 1000, and there are 3 services running (2 proxy and 1 socks), so, for all services there can be up to 3000 simulatineous connections to 3proxy.

Avoid setting 'maxconn' to arbitrary high value, it should be carefully choosen to protect system and proxy from resources exhaution. Setting maxconn above resources available can lead to denial of service conditions.

#### Understanding resources requirements

Each running service require:

- 1*thread (process)
- 1*socket (file descriptor)
- 1 stack memory segment + some heap memory, ~64K-128K depending on the system

Each connected client require:

- 1*thread (process)
- 2*socket (file descriptor). For FTP 4 sockets are required.
  Under linux since 0.9 splice() is used. It's much more effective, but requires
  2*socket (file descriptor) + 2*pipe (file descriptors) = 4 file descriptors.
  For FTP 4 sockets and 2 pipes are required with splice().
  Up to 128K (up to 256K in the case of splice()) of kernel buffers memory. This is theoretical maximum, actual numbers depend on connection quality and traffic amount.
  1 additional socket (file descriptor) during name resolution for non-cached names
  1 additional socket during authentication or logging for RADIUS authentication or logging.
- 1*ephemeral port (3*ephemeral ports for FTP connection).
- 1 stack memory segment of ~32K-128K depending on the system + at least 16K and up to few MB (for 'proxy' and 'ftppr') of heap memory. If you are short of memory, prefer 'socks' to 'proxy' and 'ftppr'.
- a lot of system buffers, specially in the case of slow network connections.

Also, additional resources like system buffers are required for network activity.

#### Setting ulimits

Hard and soft ulimits must be set above calculated requirements. Under Linux, you can check limits of running process with

    cat /proc/PID/limits

where PID is a pid of the process. Validate ulimits match your expectation, especially if you run 3proxy under dedicated account by adding e.g.

    system "ulimit -Ha >>/tmp/3proxy.ulim.hard"
    system "ulimit -Sa >>/tmp/3proxy.ulim.soft"

in the beginning (before first service started) and the end of config file. Make both hard restart (that is kill and start 3proxy process) and soft restart by sending SIGUSR1 to 3proxy process, check ulimits recorded to files match your expecation. In systemd based distros (e.g. latest Debian / Ubuntu) changing limits.conf is not enough, limits must be ajusted in systemd configuration, e.g. by setting

    DefaultLimitDATA=infinity
    DefaultLimitSTACK=infinity
    DefaultLimitCORE=infinity
    DefaultLimitRSS=infinity
    DefaultLimitNOFILE=102400
    DefaultLimitAS=infinity
    DefaultLimitNPROC=10240
    DefaultLimitMEMLOCK=infinity

in user.conf / system.conf

#### Extending system limitation

Check manuals / documentation for your system limitations e.g. system-wide limit for number of open files (fs.file-max in Linux). You may need to change sysctls or even rebuild the kernel from source.

To help with socket-based system-dependant settings, since 0.9-devel 3proxy supports different socket options which can be set via -ol option for listening socket, -oc for proxy-to-client socket and -os for proxy-to-server socket. Example:

    proxy -olSO_REUSEADDR,SO_REUSEPORT -ocTCP_TIMESTAMPS,TCP_NODELAY -osTCP_NODELAY

available options are system dependant.

#### Using 3proxy in virtual environment

If 3proxy is used in VPS environment, there can be additional limitations. For example, kernel resources / system CPU usage / IOCTLs can be limited in a different way, and this can become a bottleneck. Since 0.9 devel, 3proxy uses splice() by default on Linux, splice() prevents network traffic from being copied from kernel space to 3proxy process and generally increases throughput, epecially in the case of high volume traffic. It especially true for virtual environment (it can improve thoughput up to 10 times) unless there are additional kernel limitations. Since some work is moved to kernel, it requires up to 2 times more kernel resources in terms of CPU, memory and IOCTLs. If your hosting additionally limits kernel resources (you can see it as nearly 100% CPU usage without any real CPU activity for any application which performs IOCTLS), use -s0 option to disable splice() usage for given service e.g.

    socks -s0

#### Extending ephemeral port range

Check ephemeral port range for your system and extend it to the number of the ports required. Ephimeral range is always limited to maximum number of ports (64K). To extend the number of outgoing connections above this limit, extending ephemeral port range is not enough, you need additional actions:

1. Configure multiple outgoing IPs
2. Make sure 3proxy is configured to use different outgoing IP by either setting external IP via RADIUS

       radius secret 1.2.3.4
       auth radius
       proxy

   or by using multiple services with different external interfaces, example:

       allow user1,user11,user111
       proxy -p1111 -e1.1.1.1
       flush
       allow user2,user22,user222
       proxy -p2222 -e2.2.2.2
       flush
       allow user3,user33,user333
       proxy -p3333 -e3.3.3.3
       flush
       allow user4,user44,user444
       proxy -p4444 -e4.4.4.4
       flush

   or via "parent extip" rotation, e.g.

       allow user1,user11,user111
       parent 1000 extip 1.1.1.1 0
       allow user2,user22,user222
       parent 1000 extip 2.2.2.2 0
       allow user3,user33,user333
       parent 1000 extip 3.3.3.3 0
       allow user4,user44,user444
       parent 1000 extip 4.4.4.4 0
       proxy

   or

       allow *
       parent 250 extip 1.1.1.1 0
       parent 250 extip 2.2.2.2 0
       parent 250 extip 3.3.3.3 0
       parent 250 extip 4.4.4.4 0
       socks

   Under latest Linux version you can also start multiple services with different external addresses on the single port with SO_REUSEPORT on listening socket to evenly distribute incoming connections between outgoing interfaces:

       socks -olSO_REUSEPORT -p3128 -e 1.1.1.1
       socks -olSO_REUSEPORT -p3128 -e 2.2.2.2
       socks -olSO_REUSEPORT -p3128 -e 3.3.3.3
       socks -olSO_REUSEPORT -p3128 -e 4.4.4.4

   for Web browsing last two examples are not recommended, because same client can get different external address for different requests, you should choose external interface with user-based rules instead.
3. You may need additional system dependant actions to use same port on different IPs, usually by adding SO_REUSEADDR (SO_PORT_SCALABILITY for Windows) socket option to external socket. This option can be set (since 0.9 devel) with -os option:

       proxy -p3128 -e1.2.3.4 -osSO_REUSEADDR

   Behavior for SO_REUSEADDR and SO_REUSEPORT is different between different system, even between different kernel versions and can lead to unexpected results. Specifics is described here. Use this options only if actually required and if you fully understand possible consiquences. E.g. SO_REUSEPORT can help to establish more connections than the number of the client port available, but it can also lead to situation connections are randomely fail due to ip+port pairs collision if remote or local system doesn't support this trick.

#### Setting stacksize

'stacksize' is a size added to all stack allocations and can be both positive and negative. Stack is required in functions call. 3proxy itself doesn't require large stack, but it can be required if some purely-written libc, 3rd party libraries or system functions called. There is known\ dirty code in Unix ODBC implementations, build-in DNS resolvers, especially in the case of IPv6 and large number of interfaces. Under most 64-bit system extending stacksize will lead to additional memory space usage, but do not require actual commited memory, so you can inrease stacksize to relatively large value (e.g. 1024000) without the need to add additional phisical memory, but it's system/libc dependant and requires additional testing under your installation. Don't forget about memory related ulimts.

For 32-bit systems address space can be a bottlneck you should consider. If you're short of address space you can try to use negative stack size.

#### Known system issues

There are known race condition issues in Linux / glibc resolver. The probability of race condition arises under configuration with IPv6, large number of interfaces or IP addresses or resolvers configured. In this case, install local recursor and use 3proxy built-in resolver (nserver / nscache / nscache6).

#### Do not use public resolvers

Public resolvers like ones from Google have ratelimits. For large number of requests install local caching recursor (ISC bind named, PowerDNS recursor, etc).

#### Avoid large lists

Currently, 3proxy is not optimized to use large ACLs, user lists, etc. All lists are processed lineary. In devel version you can use RADIUS authentication to avoid user lists and ACLs in 3proxy itself. Also, RADIUS allows to easily set outgoing IP on per-user basis or more sophisicated logics. RADIUS is a new beta feature, test it before using in production.

#### Avoid changing configuration too often

Every configuration reload requires additional resources. Do not do frequent changes, like users addition/deletaion via connfiguration, use alternative authentication methods instead, like RADIUS.

#### Consider using 'noforce'

'force' behaviour (default) re-authenticates all connections after configuration reload, it may be resource consuming on large number of connections. Consider adding 'noforce' command before services started to prevent connections reauthentication.

#### Do not monitor configuration files directly

Using configuration file directly in 'monitor' can lead to race condition where configuration is reloaded while file is being written. To avoid race conditions:

1. Update config files only if there is no lock file
2. Create lock file then 3proxy configuration is updated, e.g. with "touch /some/path/3proxy/3proxy.lck". If you generate config files asynchronously, e.g. by user's request via web, you should consider implementing existance checking and file creation as atomic operation.
3. add

       system "rm /some/path/3proxy/3proxy.lck"

   at the end of config file to remove it after configuration is successfully loaded
4. Use a dedicated version file to monitor, e.g.

       monitor "/some/path/3proxy/3proxy.ver"

5. After config is updated, change version file for 3proxy to reload configuration, e.g. with "touch /some/path/3proxy/3proxy.ver".

#### Use TCP_NODELAY to speed-up connections with small amount of data

If most requests require exchange with a small amount of data in a both ways without the need for bandwidth, e.g. messengers or small web request, you can eliminate Nagle's algorithm delay with TCP_NODELAY flag. Usage example:

    proxy -osTCP_NODELAY -ocTCP_NODELAY

sets TCP_NODELAY for client (oc) and server (os) connections.

Do not use TCP_NODELAY on slow connections with high delays and then connection bandwidth is a bottleneck.

#### Use splice to speedup large data amount transfers

splice() allows to copy data between connections without copying to process addres space. It can speedup proxy on high bandwidth connections, if most connections require large data transfers. Splice is enabled by default on Linux since 0.9, "-s0" disables splice usage. Example:

    proxy -s0

Splice is only available on Linux. Splice requires more system buffers and file descriptors, and produces more IOCTLs but reduces process memory and overall CPU usage. Disable splice if there is a lot of short-living connections with no bandwidth requirements.

Use splice only on high-speed connections (e.g. 10GBE), if processor, memory speed or system bus are bottlenecks.

TCP_NODELAY and splice are not contrary to each over and should be combined on high-speed connections.

#### Add grace delay to reduce system calls

####

    proxy -g8000,3,10

First parameter is average read size we want to keep, second parameter is minimal number of packets in the same direction to apply algorythm, last value is delay added after polling and prior to reading data. An example above adds 10 millisecond delay before reading data if average polling size is below 8000 bytes and 3 read operations are made in the same direction. It's specially usefule with splice.

    logdump 1 1

is useful to see how grace delays work, choose delay value to avoid filling the read pipe/buffer (typically 64K) but keep the request sizes close to chosen average on large file upload/download.