/src/hostap/wpa_supplicant/ctrl_iface.h

Source (jump to first uncovered line)
/*
 * WPA Supplicant / UNIX domain socket -based control interface
 * Copyright (c) 2004-2020, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#ifndef CTRL_IFACE_H
#define CTRL_IFACE_H

#ifdef CONFIG_CTRL_IFACE

#ifndef CTRL_IFACE_MAX_LEN
#define CTRL_IFACE_MAX_LEN 8192
#endif /* CTRL_IFACE_MAX_LEN */

/* Shared functions from ctrl_iface.c; to be called by ctrl_iface backends */

/**
 * wpa_supplicant_ctrl_iface_process - Process ctrl_iface command
 * @wpa_s: Pointer to wpa_supplicant data
 * @buf: Received command buffer (nul terminated string)
 * @resp_len: Variable to be set to the response length
 * Returns: Response (*resp_len bytes) or %NULL on failure
 *
 * Control interface backends call this function when receiving a message that
 * they do not process internally, i.e., anything else than ATTACH, DETACH,
 * and LEVEL. The return response value is then sent to the external program
 * that sent the command. Caller is responsible for freeing the buffer after
 * this. If %NULL is returned, *resp_len can be set to two special values:
 * 1 = send "FAIL\n" response, 2 = send "OK\n" response. If *resp_len has any
 * other value, no response is sent.
 */
char * wpa_supplicant_ctrl_iface_process(struct wpa_supplicant *wpa_s,
           char *buf, size_t *resp_len);

/**
 * wpa_supplicant_global_ctrl_iface_process - Process global ctrl_iface command
 * @global: Pointer to global data from wpa_supplicant_init()
 * @buf: Received command buffer (nul terminated string)
 * @resp_len: Variable to be set to the response length
 * Returns: Response (*resp_len bytes) or %NULL on failure
 *
 * Control interface backends call this function when receiving a message from
 * the global ctrl_iface connection. The return response value is then sent to
 * the external program that sent the command. Caller is responsible for
 * freeing the buffer after this. If %NULL is returned, *resp_len can be set to
 * two special values: 1 = send "FAIL\n" response, 2 = send "OK\n" response. If
 * *resp_len has any other value, no response is sent.
 */
char * wpa_supplicant_global_ctrl_iface_process(struct wpa_global *global,
            char *buf, size_t *resp_len);


/* Functions that each ctrl_iface backend must implement */

/**
 * wpa_supplicant_ctrl_iface_init - Initialize control interface
 * @wpa_s: Pointer to wpa_supplicant data
 * Returns: Pointer to private data on success, %NULL on failure
 *
 * Initialize the control interface and start receiving commands from external
 * programs.
 *
 * Required to be implemented in each control interface backend.
 */
struct ctrl_iface_priv *
wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s);

/**
 * wpa_supplicant_ctrl_iface_deinit - Deinitialize control interface
 * @wpa_s: Pointer to wpa_supplicant data
 * @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
 *
 * Deinitialize the control interface that was initialized with
 * wpa_supplicant_ctrl_iface_init() and any data related to the wpa_s instance.
 * @priv may be %NULL if the control interface has not yet been initialized.
 *
 * Required to be implemented in each control interface backend.
 */
void wpa_supplicant_ctrl_iface_deinit(struct wpa_supplicant *wpa_s,
              struct ctrl_iface_priv *priv);

/**
 * wpa_supplicant_ctrl_iface_wait - Wait for ctrl_iface monitor
 * @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
 *
 * Wait until the first message from an external program using the control
 * interface is received. This function can be used to delay normal startup
 * processing to allow control interface programs to attach with
 * %wpa_supplicant before normal operations are started.
 *
 * Required to be implemented in each control interface backend.
 */
void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv);

/**
 * wpa_supplicant_global_ctrl_iface_init - Initialize global control interface
 * @global: Pointer to global data from wpa_supplicant_init()
 * Returns: Pointer to private data on success, %NULL on failure
 *
 * Initialize the global control interface and start receiving commands from
 * external programs.
 *
 * Required to be implemented in each control interface backend.
 */
struct ctrl_iface_global_priv *
wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global);

/**
 * wpa_supplicant_global_ctrl_iface_deinit - Deinitialize global ctrl interface
 * @priv: Pointer to private data from wpa_supplicant_global_ctrl_iface_init()
 *
 * Deinitialize the global control interface that was initialized with
 * wpa_supplicant_global_ctrl_iface_init().
 *
 * Required to be implemented in each control interface backend.
 */
