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/types.h>
  32 #include <sys/nv.h>
  33
  34 int     pf_nvbinary(const nvlist_t *, const char *, void *, size_t);
  35 int     pf_nvint(const nvlist_t *, const char *, int *);
  36 int     pf_nvuint8(const nvlist_t *, const char *, uint8_t *);
  37 int     pf_nvuint8_array(const nvlist_t *, const char *, uint8_t *,
  38             size_t, size_t *);
  39 void    pf_uint8_array_nv(nvlist_t *, const char *, const uint8_t *,
  40             size_t);
  41 int     pf_nvuint16(const nvlist_t *, const char *, uint16_t *);
  42 int     pf_nvuint16_array(const nvlist_t *, const char *, uint16_t *,
  43             size_t, size_t *);
  44 void    pf_uint16_array_nv(nvlist_t *, const char *, const uint16_t *,
  45             size_t);
  46 int     pf_nvuint32(const nvlist_t *, const char *, uint32_t *);
  47 int     pf_nvuint32_array(const nvlist_t *, const char *, uint32_t *,
  48             size_t, size_t *);
  49 void    pf_uint32_array_nv(nvlist_t *, const char *, const uint32_t *,
  50             size_t);
  51
  52 int     pf_nvstring(const nvlist_t *, const char *, char *, size_t);
  53
  54 #define PFNV_CHK(x)     do {    \
  55         error = (x);            \
  56         if (error != 0)         \
  57                 goto errout;    \
  58         } while (0)
  59
  60 #endif