contrib/dhcpcd/src/control.h

   1 /* SPDX-License-Identifier: BSD-2-Clause */
   2 /*
   3  * dhcpcd - DHCP client daemon
   4  * Copyright (c) 2006-2019 Roy Marples <roy@marples.name>
   5  * All rights reserved
   6
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #ifndef CONTROL_H
  30 #define CONTROL_H
  31
  32 #include "dhcpcd.h"
  33
  34 #if !defined(CTL_FREE_LIST)
  35 #define CTL_FREE_LIST 1
  36 #elif CTL_FREE_LIST == 0
  37 #undef  CTL_FREE_LIST
  38 #endif
  39
  40 /* Limit queue size per fd */
  41 #define CONTROL_QUEUE_MAX       100
  42
  43 struct fd_data {
  44         TAILQ_ENTRY(fd_data) next;
  45         void *data;
  46         size_t data_size;
  47         size_t data_len;
  48 };
  49 TAILQ_HEAD(fd_data_head, fd_data);
  50
  51 struct fd_list {
  52         TAILQ_ENTRY(fd_list) next;
  53         struct dhcpcd_ctx *ctx;
  54         int fd;
  55         unsigned int flags;
  56         struct fd_data_head queue;
  57         size_t queue_len;
  58 #ifdef CTL_FREE_LIST
  59         struct fd_data_head free_queue;
  60 #endif
  61 };
  62 TAILQ_HEAD(fd_list_head, fd_list);
  63
  64 #define FD_LISTEN       (1<<0)
  65 #define FD_UNPRIV       (1<<1)
  66
  67 int control_start(struct dhcpcd_ctx *, const char *);
  68 int control_stop(struct dhcpcd_ctx *);
  69 int control_open(const char *);
  70 ssize_t control_send(struct dhcpcd_ctx *, int, char * const *);
  71 int control_queue(struct fd_list *, void *, size_t, bool);
  72 void control_close(struct dhcpcd_ctx *ctx);
  73
  74 #endif