void wpa_supplicant_global_ctrl_iface_deinit(
  struct ctrl_iface_global_priv *priv);

void wpas_ctrl_radio_work_flush(struct wpa_supplicant *wpa_s);

int wpas_ctrl_cmd_debug_level(const char *cmd);

#else /* CONFIG_CTRL_IFACE */

static inline struct ctrl_iface_priv *
wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
{
  return (void *) -1;
}

static inline void
wpa_supplicant_ctrl_iface_deinit(struct wpa_supplicant *wpa_s,
         struct ctrl_iface_priv *priv)
{
}

static inline void
wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv, int level,
             char *buf, size_t len)
{
}

static inline void
wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
{
}

static inline struct ctrl_iface_global_priv *
wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
{
  return (void *) 1;
}

static inline void
wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
{
}

static inline void wpas_ctrl_radio_work_flush(struct wpa_supplicant *wpa_s)
{
}

#endif /* CONFIG_CTRL_IFACE */

#endif /* CTRL_IFACE_H */

Line	Count	Source (jump to first uncovered line)
1		/*
2		* WPA Supplicant / UNIX domain socket -based control interface
3		* Copyright (c) 2004-2020, Jouni Malinen <j@w1.fi>
4		*
5		* This software may be distributed under the terms of the BSD license.
6		* See README for more details.
7		*/
8
9		#ifndef CTRL_IFACE_H
10		#define CTRL_IFACE_H
11
12		#ifdef CONFIG_CTRL_IFACE
13
14		#ifndef CTRL_IFACE_MAX_LEN
15		#define CTRL_IFACE_MAX_LEN 8192
16		#endif /* CTRL_IFACE_MAX_LEN */
17
18		/* Shared functions from ctrl_iface.c; to be called by ctrl_iface backends */
19
20		/**
21		* wpa_supplicant_ctrl_iface_process - Process ctrl_iface command
22		* @wpa_s: Pointer to wpa_supplicant data
23		* @buf: Received command buffer (nul terminated string)
24		* @resp_len: Variable to be set to the response length
25		* Returns: Response (*resp_len bytes) or %NULL on failure
26		*
27		* Control interface backends call this function when receiving a message that
28		* they do not process internally, i.e., anything else than ATTACH, DETACH,
29		* and LEVEL. The return response value is then sent to the external program
30		* that sent the command. Caller is responsible for freeing the buffer after
31		* this. If %NULL is returned, *resp_len can be set to two special values:
32		* 1 = send "FAIL\n" response, 2 = send "OK\n" response. If *resp_len has any
33		* other value, no response is sent.
34		*/
35		char * wpa_supplicant_ctrl_iface_process(struct wpa_supplicant *wpa_s,
36		char buf, size_t resp_len);
37
38		/**
39		* wpa_supplicant_global_ctrl_iface_process - Process global ctrl_iface command
40		* @global: Pointer to global data from wpa_supplicant_init()
41		* @buf: Received command buffer (nul terminated string)
42		* @resp_len: Variable to be set to the response length
43		* Returns: Response (*resp_len bytes) or %NULL on failure
44		*
45		* Control interface backends call this function when receiving a message from
46		* the global ctrl_iface connection. The return response value is then sent to
47		* the external program that sent the command. Caller is responsible for
48		* freeing the buffer after this. If %NULL is returned, *resp_len can be set to
49		* two special values: 1 = send "FAIL\n" response, 2 = send "OK\n" response. If
50		* *resp_len has any other value, no response is sent.
51		*/
52		char * wpa_supplicant_global_ctrl_iface_process(struct wpa_global *global,
53		char buf, size_t resp_len);
54
55
56		/* Functions that each ctrl_iface backend must implement */
57
58		/**
59		* wpa_supplicant_ctrl_iface_init - Initialize control interface
60		* @wpa_s: Pointer to wpa_supplicant data
61		* Returns: Pointer to private data on success, %NULL on failure
62		*
63		* Initialize the control interface and start receiving commands from external
64		* programs.
65		*
66		* Required to be implemented in each control interface backend.
67		*/
68		struct ctrl_iface_priv *
69		wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s);
70
71		/**
72		* wpa_supplicant_ctrl_iface_deinit - Deinitialize control interface
73		* @wpa_s: Pointer to wpa_supplicant data
74		* @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
75		*
76		* Deinitialize the control interface that was initialized with
77		* wpa_supplicant_ctrl_iface_init() and any data related to the wpa_s instance.
78		* @priv may be %NULL if the control interface has not yet been initialized.
79		*
80		* Required to be implemented in each control interface backend.
81		*/
82		void wpa_supplicant_ctrl_iface_deinit(struct wpa_supplicant *wpa_s,
83		struct ctrl_iface_priv *priv);
84
85		/**
86		* wpa_supplicant_ctrl_iface_wait - Wait for ctrl_iface monitor
87		* @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
88		*
89		* Wait until the first message from an external program using the control
90		* interface is received. This function can be used to delay normal startup
91		* processing to allow control interface programs to attach with
92		* %wpa_supplicant before normal operations are started.
93		*
94		* Required to be implemented in each control interface backend.
95		*/
96		void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv);
97
98		/**
99		* wpa_supplicant_global_ctrl_iface_init - Initialize global control interface
100		* @global: Pointer to global data from wpa_supplicant_init()
101		* Returns: Pointer to private data on success, %NULL on failure
102		*
103		* Initialize the global control interface and start receiving commands from
104		* external programs.
105		*
106		* Required to be implemented in each control interface backend.
107		*/
108		struct ctrl_iface_global_priv *
109		wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global);
110
111		/**
112		* wpa_supplicant_global_ctrl_iface_deinit - Deinitialize global ctrl interface
113		* @priv: Pointer to private data from wpa_supplicant_global_ctrl_iface_init()
114		*
115		* Deinitialize the global control interface that was initialized with
116		* wpa_supplicant_global_ctrl_iface_init().
117		*
118		* Required to be implemented in each control interface backend.
119		*/
120		void wpa_supplicant_global_ctrl_iface_deinit(
121		struct ctrl_iface_global_priv *priv);
122
123		void wpas_ctrl_radio_work_flush(struct wpa_supplicant *wpa_s);
124
125		int wpas_ctrl_cmd_debug_level(const char *cmd);
126
127		#else /* CONFIG_CTRL_IFACE */
128
129		static inline struct ctrl_iface_priv *
130		wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
131	0	{
132	0	return (void *) -1;
133	0	} Unexecuted instantiation: wnm_sta.c:wpa_supplicant_ctrl_iface_init Unexecuted instantiation: wpa_supplicant.c:wpa_supplicant_ctrl_iface_init
134
135		static inline void
136		wpa_supplicant_ctrl_iface_deinit(struct wpa_supplicant *wpa_s,
137		struct ctrl_iface_priv *priv)
138	0	{
139	0	} Unexecuted instantiation: wnm_sta.c:wpa_supplicant_ctrl_iface_deinit Unexecuted instantiation: wpa_supplicant.c:wpa_supplicant_ctrl_iface_deinit
140
141		static inline void
142		wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv, int level,
143		char *buf, size_t len)
144	0	{
145	0	} Unexecuted instantiation: wnm_sta.c:wpa_supplicant_ctrl_iface_send Unexecuted instantiation: wpa_supplicant.c:wpa_supplicant_ctrl_iface_send
146
147		static inline void
148		wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
149	0	{
150	0	} Unexecuted instantiation: wnm_sta.c:wpa_supplicant_ctrl_iface_wait Unexecuted instantiation: wpa_supplicant.c:wpa_supplicant_ctrl_iface_wait
151
152		static inline struct ctrl_iface_global_priv *
153		wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
154	0	{
155	0	return (void *) 1;
156	0	} Unexecuted instantiation: wnm_sta.c:wpa_supplicant_global_ctrl_iface_init Unexecuted instantiation: wpa_supplicant.c:wpa_supplicant_global_ctrl_iface_init
157
158		static inline void
159		wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
160	0	{
161	0	} Unexecuted instantiation: wnm_sta.c:wpa_supplicant_global_ctrl_iface_deinit Unexecuted instantiation: wpa_supplicant.c:wpa_supplicant_global_ctrl_iface_deinit
162
163		static inline void wpas_ctrl_radio_work_flush(struct wpa_supplicant *wpa_s)
164	0	{
165	0	} Unexecuted instantiation: wnm_sta.c:wpas_ctrl_radio_work_flush Unexecuted instantiation: wpa_supplicant.c:wpas_ctrl_radio_work_flush
166
167		#endif /* CONFIG_CTRL_IFACE */
168
169		#endif /* CTRL_IFACE_H */

Coverage Report

Created: 2025-08-29 06:25