15aeb0673527a4f8d882fa1622634a1d9f7b89d1
[multipath-tools/.git] / libmpathcmd / mpath_cmd.h
1 /*
2  * Copyright (C) 2015 Red Hat, Inc.
3  *
4  * This file is part of the device-mapper multipath userspace tools.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public License
8  * as published by the Free Software Foundation; either version 2.1
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef LIB_MPATH_CMD_H
21 #define LIB_MPATH_CMD_H
22
23 /*
24  * This should be sufficient for json output for >10000 maps,
25  * and >60000 paths.
26  */
27 #define MAX_REPLY_LEN (32 * 1024 * 1024)
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 #define DEFAULT_SOCKET          "/org/kernel/linux/storage/multipathd"
34 #define DEFAULT_REPLY_TIMEOUT   4000
35
36
37 /*
38  * DESCRIPTION:
39  *      Connect to the running multipathd daemon. On systems with the
40  *      multipathd.socket systemd unit file installed, this command will
41  *      start multipathd if it is not already running. This function
42  *      must be run before any of the others in this library
43  *
44  * RETURNS:
45  *      A file descriptor on success. -1 on failure (with errno set).
46  */
47 int mpath_connect(void);
48
49
50 /*
51  * DESCRIPTION:
52  *      Disconnect from the multipathd daemon. This function must be
53  *      run after after processing all the multipath commands.
54  *
55  * RETURNS:
56  *      0 on success. -1 on failure (with errno set).
57  */
58 int mpath_disconnect(int fd);
59
60
61 /*
62  * DESCRIPTION
63  *      Send multipathd a command and return the reply. This function
64  *      does the same as calling mpath_send_cmd() and then
65  *      mpath_recv_reply()
66  *
67  * RETURNS:
68  *      0 on successs, and reply will either be NULL (if there was no
69  *      reply data), or point to the reply string, which must be freed by
70  *      the caller. -1 on failure (with errno set).
71  */
72 int mpath_process_cmd(int fd, const char *cmd, char **reply,
73                       unsigned int timeout);
74
75
76 /*
77  * DESCRIPTION:
78  *      Send a command to multipathd
79  *
80  * RETURNS:
81  *      0 on success. -1 on failure (with errno set)
82  */
83 int mpath_send_cmd(int fd, const char *cmd);
84
85
86 /*
87  * DESCRIPTION:
88  *      Return a reply from multipathd for a previously sent command.
89  *      This is equivalent to calling mpath_recv_reply_len(), allocating
90  *      a buffer of the appropriate size, and then calling
91  *      mpath_recv_reply_data() with that buffer.
92  *
93  * RETURNS:
94  *      0 on success, and reply will either be NULL (if there was no
95  *      reply data), or point to the reply string, which must be freed by
96  *      the caller, -1 on failure (with errno set).
97  */
98 int mpath_recv_reply(int fd, char **reply, unsigned int timeout);
99
100
101 /*
102  * DESCRIPTION:
103  *      Return the size of the upcoming reply data from the sent multipath
104  *      command. This must be called before calling mpath_recv_reply_data().
105  *
106  * RETURNS:
107  *      The required size of the reply data buffer on success. -1 on
108  *      failure (with errno set).
109  */
110 ssize_t mpath_recv_reply_len(int fd, unsigned int timeout);
111
112
113 /*
114  * DESCRIPTION:
115  *      Return the reply data from the sent multipath command.
116  *      mpath_recv_reply_len must be called first. reply must point to a
117  *      buffer of len size.
118  *
119  * RETURNS:
120  *      0 on success, and reply will contain the reply data string. -1
121  *      on failure (with errno set).
122  */
123 int mpath_recv_reply_data(int fd, char *reply, size_t len,
124                           unsigned int timeout);
125
126 #ifdef __cplusplus
127 }
128 #endif
129 #endif /* LIB_MPATH_CMD_H */