.. role:: ref(emphasis)

.. _vcl(7):

===
VCL
===

------------------------------
Varnish Configuration Language
------------------------------

:Manual section: 7

DESCRIPTION
===========

The VCL language is a small domain-specific language designed to be
used to describe request handling and document caching policies for
Varnish Cache.

When a new configuration is loaded, the varnishd management process
translates the VCL code to C and compiles it to a shared object which
is then loaded into the server process.

This document focuses on the syntax of the VCL language. For a full
description of syntax and semantics, with ample examples, please see
the online documentation at https://www.varnish-cache.org/docs/ .

Starting with Varnish 4.0, each VCL file must start by declaring its
version with ``vcl`` *<major>.<minor>*\ ``;`` marker at the top of
the file.  See more about this under Versioning below.


Operators
---------

The following operators are available in VCL:

  ``=``
    Assignment operator.

  ``+=``, ``-=``, ``*=``, ``/=``
    Assign and increment/decrement/multiply/divide operator.

    For strings, ``+=`` appends.

  ``==``, ``!=``, ``<``, ``>``, ``<=``, ``>=``
    Comparisons

  ``~``, ``!~``
    Match / non-match. Can either be used with regular expressions or ACLs.

  ``!``
    Negation.

  ``&&`` / ``||``
    Logical and/or.


Conditionals
------------

VCL has ``if`` and ``else`` statements. Nested logic can be
implemented with the ``elseif`` statement (``elsif``\ /\ ``elif``\ /\
``else if`` are equivalent).

Note that there are no loops or iterators of any kind in VCL.


Strings, booleans, time, duration, integers and real numbers
------------------------------------------------------------

These are the data types in Varnish. You can ``set`` or ``unset`` these.

Example::

  set req.http.User-Agent = "unknown";
  unset req.http.Range;


Strings
~~~~~~~

Basic strings are enclosed in double quotes ``"``\ *...*\ ``"``, and
may not contain newlines. Long strings are enclosed in
``{"``\ *...*\ ``"}``. They may contain any character including single
double quotes ``"``, newline and other control characters except for the
*NUL* (0x00) character.

Booleans
~~~~~~~~

Booleans can be either ``true`` or ``false``.  In addition, in a boolean
context some data types will evaluate to ``true`` or ``false`` depending on
their value.

String types will evaluate to ``false`` if they are unset.  This allows
checks of the type ``if (req.http.opthdr) {}`` to test if a header
exists, even if it is empty, whereas ``if (req.http.opthdr == "") {}``
does not distinguish if the header does not exist or if it is empty.

Backend types
will evaluate to ``false`` if they don't have a backend assigned; integer
types will evaluate to ``false`` if their value is zero; duration types
will evaluate to ``false`` if their value is equal or less than zero.

Time
~~~~

VCL has time. A duration can be added to a time to make another time.
In string context they return a formatted string in RFC1123 format,
e.g. ``Sun, 06 Nov 1994 08:49:37 GMT``.

The keyword ``now`` returns a notion of the current time, which is
kept consistent during VCL subroutine invocations, so during the
execution of a VCL state subroutine (``vcl_* {}``), including all
user-defined subroutines being called, ``now`` always returns the
same value.

Durations
~~~~~~~~~

Durations are defined by a number followed by a unit. The number can
include a fractional part, e.g. ``1.5s``. The supported units are:

  ``ms``
    milliseconds

  ``s``
    seconds

  ``m``
    minutes

  ``h``
    hours

  ``d``
    days

  ``w``
    weeks

  ``y``
    years

In string context they return a string with their value rounded to
3 decimal places and excluding the unit, e.g.  ``1.500``.

Integers
~~~~~~~~

Certain fields are integers, used as expected. In string context they
return a string, e.g. ``1234``.

Real numbers
~~~~~~~~~~~~

VCL understands real numbers. In string context they return a string
with their value rounded to 3 decimal places, e.g. ``3.142``.

Regular Expressions
-------------------

Varnish uses Perl-compatible regular expressions (PCRE). For a
complete description please see the pcre(3) man page.

