xref: /dragonfly/contrib/dhcpcd/src/control.h (revision f984587a)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * dhcpcd - DHCP client daemon
4  * Copyright (c) 2006-2023 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 <stdbool.h>
33 
34 #include "dhcpcd.h"
35 
36 #if !defined(CTL_FREE_LIST)
37 #define	CTL_FREE_LIST 1
38 #elif CTL_FREE_LIST == 0
39 #undef	CTL_FREE_LIST
40 #endif
41 
42 /* Limit queue size per fd */
43 #define CONTROL_QUEUE_MAX	100
44 
45 struct fd_data {
46 	TAILQ_ENTRY(fd_data) next;
47 	void *data;
48 	size_t data_size;
49 	size_t data_len;
50 	unsigned int data_flags;
51 };
52 TAILQ_HEAD(fd_data_head, fd_data);
53 
54 struct fd_list {
55 	TAILQ_ENTRY(fd_list) next;
56 	struct dhcpcd_ctx *ctx;
57 	int fd;
58 	unsigned int flags;
59 	struct fd_data_head queue;
60 #ifdef CTL_FREE_LIST
61 	struct fd_data_head free_queue;
62 #endif
63 };
64 TAILQ_HEAD(fd_list_head, fd_list);
65 
66 #define	FD_LISTEN	0x01U
67 #define	FD_UNPRIV	0x02U
68 #define	FD_SENDLEN	0x04U
69 
70 int control_start(struct dhcpcd_ctx *, const char *, sa_family_t);
71 int control_stop(struct dhcpcd_ctx *);
72 int control_open(const char *, sa_family_t, bool);
73 ssize_t control_send(struct dhcpcd_ctx *, int, char * const *);
74 struct fd_list *control_new(struct dhcpcd_ctx *, int, unsigned int);
75 void control_free(struct fd_list *);
76 void control_delete(struct fd_list *);
77 int control_queue(struct fd_list *, void *, size_t);
78 void control_recvdata(struct fd_list *fd, char *, size_t);
79 #endif
80