root/sys/sys/sockopt.h
/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1982, 1986, 1990, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
#ifndef _SYS_SOCKOPT_H_
#define _SYS_SOCKOPT_H_

#ifndef _KERNEL
#error "no user-serviceable parts inside"
#endif

struct cap_rights;
struct thread;
struct socket;

/*
 * Argument structure for sosetopt et seq.  This is in the KERNEL
 * section because it will never be visible to user code.
 */
enum sopt_dir { SOPT_GET, SOPT_SET };

struct  sockopt {
        enum    sopt_dir sopt_dir; /* is this a get or a set? */
        int     sopt_level;     /* second arg of [gs]etsockopt */
        int     sopt_name;      /* third arg of [gs]etsockopt */
        void   *sopt_val;       /* fourth arg of [gs]etsockopt */
        size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
        const struct cap_rights *sopt_rights; /* Capsicum rights for the fd */
        struct  thread *sopt_td; /* calling thread or null if kernel */
};

int     sosetopt(struct socket *so, struct sockopt *sopt);
int     sogetopt(struct socket *so, struct sockopt *sopt);
int __result_use_check sooptcopyin(struct sockopt *sopt, void *buf, size_t len,
    size_t minlen);
int __result_use_check sooptcopyout(struct sockopt *sopt, const void *buf,
    size_t len);
int     soopt_getm(struct sockopt *sopt, struct mbuf **mp);
int     soopt_mcopyin(struct sockopt *sopt, struct mbuf *m);
int     soopt_mcopyout(struct sockopt *sopt, struct mbuf *m);
int     accept_filt_getopt(struct socket *, struct sockopt *);
int     accept_filt_setopt(struct socket *, struct sockopt *);
int     so_setsockopt(struct socket *so, int level, int optname,
            void *optval, size_t optlen);

#endif /* _SYS_SOCKOPT_H_ */