share/man/man4/ng_checksum.4

   1 .\" Copyright (c) 2015 Dmitry Vagin <daemon.hammer@ya.ru>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd October 29, 2015
  28 .Dt NG_CHECKSUM 4
  29 .Os
  30 .Sh NAME
  31 .Nm ng_checksum
  32 .Nd reconstructing IP checksums node type
  33 .Sh SYNOPSIS
  34 .In netgraph/ng_checksum.h
  35 .Sh DESCRIPTION
  36 The
  37 .Nm checksum
  38 node can calculate, or prepare for calculation in hardware,
  39 IPv4 header, TCP and UDP checksums.
  40 .Sh HOOKS
  41 This node type has two hooks:
  42 .Bl -tag -width ".Va out"
  43 .It Va in
  44 Packets received on this hook are processed according to settings specified
  45 in config and then forwarded to the
  46 .Ar out
  47 hook, if it exists and is connected. Otherwise they are reflected back to the
  48 .Ar in
  49 hook.
  50 .It Va out
  51 Packets received on this hook are forwarded to the
  52 .Ar in
  53 hook without any changes.
  54 .El
  55 .Sh CONTROL MESSAGES
  56 This node type supports the generic control messages, plus the following:
  57 .Bl -tag -width foo
  58 .It Dv NGM_CHECKSUM_SETDLT Pq Ic setdlt
  59 Sets the data link type on the
  60 .Va in
  61 hook. Currently, supported types are
  62 .Cm DLT_RAW
  63 (raw IP datagrams) and
  64 .Cm DLT_EN10MB
  65 (Ethernet). DLT_ definitions can be found in the
  66 .In net/bpf.h
  67 header. Currently used values are
  68 .Cm DLT_EN10MB
  69 = 1 and
  70 .Cm DLT_RAW
  71 = 12.
  72 .It Dv NGM_CHECKSUM_GETDLT Pq Ic getdlt
  73 This control message obtains the data link type on the
  74 .Va in
  75 hook.
  76 .It Dv NGM_CHECKSUM_SETCONFIG Pq Ic setconfig
  77 Sets the node configuration. The following
  78 .Vt "struct ng_checksum_config"
  79 must be supplied as an argument:
  80 .Bd -literal -offset 4n
  81 struct ng_checksum_config {
  82         uint64_t        csum_flags;
  83         uint64_t        csum_offload;
  84 };
  85 .Ed
  86 .Pp
  87 The
  88 .Va csum_flags
  89 can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6
  90 (other values are ignored) for instructing the node to calculate the corresponding checksum.
  91 .Pp
  92 The
  93 .Va csum_offload
  94 value can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6
  95 (other values are ignored) for instructing the node what checksums should be requested from the hardware.
  96 .Pp
  97 The node also takes into account any combination of
  98 CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6 already
  99 flagged on the mbuf.
 100 .It Dv NGM_CHECKSUM_GETCONFIG Pq Ic getconfig
 101 This control message obtains the current node configuration returned as a
 102 .Vt "struct ng_checksum_config" .
 103 .It Dv NGM_CHECKSUM_GET_STATS Pq Ic getstats
 104 Returns node statistics as a
 105 .Vt "struct ng_checksum_stats" .
 106 .It Dv NGM_CHECKSUM_CLR_STATS Pq Ic clrstats
 107 Clear the node statistics.
 108 .It Dv NGM_CHECKSUM_GETCLR_STATS Pq Ic getclrstats
 109 This command is identical to
 110 .Dv NGM_CHECKSUM_GET_STATS ,
 111 except that the statistics are also atomically cleared.
 112 .El
 113 .Sh SHUTDOWN
 114 This node shuts down upon receipt of a
 115 .Dv NGM_SHUTDOWN
 116 control message, or when all hooks have been disconnected.
 117 .Sh EXAMPLES
 118 .Xr ngctl 8
 119 script:
 120 .Bd -literal -offset 4n
 121 /usr/sbin/ngctl -f- <<-SEQ
 122         msg checksum-1: setdlt 1
 123         msg checksum-1: setconfig { csum_flags=0 csum_offload=6 }
 124 SEQ
 125 .Ed
 126 .Pp
 127 Set the data link type to
 128 .Cm DLT_EN10MB
 129 (Ethernet), do not set additional checksum flags
 130 and request that the hardware calculate CSUM_IP_UDP|CSUM_IP_TCP.
 131 .Sh SEE ALSO
 132 .Xr netgraph 4 ,
 133 .Xr ng_patch 4 ,
 134 .Xr ngctl 8
 135 .Sh HISTORY
 136 The
 137 .Nm
 138 node type was implemented in
 139 .Fx 10.2
 140 and first submitted in
 141 .Fx 12.0 .
 142 .Sh AUTHORS
 143 .An "Dmitry Vagin" Aq daemon.hammer@ya.ru .