sys/netpfil/pf/pf_nv.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2021 Rubicon Communications, LLC (Netgate)
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  */
  28 #ifndef _PF_NV_H_
  29 #define _PF_NV_H_
  30
  31 #include <sys/nv.h>
  32 #include <sys/sdt.h>
  33 #include <sys/socket.h>
  34 #include <sys/types.h>
  35
  36 #include <net/if.h>
  37 #include <net/if_var.h>
  38 #include <net/pfvar.h>
  39
  40 SDT_PROVIDER_DECLARE(pf);
  41 SDT_PROBE_DECLARE(pf, ioctl, function, error);
  42 SDT_PROBE_DECLARE(pf, ioctl, nvchk, error);
  43
  44 #define ERROUT_FUNCTION(target, x)                                      \
  45         do {                                                            \
  46                 error = (x);                                            \
  47                 SDT_PROBE3(pf, ioctl, function, error, __func__, error, \
  48                     __LINE__);                                          \
  49                 goto target;                                            \
  50         } while (0)
  51
  52 #define PFNV_CHK(x)     do {    \
  53         error = (x);            \
  54         SDT_PROBE2(pf, ioctl, nvchk, error, error, __LINE__);   \
  55         if (error != 0)         \
  56                 goto errout;    \
  57         } while (0)
  58
  59 int     pf_nvbinary(const nvlist_t *, const char *, void *, size_t);
  60 int     pf_nvint(const nvlist_t *, const char *, int *);
  61 int     pf_nvuint8(const nvlist_t *, const char *, uint8_t *);
  62 int     pf_nvuint8_array(const nvlist_t *, const char *, uint8_t *,
  63             size_t, size_t *);
  64 void    pf_uint8_array_nv(nvlist_t *, const char *, const uint8_t *,
  65             size_t);
  66 int     pf_nvuint16(const nvlist_t *, const char *, uint16_t *);
  67 int     pf_nvuint16_array(const nvlist_t *, const char *, uint16_t *,
  68             size_t, size_t *);
  69 void    pf_uint16_array_nv(nvlist_t *, const char *, const uint16_t *,
  70             size_t);
  71 int     pf_nvuint32(const nvlist_t *, const char *, uint32_t *);
  72 int     pf_nvuint32_array(const nvlist_t *, const char *, uint32_t *,
  73             size_t, size_t *);
  74 void    pf_uint32_array_nv(nvlist_t *, const char *, const uint32_t *,
  75             size_t);
  76 int     pf_nvuint64(const nvlist_t *, const char *, uint64_t *);
  77 int     pf_nvuint64_array(const nvlist_t *, const char *, uint64_t *,
  78             size_t, size_t *);
  79 void    pf_uint64_array_nv(nvlist_t *, const char *, const uint64_t *,
  80             size_t);
  81
  82 int     pf_nvstring(const nvlist_t *, const char *, char *, size_t);
  83
  84 /* Translation functions */
  85
  86 int              pf_check_rule_addr(const struct pf_rule_addr *);
  87
  88 nvlist_t        *pf_krule_to_nvrule(const struct pf_krule *);
  89 int              pf_nvrule_to_krule(const nvlist_t *, struct pf_krule *);
  90 int              pf_nvstate_kill_to_kstate_kill(const nvlist_t *,
  91                     struct pf_kstate_kill *);
  92 nvlist_t        *pf_state_to_nvstate(const struct pf_state *);
  93
  94 #endif