To send flags to the PCRE engine, such as to do case insensitive matching, add
the flag within parens following a question mark, like this::

    # If host is NOT example dot com..
    if (req.http.host !~ "(?i)example\.com$") {
        ...
    }


Include statement
-----------------

To include a VCL file in another file use the include keyword::

    include "foo.vcl";


Import statement
----------------

The ``import`` statement is used to load Varnish Modules (VMODs.)

Example::

    import std;
    sub vcl_recv {
        std.log("foo");
    }

Comments
--------

Single lines of VCL can be commented out using ``//`` or
``#``. Multi-line blocks can be commented out with
``/*``\ *block*\ ``*/``.

Example::

    sub vcl_recv {
        // Single line of out-commented VCL.
        # Another way of commenting out a single line.
        /*
            Multi-line block of commented-out VCL.
        */
    }

.. _backend_definition:

Backend definition
------------------

A backend declaration creates and initialises a named backend object. A
declaration start with the keyword ``backend`` followed by the name of the
backend. The actual declaration is in curly brackets, in a key/value fashion.::

    backend name {
        .attribute = "value";
    }

One of the attributes ``.host`` or ``.path`` is mandatory (but not
both). The attributes will inherit their defaults from the global
parameters. The following attributes are available:

  ``.host``
    The host to be used. IP address or a hostname that resolves to a
    single IP address. This attribute is mandatory, unless ``.path``
    is declared.

  ``.path``	(``VCL >= 4.1``)

    The absolute path of a Unix domain socket at which a backend is
    listening. If the file at that path does not exist or is not
    accessible to Varnish at VCL load time, then the VCL compiler
    issues a warning, but does not fail. This makes it possible to
    start the UDS-listening peer, or set the socket file's
    permissions, after starting Varnish or loading VCL with a UDS
    backend.  But the socket file must exist and have necessary
    permissions before the first connection is attempted, otherwise
    fetches will fail. If the file does exist and is accessible, then
    it must be a socket; otherwise the VCL load fails. One of
    ``.path`` or ``.host`` must be declared (but not both). ``.path``
    may only be used in VCL since version 4.1.

  ``.port``
    The port on the backend that Varnish should connect to. Ignored if
    a Unix domain socket is declared in ``.path``.

  ``.host_header``
    A host header to add to probes and regular backend requests if they have no
    such header.

  ``.connect_timeout``
    Timeout for connections.

    Default: ``connect_timeout`` parameter, see :ref:`varnishd(1)`

  ``.first_byte_timeout``
    Timeout for first byte.

    Default: ``first_byte_timeout`` parameter, see :ref:`varnishd(1)`

  ``.between_bytes_timeout``
    Timeout between bytes.

    Default: ``between_bytes_timeout`` parameter, see :ref:`varnishd(1)`

  ``.probe``
    Attach a probe to the backend. See `Probes`_

  ``.proxy_header``
    The PROXY protocol version Varnish should use when connecting to
    this backend. Allowed values are ``1`` and ``2``.

    *Notice* this setting will lead to backend connections being used
    for a single request only (subject to future improvements). Thus,
    extra care should be taken to avoid running into failing backend
    connections with EADDRNOTAVAIL due to no local ports being
    available. Possible options are:

    * Use additional backend connections to extra IP addresses or TCP
      ports

    * Increase the number of available ports (Linux sysctl
      ``net.ipv4.ip_local_port_range``)

    * Reuse backend connection ports early (Linux sysctl
      ``net.ipv4.tcp_tw_reuse``)

  ``.max_connections``
    Maximum number of open connections towards this backend. If
    Varnish reaches the maximum Varnish it will start failing
    connections.

Empty backends can also be defined using the following syntax.::

  backend name none;

An empty backend will always return status code 503 as if it is sick.

Backends can be used with *directors*. Please see the
:ref:`vmod_directors(3)` man page for more information.

.. _reference-vcl_probes:

Probes
------

Probes will query the backend for status on a regular basis and mark
the backend as down it they fail. A probe is defined as this::

    probe name {
        .attribute = "value";
    }

