b57b708b02acc03008831575ba6d193f8f9b5b5c
[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
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 #ifdef __cpluscplus
24 extern "C" {
25 #endif
26
27 #define DEFAULT_SOCKET          "/org/kernel/linux/storage/multipathd"
28 #define DEFAULT_REPLY_TIMEOUT   4000
29
30
31 /*
32  * DESCRIPTION:
33  *      Connect to the running multipathd daemon. On systems with the
34  *      multipathd.socket systemd unit file installed, this command will
35  *      start multipathd if it is not already running. This function
36  *      must be run before any of the others in this library
37  *
38  * RETURNS:
39  *      A file descriptor on success. -1 on failure (with errno set).
40  */
41 int mpath_connect(void);
42
43
44 /*
45  * DESCRIPTION:
46  *      Disconnect from the multipathd daemon. This function must be
47  *      run after after processing all the multipath commands.
48  *
49  * RETURNS:
50  *      0 on success. -1 on failure (with errno set).
51  */
52 int mpath_disconnect(int fd);
53
54
55 /*
56  * DESCRIPTION
57  *      Send multipathd a command and return the reply. This function
58  *      does the same as calling mpath_send_cmd() and then
59  *      mpath_recv_reply()
60  *
61  * RETURNS:
62  *      0 on successs, and reply will either be NULL (if there was no
63  *      reply data), or point to the reply string, which must be freed by
64  *      the caller. -1 on failure (with errno set).
65  */
66 int mpath_process_cmd(int fd, const char *cmd, char **reply,
67                       unsigned int timeout);
68
69
70 /*
71  * DESCRIPTION:
72  *      Send a command to multipathd
73  *
74  * RETURNS:
75  *      0 on success. -1 on failure (with errno set)
76  */
77 int mpath_send_cmd(int fd, const char *cmd);
78
79
80 /*
81  * DESCRIPTION:
82  *      Return a reply from multipathd for a previously sent command.
83  *      This is equivalent to calling mpath_recv_reply_len(), allocating
84  *      a buffer of the appropriate size, and then calling
85  *      mpath_recv_reply_data() with that buffer.
86  *
87  * RETURNS:
88  *      0 on success, and reply will either be NULL (if there was no
89  *      reply data), or point to the reply string, which must be freed by
90  *      the caller, -1 on failure (with errno set).
91  */
92 int mpath_recv_reply(int fd, char **reply, unsigned int timeout);
93
94
95 /*
96  * DESCRIPTION:
97  *      Return the size of the upcoming reply data from the sent multipath
98  *      command. This must be called before calling mpath_recv_reply_data().
99  *
100  * RETURNS:
101  *      The required size of the reply data buffer on success. -1 on
102  *      failure (with errno set).
103  */
104 ssize_t mpath_recv_reply_len(int fd, unsigned int timeout);
105
106
107 /*
108  * DESCRIPTION:
109  *      Return the reply data from the sent multipath command.
110  *      mpath_recv_reply_len must be called first. reply must point to a
111  *      buffer of len size.
112  *
113  * RETURNS:
114  *      0 on success, and reply will contain the reply data string. -1
115  *      on failure (with errno set).
116  */
117 int mpath_recv_reply_data(int fd, char *reply, size_t len,
118                           unsigned int timeout);
119
120 #ifdef __cplusplus
121 }
122 #endif
123 #endif /* LIB_MPATH_CMD_H */