lib/libcasper/libcasper/libcasper_impl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2013 The FreeBSD Foundation
   5  * Copyright (c) 2015 Mariusz Zaborski <oshogbo@FreeBSD.org>
   6  * All rights reserved.
   7  *
   8  * This software was developed by Pawel Jakub Dawidek under sponsorship from
   9  * the FreeBSD Foundation.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _LIBCASPER_IMPL_H_
  36 #define _LIBCASPER_IMPL_H_
  37
  38 #include <stdbool.h>
  39
  40 #include "libcasper.h"
  41 #include "libcasper_service.h"
  42
  43 struct service;
  44 struct service_connection;
  45
  46 bool fd_is_valid(int fd);
  47 void fd_fix_environment(int *fdp);
  48
  49 /* Private service functions. */
  50 struct service  *service_alloc(const char *name,
  51                     service_limit_func_t *limitfunc,
  52                     service_command_func_t *commandfunc, uint64_t flags);
  53 void             service_free(struct service *service);
  54 void             service_message(struct service *service,
  55                     struct service_connection *sconn);
  56 void             service_start(struct service *service, int sock, int procfd);
  57 const char      *service_name(struct service *service);
  58 int              service_get_channel_flags(struct service *service);
  59
  60 /* Private service connection functions. */
  61 struct service_connection       *service_connection_add(struct service *service,
  62                                     int sock, const nvlist_t *limits);
  63 void                             service_connection_remove(
  64                                     struct service *service,
  65                                     struct service_connection *sconn);
  66 int                              service_connection_clone(
  67                                     struct service *service,
  68                                     struct service_connection *sconn);
  69 struct service_connection       *service_connection_first(
  70                                     struct service *service);
  71 struct service_connection       *service_connection_next(
  72                                     struct service_connection *sconn);
  73 cap_channel_t                   *service_connection_get_chan(
  74                                     const struct service_connection *sconn);
  75 int                              service_connection_get_sock(
  76                                     const struct service_connection *sconn);
  77 const nvlist_t                  *service_connection_get_limits(
  78                                     const struct service_connection *sconn);
  79 void                             service_connection_set_limits(
  80                                     struct service_connection *sconn,
  81                                     nvlist_t *limits);
  82
  83 /* Private libcasper functions. */
  84 void    casper_main_loop(int fd);
  85
  86 #endif  /* !_LIBCASPER_IMPL_H_ */