The probe named ``default`` is special and will be used for all backends
which do not explicitly reference a probe.

There are no mandatory options. These are the options you can set:

  ``.url``
    The URL to query. Defaults to ``/``.
    Mutually exclusive with ``.request``

  ``.request``
    Specify a full HTTP request using multiple strings. ``.request`` will
    have ``\r\n`` automatically inserted after every string.
    Mutually exclusive with ``.url``.

    *Note* that probes require the backend to complete sending the
    response and close the connection within the specified timeout, so
    ``.request`` will, for ``HTTP/1.1``, most likely need to contain a
    ``"Connection: close"`` string.

  ``.expected_response``
    The expected HTTP response code. Defaults to ``200``.

  ``.timeout``
    The timeout for the probe. Default is ``2s``.

  ``.interval``
    How often the probe is run. Default is ``5s``.

  ``.initial``
    How many of the polls in ``.window`` are considered good when Varnish
    starts. Defaults to the value of ``.threshold`` - 1. In this case, the
    backend starts as sick and requires one single poll to be
    considered healthy.

  ``.window``
    How many of the latest polls we examine to determine backend health.
    Defaults to ``8``.

  ``.threshold``
    How many of the polls in ``.window`` must have succeeded to
    consider the backend to be healthy.
    Defaults to ``3``.


Access Control List (ACL)
-------------------------

An Access Control List (ACL) declaration creates and initialises a named access
control list which can later be used to match client addresses::

    acl localnetwork {
        "localhost";    # myself
        "192.0.2.0"/24; # and everyone on the local network
        ! "192.0.2.23"; # except for the dial-in router
    }

If an ACL entry specifies a host name which Varnish is unable to
resolve, it will match any address it is compared to. Consequently,
if it is preceded by a negation mark, it will reject any address it is
compared to, which may not be what you intended. If the entry is
enclosed in parentheses, however, it will simply be ignored.

To match an IP address against an ACL, simply use the match operator::

    if (client.ip ~ localnetwork) {
        return (pipe);
    }


VCL objects
-----------

A VCL object can be instantiated with the ``new`` keyword::

    sub vcl_init {
        new b = directors.round_robin()
        b.add_backend(node1);
    }

This is only available in ``vcl_init``.

Subroutines
-----------

A subroutine is used to group code for legibility or reusability::

    sub pipe_if_local {
        if (client.ip ~ localnetwork) {
            return (pipe);
        }
    }

Subroutines in VCL do not take arguments, nor do they return
values. The built in subroutines all have names beginning with ``vcl_``,
which is reserved.

To call a subroutine, use the ``call`` keyword followed by the
subroutine's name::

    sub vcl_recv {
        call pipe_if_local;
    }

Return statements
~~~~~~~~~~~~~~~~~

The ongoing ``vcl_*`` subroutine execution ends when a
``return(``\ *<action>*\ ``)`` statement is made.

The *<action>* specifies how execution should proceed. The context
defines which actions are available.

Multiple subroutines
~~~~~~~~~~~~~~~~~~~~

If multiple subroutines with the name of one of the built-in ones are defined,
they are concatenated in the order in which they appear in the source.

The built-in VCL distributed with Varnish will be implicitly concatenated
when the VCL is compiled.



.. include:: vcl_var.rst


Functions
---------

The following built-in functions are available:

.. _vcl(7)_ban:

