Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * An implementation of the host initiated guest snapshot for Hyper-V.
4 *
5 * Copyright (C) 2013, Microsoft, Inc.
6 * Author : K. Y. Srinivasan <kys@microsoft.com>
7 */
8
9
10#include <sys/types.h>
11#include <sys/poll.h>
12#include <sys/ioctl.h>
13#include <sys/stat.h>
14#include <sys/sysmacros.h>
15#include <fcntl.h>
16#include <stdio.h>
17#include <mntent.h>
18#include <stdlib.h>
19#include <unistd.h>
20#include <string.h>
21#include <ctype.h>
22#include <errno.h>
23#include <linux/fs.h>
24#include <linux/major.h>
25#include <linux/hyperv.h>
26#include <syslog.h>
27#include <getopt.h>
28#include <stdbool.h>
29#include <dirent.h>
30
31static bool fs_frozen;
32
33/* Don't use syslog() in the function since that can cause write to disk */
34static int vss_do_freeze(char *dir, unsigned int cmd)
35{
36 int ret, fd = open(dir, O_RDONLY);
37
38 if (fd < 0)
39 return 1;
40
41 ret = ioctl(fd, cmd, 0);
42
43 /*
44 * If a partition is mounted more than once, only the first
45 * FREEZE/THAW can succeed and the later ones will get
46 * EBUSY/EINVAL respectively: there could be 2 cases:
47 * 1) a user may mount the same partition to different directories
48 * by mistake or on purpose;
49 * 2) The subvolume of btrfs appears to have the same partition
50 * mounted more than once.
51 */
52 if (ret) {
53 if ((cmd == FIFREEZE && errno == EBUSY) ||
54 (cmd == FITHAW && errno == EINVAL)) {
55 close(fd);
56 return 0;
57 }
58 }
59
60 close(fd);
61 return !!ret;
62}
63
64static bool is_dev_loop(const char *blkname)
65{
66 char *buffer;
67 DIR *dir;
68 struct dirent *entry;
69 bool ret = false;
70
71 buffer = malloc(PATH_MAX);
72 if (!buffer) {
73 syslog(LOG_ERR, "Can't allocate memory!");
74 exit(1);
75 }
76
77 snprintf(buffer, PATH_MAX, "%s/loop", blkname);
78 if (!access(buffer, R_OK | X_OK)) {
79 ret = true;
80 goto free_buffer;
81 } else if (errno != ENOENT) {
82 syslog(LOG_ERR, "Can't access: %s; error:%d %s!",
83 buffer, errno, strerror(errno));
84 }
85
86 snprintf(buffer, PATH_MAX, "%s/slaves", blkname);
87 dir = opendir(buffer);
88 if (!dir) {
89 if (errno != ENOENT)
90 syslog(LOG_ERR, "Can't opendir: %s; error:%d %s!",
91 buffer, errno, strerror(errno));
92 goto free_buffer;
93 }
94
95 while ((entry = readdir(dir)) != NULL) {
96 if (strcmp(entry->d_name, ".") == 0 ||
97 strcmp(entry->d_name, "..") == 0)
98 continue;
99
100 snprintf(buffer, PATH_MAX, "%s/slaves/%s", blkname,
101 entry->d_name);
102 if (is_dev_loop(buffer)) {
103 ret = true;
104 break;
105 }
106 }
107 closedir(dir);
108free_buffer:
109 free(buffer);
110 return ret;
111}
112
113static int vss_operate(int operation)
114{
115 char match[] = "/dev/";
116 FILE *mounts;
117 struct mntent *ent;
118 struct stat sb;
119 char errdir[1024] = {0};
120 char blkdir[23]; /* /sys/dev/block/XXX:XXX */
121 unsigned int cmd;
122 int error = 0, root_seen = 0, save_errno = 0;
123
124 switch (operation) {
125 case VSS_OP_FREEZE:
126 cmd = FIFREEZE;
127 break;
128 case VSS_OP_THAW:
129 cmd = FITHAW;
130 break;
131 default:
132 return -1;
133 }
134
135 mounts = setmntent("/proc/mounts", "r");
136 if (mounts == NULL)
137 return -1;
138
139 while ((ent = getmntent(mounts))) {
140 if (strncmp(ent->mnt_fsname, match, strlen(match)))
141 continue;
142 if (stat(ent->mnt_fsname, &sb)) {
143 syslog(LOG_ERR, "Can't stat: %s; error:%d %s!",
144 ent->mnt_fsname, errno, strerror(errno));
145 } else {
146 sprintf(blkdir, "/sys/dev/block/%d:%d",
147 major(sb.st_rdev), minor(sb.st_rdev));
148 if (is_dev_loop(blkdir))
149 continue;
150 }
151 if (hasmntopt(ent, MNTOPT_RO) != NULL)
152 continue;
153 if (strcmp(ent->mnt_type, "vfat") == 0)
154 continue;
155 if (strcmp(ent->mnt_dir, "/") == 0) {
156 root_seen = 1;
157 continue;
158 }
159 error |= vss_do_freeze(ent->mnt_dir, cmd);
160 if (operation == VSS_OP_FREEZE) {
161 if (error)
162 goto err;
163 fs_frozen = true;
164 }
165 }
166
167 endmntent(mounts);
168
169 if (root_seen) {
170 error |= vss_do_freeze("/", cmd);
171 if (operation == VSS_OP_FREEZE) {
172 if (error)
173 goto err;
174 fs_frozen = true;
175 }
176 }
177
178 if (operation == VSS_OP_THAW && !error)
179 fs_frozen = false;
180
181 goto out;
182err:
183 save_errno = errno;
184 if (ent) {
185 strncpy(errdir, ent->mnt_dir, sizeof(errdir)-1);
186 endmntent(mounts);
187 }
188 vss_operate(VSS_OP_THAW);
189 fs_frozen = false;
190 /* Call syslog after we thaw all filesystems */
191 if (ent)
192 syslog(LOG_ERR, "FREEZE of %s failed; error:%d %s",
193 errdir, save_errno, strerror(save_errno));
194 else
195 syslog(LOG_ERR, "FREEZE of / failed; error:%d %s", save_errno,
196 strerror(save_errno));
197out:
198 return error;
199}
200
201void print_usage(char *argv[])
202{
203 fprintf(stderr, "Usage: %s [options]\n"
204 "Options are:\n"
205 " -n, --no-daemon stay in foreground, don't daemonize\n"
206 " -h, --help print this help\n", argv[0]);
207}
208
209int main(int argc, char *argv[])
210{
211 int vss_fd = -1, len;
212 int error;
213 struct pollfd pfd;
214 int op;
215 struct hv_vss_msg vss_msg[1];
216 int daemonize = 1, long_index = 0, opt;
217 int in_handshake;
218 __u32 kernel_modver;
219
220 static struct option long_options[] = {
221 {"help", no_argument, 0, 'h' },
222 {"no-daemon", no_argument, 0, 'n' },
223 {0, 0, 0, 0 }
224 };
225
226 while ((opt = getopt_long(argc, argv, "hn", long_options,
227 &long_index)) != -1) {
228 switch (opt) {
229 case 'n':
230 daemonize = 0;
231 break;
232 case 'h':
233 print_usage(argv);
234 exit(0);
235 default:
236 print_usage(argv);
237 exit(EXIT_FAILURE);
238 }
239 }
240
241 if (daemonize && daemon(1, 0))
242 return 1;
243
244 openlog("Hyper-V VSS", 0, LOG_USER);
245 syslog(LOG_INFO, "VSS starting; pid is:%d", getpid());
246
247reopen_vss_fd:
248 if (vss_fd != -1)
249 close(vss_fd);
250 if (fs_frozen) {
251 if (vss_operate(VSS_OP_THAW) || fs_frozen) {
252 syslog(LOG_ERR, "failed to thaw file system: err=%d",
253 errno);
254 exit(EXIT_FAILURE);
255 }
256 }
257
258 in_handshake = 1;
259 vss_fd = open("/dev/vmbus/hv_vss", O_RDWR);
260 if (vss_fd < 0) {
261 syslog(LOG_ERR, "open /dev/vmbus/hv_vss failed; error: %d %s",
262 errno, strerror(errno));
263 exit(EXIT_FAILURE);
264 }
265 /*
266 * Register ourselves with the kernel.
267 */
268 vss_msg->vss_hdr.operation = VSS_OP_REGISTER1;
269
270 len = write(vss_fd, vss_msg, sizeof(struct hv_vss_msg));
271 if (len < 0) {
272 syslog(LOG_ERR, "registration to kernel failed; error: %d %s",
273 errno, strerror(errno));
274 close(vss_fd);
275 exit(EXIT_FAILURE);
276 }
277
278 pfd.fd = vss_fd;
279
280 while (1) {
281 pfd.events = POLLIN;
282 pfd.revents = 0;
283
284 if (poll(&pfd, 1, -1) < 0) {
285 syslog(LOG_ERR, "poll failed; error:%d %s", errno, strerror(errno));
286 if (errno == EINVAL) {
287 close(vss_fd);
288 exit(EXIT_FAILURE);
289 }
290 else
291 continue;
292 }
293
294 len = read(vss_fd, vss_msg, sizeof(struct hv_vss_msg));
295
296 if (in_handshake) {
297 if (len != sizeof(kernel_modver)) {
298 syslog(LOG_ERR, "invalid version negotiation");
299 exit(EXIT_FAILURE);
300 }
301 kernel_modver = *(__u32 *)vss_msg;
302 in_handshake = 0;
303 syslog(LOG_INFO, "VSS: kernel module version: %d",
304 kernel_modver);
305 continue;
306 }
307
308 if (len != sizeof(struct hv_vss_msg)) {
309 syslog(LOG_ERR, "read failed; error:%d %s",
310 errno, strerror(errno));
311 goto reopen_vss_fd;
312 }
313
314 op = vss_msg->vss_hdr.operation;
315 error = HV_S_OK;
316
317 switch (op) {
318 case VSS_OP_FREEZE:
319 case VSS_OP_THAW:
320 error = vss_operate(op);
321 syslog(LOG_INFO, "VSS: op=%s: %s\n",
322 op == VSS_OP_FREEZE ? "FREEZE" : "THAW",
323 error ? "failed" : "succeeded");
324
325 if (error) {
326 error = HV_E_FAIL;
327 syslog(LOG_ERR, "op=%d failed!", op);
328 syslog(LOG_ERR, "report it with these files:");
329 syslog(LOG_ERR, "/etc/fstab and /proc/mounts");
330 }
331 break;
332 case VSS_OP_HOT_BACKUP:
333 syslog(LOG_INFO, "VSS: op=CHECK HOT BACKUP\n");
334 break;
335 default:
336 syslog(LOG_ERR, "Illegal op:%d\n", op);
337 }
338
339 /*
340 * The write() may return an error due to the faked VSS_OP_THAW
341 * message upon hibernation. Ignore the error by resetting the
342 * dev file, i.e. closing and re-opening it.
343 */
344 vss_msg->error = error;
345 len = write(vss_fd, vss_msg, sizeof(struct hv_vss_msg));
346 if (len != sizeof(struct hv_vss_msg)) {
347 syslog(LOG_ERR, "write failed; error: %d %s", errno,
348 strerror(errno));
349 goto reopen_vss_fd;
350 }
351 }
352
353 close(vss_fd);
354 exit(0);
355}
1/*
2 * An implementation of the host initiated guest snapshot for Hyper-V.
3 *
4 *
5 * Copyright (C) 2013, Microsoft, Inc.
6 * Author : K. Y. Srinivasan <kys@microsoft.com>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published
10 * by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
15 * NON INFRINGEMENT. See the GNU General Public License for more
16 * details.
17 *
18 */
19
20
21#include <sys/types.h>
22#include <sys/poll.h>
23#include <sys/ioctl.h>
24#include <sys/stat.h>
25#include <sys/sysmacros.h>
26#include <fcntl.h>
27#include <stdio.h>
28#include <mntent.h>
29#include <stdlib.h>
30#include <unistd.h>
31#include <string.h>
32#include <ctype.h>
33#include <errno.h>
34#include <linux/fs.h>
35#include <linux/major.h>
36#include <linux/hyperv.h>
37#include <syslog.h>
38#include <getopt.h>
39
40/* Don't use syslog() in the function since that can cause write to disk */
41static int vss_do_freeze(char *dir, unsigned int cmd)
42{
43 int ret, fd = open(dir, O_RDONLY);
44
45 if (fd < 0)
46 return 1;
47
48 ret = ioctl(fd, cmd, 0);
49
50 /*
51 * If a partition is mounted more than once, only the first
52 * FREEZE/THAW can succeed and the later ones will get
53 * EBUSY/EINVAL respectively: there could be 2 cases:
54 * 1) a user may mount the same partition to differnt directories
55 * by mistake or on purpose;
56 * 2) The subvolume of btrfs appears to have the same partition
57 * mounted more than once.
58 */
59 if (ret) {
60 if ((cmd == FIFREEZE && errno == EBUSY) ||
61 (cmd == FITHAW && errno == EINVAL)) {
62 close(fd);
63 return 0;
64 }
65 }
66
67 close(fd);
68 return !!ret;
69}
70
71static int vss_operate(int operation)
72{
73 char match[] = "/dev/";
74 FILE *mounts;
75 struct mntent *ent;
76 struct stat sb;
77 char errdir[1024] = {0};
78 unsigned int cmd;
79 int error = 0, root_seen = 0, save_errno = 0;
80
81 switch (operation) {
82 case VSS_OP_FREEZE:
83 cmd = FIFREEZE;
84 break;
85 case VSS_OP_THAW:
86 cmd = FITHAW;
87 break;
88 default:
89 return -1;
90 }
91
92 mounts = setmntent("/proc/mounts", "r");
93 if (mounts == NULL)
94 return -1;
95
96 while ((ent = getmntent(mounts))) {
97 if (strncmp(ent->mnt_fsname, match, strlen(match)))
98 continue;
99 if (stat(ent->mnt_fsname, &sb) == -1)
100 continue;
101 if (S_ISBLK(sb.st_mode) && major(sb.st_rdev) == LOOP_MAJOR)
102 continue;
103 if (hasmntopt(ent, MNTOPT_RO) != NULL)
104 continue;
105 if (strcmp(ent->mnt_type, "vfat") == 0)
106 continue;
107 if (strcmp(ent->mnt_dir, "/") == 0) {
108 root_seen = 1;
109 continue;
110 }
111 error |= vss_do_freeze(ent->mnt_dir, cmd);
112 if (error && operation == VSS_OP_FREEZE)
113 goto err;
114 }
115
116 endmntent(mounts);
117
118 if (root_seen) {
119 error |= vss_do_freeze("/", cmd);
120 if (error && operation == VSS_OP_FREEZE)
121 goto err;
122 }
123
124 goto out;
125err:
126 save_errno = errno;
127 if (ent) {
128 strncpy(errdir, ent->mnt_dir, sizeof(errdir)-1);
129 endmntent(mounts);
130 }
131 vss_operate(VSS_OP_THAW);
132 /* Call syslog after we thaw all filesystems */
133 if (ent)
134 syslog(LOG_ERR, "FREEZE of %s failed; error:%d %s",
135 errdir, save_errno, strerror(save_errno));
136 else
137 syslog(LOG_ERR, "FREEZE of / failed; error:%d %s", save_errno,
138 strerror(save_errno));
139out:
140 return error;
141}
142
143void print_usage(char *argv[])
144{
145 fprintf(stderr, "Usage: %s [options]\n"
146 "Options are:\n"
147 " -n, --no-daemon stay in foreground, don't daemonize\n"
148 " -h, --help print this help\n", argv[0]);
149}
150
151int main(int argc, char *argv[])
152{
153 int vss_fd, len;
154 int error;
155 struct pollfd pfd;
156 int op;
157 struct hv_vss_msg vss_msg[1];
158 int daemonize = 1, long_index = 0, opt;
159 int in_handshake = 1;
160 __u32 kernel_modver;
161
162 static struct option long_options[] = {
163 {"help", no_argument, 0, 'h' },
164 {"no-daemon", no_argument, 0, 'n' },
165 {0, 0, 0, 0 }
166 };
167
168 while ((opt = getopt_long(argc, argv, "hn", long_options,
169 &long_index)) != -1) {
170 switch (opt) {
171 case 'n':
172 daemonize = 0;
173 break;
174 case 'h':
175 default:
176 print_usage(argv);
177 exit(EXIT_FAILURE);
178 }
179 }
180
181 if (daemonize && daemon(1, 0))
182 return 1;
183
184 openlog("Hyper-V VSS", 0, LOG_USER);
185 syslog(LOG_INFO, "VSS starting; pid is:%d", getpid());
186
187 vss_fd = open("/dev/vmbus/hv_vss", O_RDWR);
188 if (vss_fd < 0) {
189 syslog(LOG_ERR, "open /dev/vmbus/hv_vss failed; error: %d %s",
190 errno, strerror(errno));
191 exit(EXIT_FAILURE);
192 }
193 /*
194 * Register ourselves with the kernel.
195 */
196 vss_msg->vss_hdr.operation = VSS_OP_REGISTER1;
197
198 len = write(vss_fd, vss_msg, sizeof(struct hv_vss_msg));
199 if (len < 0) {
200 syslog(LOG_ERR, "registration to kernel failed; error: %d %s",
201 errno, strerror(errno));
202 close(vss_fd);
203 exit(EXIT_FAILURE);
204 }
205
206 pfd.fd = vss_fd;
207
208 while (1) {
209 pfd.events = POLLIN;
210 pfd.revents = 0;
211
212 if (poll(&pfd, 1, -1) < 0) {
213 syslog(LOG_ERR, "poll failed; error:%d %s", errno, strerror(errno));
214 if (errno == EINVAL) {
215 close(vss_fd);
216 exit(EXIT_FAILURE);
217 }
218 else
219 continue;
220 }
221
222 len = read(vss_fd, vss_msg, sizeof(struct hv_vss_msg));
223
224 if (in_handshake) {
225 if (len != sizeof(kernel_modver)) {
226 syslog(LOG_ERR, "invalid version negotiation");
227 exit(EXIT_FAILURE);
228 }
229 kernel_modver = *(__u32 *)vss_msg;
230 in_handshake = 0;
231 syslog(LOG_INFO, "VSS: kernel module version: %d",
232 kernel_modver);
233 continue;
234 }
235
236 if (len != sizeof(struct hv_vss_msg)) {
237 syslog(LOG_ERR, "read failed; error:%d %s",
238 errno, strerror(errno));
239 close(vss_fd);
240 return EXIT_FAILURE;
241 }
242
243 op = vss_msg->vss_hdr.operation;
244 error = HV_S_OK;
245
246 switch (op) {
247 case VSS_OP_FREEZE:
248 case VSS_OP_THAW:
249 error = vss_operate(op);
250 syslog(LOG_INFO, "VSS: op=%s: %s\n",
251 op == VSS_OP_FREEZE ? "FREEZE" : "THAW",
252 error ? "failed" : "succeeded");
253
254 if (error) {
255 error = HV_E_FAIL;
256 syslog(LOG_ERR, "op=%d failed!", op);
257 syslog(LOG_ERR, "report it with these files:");
258 syslog(LOG_ERR, "/etc/fstab and /proc/mounts");
259 }
260 break;
261 case VSS_OP_HOT_BACKUP:
262 syslog(LOG_INFO, "VSS: op=CHECK HOT BACKUP\n");
263 break;
264 default:
265 syslog(LOG_ERR, "Illegal op:%d\n", op);
266 }
267 vss_msg->error = error;
268 len = write(vss_fd, vss_msg, sizeof(struct hv_vss_msg));
269 if (len != sizeof(struct hv_vss_msg)) {
270 syslog(LOG_ERR, "write failed; error: %d %s", errno,
271 strerror(errno));
272
273 if (op == VSS_OP_FREEZE)
274 vss_operate(VSS_OP_THAW);
275 }
276 }
277
278 close(vss_fd);
279 exit(0);
280}