ban(STRING)
~~~~~~~~~~~

  Invalidates all objects in cache that match the given expression with the
  ban mechanism.

  The format of *STRING* is::

	<field> <operator> <arg> [&& <field> <oper> <arg> ...]

  * *<field>*:

    * string fields:

      * ``req.url``: The request url
      * ``req.http.*``: Any request header
      * ``obj.status``: The cache object status
      * ``obj.http.*``: Any cache object header

      ``obj.status`` is treated as a string despite the fact that it
      is actually an integer.

    * duration fields:

      * ``obj.ttl``: Remaining ttl at the time the ban is issued
      * ``obj.age``: Object age at the time the ban is issued
      * ``obj.grace``: The grace time of the object
      * ``obj.keep``: The keep time of the object


  * *<operator>*:

    * for all fields:

      * ``==``: *<field>* and *<arg>* are equal
      * ``!=``: *<field>* and *<arg>* are unequal

      strings are compared case sensitively

    * for string fields:

      * ``~``: *<field>* matches the regular expression *<arg>*
      * ``!~``:*<field>* does not match the regular expression *<arg>*

    * for duration fields:

      * ``>``: *<field>* is greater than *<arg>*
      * ``>=``: *<field>* is greater than or equal to *<arg>*
      * ``<``: *<field>* is less than *<arg>*
      * ``<=``: *<field>* is less than or equal to *<arg>*


  * *<arg>*:

    * for string fields:

      Either a literal string or a regular expression. Note that
      *<arg>* does not use any of the string delimiters like ``"`` or
      ``{"``\ *...*\ ``"}`` used elsewhere in varnish. To match
      against strings containing whitespace, regular expressions
      containing ``\s`` can be used.

    * for duration fields:

      A VCL duration like ``10s``, ``5m`` or ``1h``, see `Durations`_

  Expressions can be chained using the *and* operator ``&&``. For *or*
  semantics, use several bans.

  The unset *<field>* is not equal to any string, such that, for a
  non-existing header, the operators ``==`` and ``~`` always evaluate
  as false, while the operators ``!=`` and ``!~`` always evaluate as
  true, respectively, for any value of *<arg>*.

hash_data(input)
~~~~~~~~~~~~~~~~

  Adds an input to the hash input. In the built-in VCL ``hash_data()``
  is called on the host and URL of the request. Available in ``vcl_hash``.

synthetic(STRING)
~~~~~~~~~~~~~~~~~

  Prepare a synthetic response body containing the *STRING*. Available
  in ``vcl_synth`` and ``vcl_backend_error``.

  Identical to ``set resp.body`` /  ``set beresp.body``.

.. list above comes from struct action_table[] in vcc_action.c.

regsub(str, regex, sub)
~~~~~~~~~~~~~~~~~~~~~~~

  Returns a copy of *str* with the first occurrence of the regular
  expression *regex* replaced with *sub*. Within *sub*, ``\0`` (which
  can also be spelled ``\&``) is replaced with the entire matched
  string, and ``\``\ *n* is replaced with the contents of subgroup *n*
  in the matched string.

regsuball(str, regex, sub)
~~~~~~~~~~~~~~~~~~~~~~~~~~
  As ``regsub()``, but this replaces all occurrences.

.. regsub* is in vcc_expr.c

For converting or casting VCL values between data types use the functions
available in the std VMOD.

Versioning
==========

Multiple versions of the VCL syntax can coexist within certain
constraints.

The VCL syntax version at the start of VCL file specified with ``-f``
sets the hard limit that cannot be exceeded anywhere, and it selects
the appropriate version of the builtin VCL.

That means that you can never include ``vcl 9.1;`` from ``vcl 8.7;``,
but the opposite *may* be possible, to the extent the compiler
supports it.

Files pulled in via ``include`` do not need to have a
``vcl`` *X.Y*\ ``;`` but it may be a good idea to do it anyway, to
not have surprises in the future.  The syntax version set in an
included file only applies to that file and any files it includes -
unless these set their own VCL syntax version.

The version of Varnish this file belongs to supports syntax 4.0 and 4.1.


EXAMPLES
========

For examples, please see the online documentation.

SEE ALSO
========

* :ref:`varnishd(1)`
* :ref:`vmod_directors(3)`
* :ref:`vmod_std(3)`

HISTORY
=======

VCL was developed by Poul-Henning Kamp in cooperation with Verdens
Gang AS, Redpill Linpro and Varnish Software.  This manual page is
written by Per Buer, Poul-Henning Kamp, Martin Blix Grydeland,
Kristian Lyngstøl, Lasse Karstensen and possibly others.

COPYRIGHT
=========

This document is licensed under the same license as Varnish
itself. See LICENSE for details.

* Copyright (c) 2006 Verdens Gang AS
* Copyright (c) 2006-2015 Varnish Software AS
