1 /*
2 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
3 * Copyright 2017 Nexenta Systems, Inc. All rights reserved.
4 */
5
6 /*
7 * BSD 3 Clause License
8 *
9 * Copyright (c) 2007, The Storage Networking Industry Association.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * - Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 *
17 * - Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in
19 * the documentation and/or other materials provided with the
20 * distribution.
21 *
22 * - Neither the name of The Storage Networking Industry Association (SNIA)
23 * nor the names of its contributors may be used to endorse or promote
24 * products derived from this software without specific prior written
25 * permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39 /* Copyright (c) 2007, The Storage Networking Industry Association. */
40 /* Copyright (c) 1996, 1997 PDC, Network Appliance. All Rights Reserved */
41 /* Copyright 2017 Nexenta Systems, Inc. All rights reserved. */
42
43 #include <sys/stat.h>
44 #include <sys/types.h>
45 #include <sys/socket.h>
46 #include <syslog.h>
47 #include <errno.h>
48 #include <stdio.h>
49 #include <string.h>
50 #include <unistd.h>
51 #include <time.h>
52 #include <cstack.h>
53 #include <dirent.h>
54 #include <traverse.h>
55 #include "bitmap.h"
56 #include "ndmpd.h"
57 #include "tlm_buffers.h"
58
59
60 typedef struct ndmp_run_args {
61 char *nr_chkp_nm;
62 char *nr_unchkp_nm;
63 char **nr_excls;
64 } ndmp_run_args_t;
65
66
67 /*
68 * backup_create_structs
69 *
70 * Allocate the structures before performing backup
71 *
72 * Parameters:
73 * sesison (input) - session handle
74 * jname (input) - backup job name
75 *
76 * Returns:
77 * 0: on success
78 * -1: otherwise
79 */
80 static int
81 backup_create_structs(ndmpd_session_t *session, char *jname)
82 {
83 int n;
84 long xfer_size;
85 ndmp_lbr_params_t *nlp;
86 tlm_commands_t *cmds;
87
88 if ((nlp = ndmp_get_nlp(session)) == NULL) {
89 return (-1);
90 }
91
92 if ((nlp->nlp_jstat = tlm_new_job_stats(jname)) == NULL) {
93 return (-1);
94 }
95
96 cmds = &nlp->nlp_cmds;
97 (void) memset(cmds, 0, sizeof (*cmds));
98
99 xfer_size = ndmp_buffer_get_size(session);
100 if (xfer_size < 512*KILOBYTE) {
101 /*
102 * Read multiple of mover_record_size near to 512K. This
103 * will prevent the data being copied in the mover buffer
104 * when we write the data.
105 */
106 if ((n = (512 * KILOBYTE/xfer_size)) <= 0)
107 n = 1;
108 xfer_size *= n;
109 syslog(LOG_DEBUG, "Adjusted read size: %d", xfer_size);
110 }
111
112 cmds->tcs_command = tlm_create_reader_writer_ipc(TRUE, xfer_size);
113 if (cmds->tcs_command == NULL) {
114 syslog(LOG_ERR, "Error creating ipc buffers");
115 tlm_un_ref_job_stats(jname);
116 return (-1);
117 }
118
119 nlp->nlp_logcallbacks = lbrlog_callbacks_init(session,
120 ndmpd_file_history_path,
121 ndmpd_file_history_dir,
122 ndmpd_file_history_node);
123 if (nlp->nlp_logcallbacks == NULL) {
124 tlm_release_reader_writer_ipc(cmds->tcs_command);
125 tlm_un_ref_job_stats(jname);
126 return (-1);
127 }
128 nlp->nlp_jstat->js_callbacks = (void *)(nlp->nlp_logcallbacks);
129
130 return (0);
131 }
132
133
134 /*
135 * restore_create_structs
136 *
137 * Allocate structures for performing a restore
138 *
139 * Parameters:
140 * sesison (input) - session handle
141 * jname (input) - backup job name
142 *
143 * Returns:
144 * 0: on success
145 * -1: otherwise
146 */
147 static int
148 restore_create_structs(ndmpd_session_t *session, char *jname)
149 {
150 int i;
151 long xfer_size;
152 ndmp_lbr_params_t *nlp;
153 tlm_commands_t *cmds;
154
155 if ((nlp = ndmp_get_nlp(session)) == NULL) {
156 return (-1);
157 }
158 if ((nlp->nlp_jstat = tlm_new_job_stats(jname)) == NULL) {
159 return (-1);
160 }
161
162 cmds = &nlp->nlp_cmds;
163 (void) memset(cmds, 0, sizeof (*cmds));
164
165 xfer_size = ndmp_buffer_get_size(session);
166 cmds->tcs_command = tlm_create_reader_writer_ipc(FALSE, xfer_size);
167 if (cmds->tcs_command == NULL) {
168 syslog(LOG_ERR, "Error creating ipc buffers");
169 tlm_un_ref_job_stats(jname);
170 return (-1);
171 }
172
173 nlp->nlp_logcallbacks = lbrlog_callbacks_init(session,
174 ndmpd_path_restored, NULL, NULL);
175 if (nlp->nlp_logcallbacks == NULL) {
176 tlm_release_reader_writer_ipc(cmds->tcs_command);
177 tlm_un_ref_job_stats(jname);
178 return (-1);
179 }
180 nlp->nlp_jstat->js_callbacks = (void *)(nlp->nlp_logcallbacks);
181
182 nlp->nlp_restored = ndmp_malloc(sizeof (boolean_t) * nlp->nlp_nfiles);
183 if (nlp->nlp_restored == NULL) {
184 lbrlog_callbacks_done(nlp->nlp_logcallbacks);
185 tlm_release_reader_writer_ipc(cmds->tcs_command);
186 tlm_un_ref_job_stats(jname);
187 return (-1);
188 }
189 for (i = 0; i < (int)nlp->nlp_nfiles; i++)
190 nlp->nlp_restored[i] = FALSE;
191
192 return (0);
193 }
194
195
196 /*
197 * send_unrecovered_list
198 *
199 * Creates a list of restored files
200 *
201 * Parameters:
202 * params (input) - NDMP parameters
203 * nlp (input) - NDMP/LBR parameters
204 *
205 * Returns:
206 * 0: on success
207 * -1: otherwise
208 */
209 static int
210 send_unrecovered_list(ndmpd_module_params_t *params, ndmp_lbr_params_t *nlp)
211 {
212 int i, rv;
213 ndmp_name *ent;
214
215 if (params == NULL) {
216 return (-1);
217 }
218 if (nlp == NULL) {
219 return (-1);
220 }
221
222 rv = 0;
223 for (i = 0; i < (int)nlp->nlp_nfiles; i++) {
224 syslog(LOG_DEBUG, "nlp->nlp_restored[%d]: %s", i,
225 nlp->nlp_restored[i] ? "TRUE" : "FALSE");
226
227 if (!nlp->nlp_restored[i]) {
228 ent = (ndmp_name *)MOD_GETNAME(params, i);
229 if (ent == NULL) {
230 rv = -1;
231 break;
232 }
233 if (ent->name == NULL) {
234 rv = -1;
235 break;
236 }
237
238 syslog(LOG_DEBUG, "ent.name: \"%s\"", ent->name);
239
240 rv = MOD_FILERECOVERD(params, ent->name, ENOENT);
241 if (rv < 0)
242 break;
243 }
244 }
245
246 return (rv);
247 }
248
249
250 /*
251 * backup_release_structs
252 *
253 * Deallocated the NDMP/LBR specific parameters
254 *
255 * Parameters:
256 * session (input) - session handle
257 *
258 * Returns:
259 * void
260 */
261 /*ARGSUSED*/
262 static void
263 backup_release_structs(ndmpd_session_t *session)
264 {
265 ndmp_lbr_params_t *nlp;
266 tlm_commands_t *cmds;
267
268 if ((nlp = ndmp_get_nlp(session)) == NULL) {
269 return;
270 }
271 cmds = &nlp->nlp_cmds;
272 if (cmds == NULL) {
273 return;
274 }
275
276 if (nlp->nlp_logcallbacks != NULL) {
277 lbrlog_callbacks_done(nlp->nlp_logcallbacks);
278 nlp->nlp_logcallbacks = NULL;
279 }
280
281 if (cmds->tcs_command != NULL) {
282 if (cmds->tcs_command->tc_buffers != NULL)
283 tlm_release_reader_writer_ipc(cmds->tcs_command);
284 cmds->tcs_command = NULL;
285 }
286
287 if (nlp->nlp_bkmap >= 0) {
288 (void) dbm_free(nlp->nlp_bkmap);
289 nlp->nlp_bkmap = -1;
290 }
291
292 if (session->ns_data.dd_operation == NDMP_DATA_OP_RECOVER &&
293 nlp->nlp_restored != NULL) {
294 free(nlp->nlp_restored);
295 nlp->nlp_restored = NULL;
296 }
297 }
298
299 /*
300 * ndmp_write_utf8magic
301 *
302 * Write a magic pattern to the tar header. This is used
303 * as a crest to indicate that tape belongs to us.
304 */
305 int
306 ndmp_write_utf8magic(tlm_cmd_t *cmd)
307 {
308 char *cp;
309 long actual_size;
310
311 if (cmd->tc_buffers == NULL) {
312 return (-1);
313 }
314
315 cp = tlm_get_write_buffer(RECORDSIZE, &actual_size,
316 cmd->tc_buffers, TRUE);
317 if (actual_size < RECORDSIZE) {
318 return (-1);
319 }
320
321 (void) strlcpy(cp, NDMPUTF8MAGIC, RECORDSIZE);
322 return (0);
323 }
324
325
326 /*
327 * timecmp
328 *
329 * This callback function is used during backup. It checks
330 * if the object specified by the 'attr' should be backed
331 * up or not.
332 *
333 * Directories are backed up anyways for dump format.
334 * If this function is called, then the directory is
335 * marked in the bitmap vector, it shows that either the
336 * directory itself is modified or there is something below
337 * it that will be backed up.
338 *
339 * Directories for tar format are backed up if and only if
340 * they are modified.
341 *
342 * By setting ndmp_force_bk_dirs global variable to a non-zero
343 * value, directories are backed up anyways.
344 *
345 * Backing up the directories unconditionally, helps
346 * restoring the metadata of directories as well, when one
347 * of the objects below them are being restored.
348 *
349 * For non-directory objects, if the modification or change
350 * time of the object is after the date specified by the
351 * bk_selector_t, the the object must be backed up.
352 *
353 */
354 static boolean_t
355 timecmp(bk_selector_t *bksp,
356 struct stat64 *attr)
357 {
358 ndmp_lbr_params_t *nlp;
359
360 nlp = (ndmp_lbr_params_t *)bksp->bs_cookie;
361 if (S_ISDIR(attr->st_mode) && ndmp_force_bk_dirs) {
362 return (TRUE);
363 }
364 if (S_ISDIR(attr->st_mode) &&
365 dbm_getone(nlp->nlp_bkmap, (u_longlong_t)attr->st_ino) &&
366 ((NLP_ISDUMP(nlp) && ndmp_dump_path_node) ||
367 (NLP_ISTAR(nlp) && ndmp_tar_path_node))) {
368 /*
369 * If the object is a directory and it leads to a modified
370 * object (that should be backed up) and for that type of
371 * backup the path nodes should be backed up, then return
372 * TRUE.
373 *
374 * This is required by some DMAs like Backup Express, which
375 * needs to receive ADD_NODE (for dump) or ADD_PATH (for tar)
376 * for the intermediate directories of a modified object.
377 * Other DMAs, like net_backup and net_worker, do not have such
378 * requirement. This requirement makes sense for dump format
379 * but for 'tar' format, it does not. In provision to the
380 * NDMP-v4 spec, for 'tar' format the intermediate directories
381 * need not to be reported.
382 */
383 syslog(LOG_DEBUG, "p(%lu)", (u_longlong_t)attr->st_ino);
384 return (TRUE);
385 }
386 if (attr->st_mtime > bksp->bs_ldate) {
387 syslog(LOG_DEBUG, "m(%lu): %lu > %lu",
388 (uint_t)attr->st_ino, (uint_t)attr->st_mtime,
389 (uint_t)bksp->bs_ldate);
390 return (TRUE);
391 }
392 if (attr->st_ctime > bksp->bs_ldate) {
393 if (NLP_IGNCTIME(nlp)) {
394 syslog(LOG_DEBUG, "ign c(%lu): %lu > %lu",
395 (uint_t)attr->st_ino, (uint_t)attr->st_ctime,
396 (uint_t)bksp->bs_ldate);
397 return (FALSE);
398 }
399 syslog(LOG_DEBUG, "c(%lu): %lu > %lu",
400 (uint_t)attr->st_ino, (uint_t)attr->st_ctime,
401 (uint_t)bksp->bs_ldate);
402 return (TRUE);
403 }
404 syslog(LOG_DEBUG, "mc(%lu): (%lu,%lu) < %lu",
405 (uint_t)attr->st_ino, (uint_t)attr->st_mtime,
406 (uint_t)attr->st_ctime, (uint_t)bksp->bs_ldate);
407 return (FALSE);
408 }
409
410
411 /*
412 * get_acl_info
413 *
414 * load up all the access and attribute info
415 */
416 static int
417 get_acl_info(char *name, tlm_acls_t *tlm_acls)
418 {
419 int erc;
420 acl_t *aclp = NULL;
421 char *acltp;
422
423 erc = lstat64(name, &tlm_acls->acl_attr);
424 if (erc != 0) {
425 syslog(LOG_ERR, "Could not find file %s.", name);
426 erc = TLM_NO_SOURCE_FILE;
427 return (erc);
428 }
429 erc = acl_get(name, ACL_NO_TRIVIAL, &aclp);
430 if (erc != 0) {
431 syslog(LOG_DEBUG,
432 "Could not read ACL for file [%s]", name);
433 erc = TLM_NO_SOURCE_FILE;
434 return (erc);
435 }
436 if (aclp && (acltp = acl_totext(aclp,
437 ACL_APPEND_ID | ACL_SID_FMT | ACL_COMPACT_FMT)) != NULL) {
438 (void) strlcpy(tlm_acls->acl_info.attr_info, acltp,
439 TLM_MAX_ACL_TXT);
440 acl_free(aclp);
441 free(acltp);
442 }
443 return (erc);
444 }
445 /*
446 * get_dir_acl_info
447 *
448 * load up all ACL and attr info about a directory
449 */
450 static int
451 get_dir_acl_info(char *dir, tlm_acls_t *tlm_acls, tlm_job_stats_t *js)
452 {
453 int erc;
454 char *checkpointed_dir;
455 char root_dir[TLM_VOLNAME_MAX_LENGTH];
456 char *spot;
457 char *fil;
458 acl_t *aclp = NULL;
459 char *acltp;
460
461 checkpointed_dir = ndmp_malloc(TLM_MAX_PATH_NAME);
462 if (checkpointed_dir == NULL)
463 return (-1);
464
465 if (tlm_acls->acl_checkpointed)
466 fil = tlm_build_snapshot_name(dir, checkpointed_dir,
467 js->js_job_name);
468 else
469 fil = dir;
470 erc = lstat64(fil, &tlm_acls->acl_attr);
471 if (erc != 0) {
472 syslog(LOG_ERR, "Could not find directory %s.", dir);
473 free(checkpointed_dir);
474 return (-1);
475 }
476
477 spot = strchr(&fil[1], '/');
478 if (spot == NULL) {
479 (void) strlcpy(root_dir, fil, TLM_VOLNAME_MAX_LENGTH);
480 } else {
481 *spot = 0;
482 (void) strlcpy(root_dir, fil, TLM_VOLNAME_MAX_LENGTH);
483 *spot = '/';
484 }
485 if (strcmp(root_dir, tlm_acls->acl_root_dir) != 0) {
486 struct stat64 attr;
487
488 erc = lstat64(root_dir, &attr);
489 if (erc != 0) {
490 syslog(LOG_ERR, "Cannot find root directory %s.",
491 root_dir);
492 free(checkpointed_dir);
493 return (-1);
494 }
495 (void) strlcpy(tlm_acls->acl_root_dir, root_dir,
496 TLM_VOLNAME_MAX_LENGTH);
497 }
498 erc = acl_get(fil, ACL_NO_TRIVIAL, &aclp);
499 if (erc != 0) {
500 syslog(LOG_DEBUG,
501 "Could not read metadata for directory [%s]", dir);
502 free(checkpointed_dir);
503 return (-1);
504 }
505 if (aclp && (acltp = acl_totext(aclp,
506 ACL_APPEND_ID | ACL_SID_FMT | ACL_COMPACT_FMT)) != NULL) {
507 (void) strlcpy(tlm_acls->acl_info.attr_info, acltp,
508 TLM_MAX_ACL_TXT);
509 acl_free(aclp);
510 free(acltp);
511 }
512
513 free(checkpointed_dir);
514 return (0);
515 }
516
517 /*
518 * backup_dir
519 *
520 * Create a TAR entry record for a directory
521 */
522 static int
523 backup_dir(char *dir, tlm_acls_t *tlm_acls,
524 tlm_cmd_t *local_commands, tlm_job_stats_t *job_stats,
525 bk_selector_t *bksp)
526 {
527 int erc;
528
529 erc = get_dir_acl_info(dir, tlm_acls, job_stats);
530 if (erc != 0) {
531 syslog(LOG_ERR,
532 "Could not read directory info for %s", dir);
533 job_stats->js_errors++;
534 } else {
535 /*
536 * See if the directory must be backed up.
537 */
538 if (bksp && !(*bksp->bs_fn)(bksp, &tlm_acls->acl_attr)) {
539 syslog(LOG_DEBUG, "[%s] dir skipped", dir);
540 return (erc);
541 }
542
543 if (tm_tar_ops.tm_putdir != NULL)
544 (void) (tm_tar_ops.tm_putdir)(dir, tlm_acls,
545 local_commands, job_stats);
546 }
547
548 return (erc);
549 }
550
551
552 /*
553 * backup_file
554 *
555 * Create a TAR record entry for a file
556 */
557 static longlong_t
558 backup_file(char *dir, char *name, tlm_acls_t *tlm_acls,
559 tlm_commands_t *commands, tlm_cmd_t *local_commands,
560 tlm_job_stats_t *job_stats, bk_selector_t *bksp)
561 {
562
563 int erc;
564 char buf[TLM_MAX_PATH_NAME];
565 longlong_t rv = -1;
566
567 (void) strlcpy(buf, dir, sizeof (buf));
568 (void) strlcat(buf, "/", sizeof (buf));
569 (void) strlcat(buf, name, sizeof (buf));
570
571 /*
572 * get_acl_info extracts file handle, attributes and ACLs of the file.
573 * This is not efficient when the attributes and file handle of
574 * the file is already known.
575 */
576 erc = get_acl_info(buf, tlm_acls);
577 if (erc != TLM_NO_ERRORS) {
578 syslog(LOG_ERR, "Could not open file %s/%s.", dir, name);
579 return (-ENOENT);
580 }
581
582 /* Should the file be backed up? */
583 if (!bksp) {
584 syslog(LOG_DEBUG,
585 "[%s/%s] has no selection criteria", dir, name);
586
587 } else if (!((*bksp->bs_fn)(bksp, &tlm_acls->acl_attr))) {
588 syslog(LOG_DEBUG, "[%s/%s] file skipped", dir, name);
589 return (0);
590 }
591
592 /* Only the regular files and symbolic links can be backed up. */
593 if (!S_ISLNK(tlm_acls->acl_attr.st_mode) &&
594 !S_ISREG(tlm_acls->acl_attr.st_mode)) {
595 syslog(LOG_DEBUG,
596 "Warning: skip backing up [%s][%s]", dir, name);
597 return (-EINVAL);
598 }
599
600
601 if (tm_tar_ops.tm_putfile != NULL)
602 rv = (tm_tar_ops.tm_putfile)(dir, name, tlm_acls, commands,
603 local_commands, job_stats);
604
605 return (rv);
606 }
607
608
609
610 /*
611 * backup_work
612 *
613 * Start the NDMP backup (V2 only).
614 */
615 int
616 backup_work(char *bk_path, tlm_job_stats_t *job_stats,
617 ndmp_run_args_t *np, tlm_commands_t *commands,
618 ndmp_lbr_params_t *nlp)
619 {
620 struct full_dir_info dir_info; /* the blob to push/pop with cstack_t */
621 struct full_dir_info *t_dir_info, *p_dir_info;
622 struct stat64 ret_attr; /* attributes of current file name */
623 fs_fhandle_t ret_fh;
624 char *first_name; /* where the first name is located */
625 char *dname;
626 int erc;
627 int retval;
628 cstack_t *stk;
629 unsigned long fileid;
630 tlm_acls_t tlm_acls;
631 int dname_size;
632 longlong_t fsize;
633 bk_selector_t bks;
634 tlm_cmd_t *local_commands;
635 long dpos;
636
637 syslog(LOG_DEBUG, "nr_chkpnted %d nr_ldate: %u bk_path: \"%s\"",
638 NLP_ISCHKPNTED(nlp), nlp->nlp_ldate, bk_path);
639
640 /* Get every name in this directory */
641 dname = ndmp_malloc(TLM_MAX_PATH_NAME);
642 if (dname == NULL)
643 return (-ENOMEM);
644
645 local_commands = commands->tcs_command;
646 retval = 0;
647 (void) memset(&bks, 0, sizeof (bks));
648 bks.bs_cookie = (void *)nlp;
649 bks.bs_level = nlp->nlp_clevel;
650 bks.bs_ldate = nlp->nlp_ldate;
651 bks.bs_fn = timecmp;
652
653 /*
654 * should we skip the whole thing?
655 */
656 if (tlm_is_excluded("", bk_path, np->nr_excls)) {
657 syslog(LOG_DEBUG, "%s excluded", bk_path);
658 free(dname);
659 return (0);
660 }
661
662 /*
663 * Search for the top-level file-directory
664 */
665 if (NLP_ISCHKPNTED(nlp)) {
666 first_name = np->nr_chkp_nm;
667 (void) strlcpy(first_name, bk_path, TLM_MAX_PATH_NAME);
668 } else {
669 first_name = tlm_build_snapshot_name(bk_path, np->nr_chkp_nm,
670 nlp->nlp_jstat->js_job_name);
671 }
672
673 (void) memset(&ret_fh, 0, sizeof (ret_fh));
674 erc = fs_getstat(first_name, &ret_fh, &ret_attr);
675 if (erc != 0) {
676 syslog(LOG_ERR, "Path %s not found.", first_name);
677 free(dname);
678 return (-EINVAL);
679 }
680
681 if ((stk = cstack_new()) == NULL) {
682 free(dname);
683 syslog(LOG_DEBUG, "cstack_new failed");
684 return (-ENOMEM);
685 }
686 (void) strlcpy(dir_info.fd_dir_name, first_name, TLM_MAX_PATH_NAME);
687 (void) memcpy(&dir_info.fd_dir_fh, &ret_fh, sizeof (fs_fhandle_t));
688 p_dir_info = dup_dir_info(&dir_info);
689
690 /*
691 * Push the first name onto the stack so that we can pop it back
692 * off as part of the normal cycle
693 */
694 if (cstack_push(stk, p_dir_info, 0)) {
695 free(dname);
696 free(p_dir_info);
697 cstack_delete(stk);
698 syslog(LOG_DEBUG, "cstack_push failed");
699 return (-ENOMEM);
700 }
701
702 (void) memset(&tlm_acls, 0, sizeof (tlm_acls));
703 /*
704 * Did NDMP create a checkpoint?
705 */
706 if (NLP_ISCHKPNTED(nlp) || fs_is_rdonly(bk_path)) {
707 tlm_acls.acl_checkpointed = FALSE;
708 } else {
709 /* Use the checkpoint created by NDMP */
710 tlm_acls.acl_checkpointed = TRUE;
711 }
712
713 /*
714 * This is level-backup. It never resets the archive bit.
715 */
716 tlm_acls.acl_clear_archive = FALSE;
717
718 syslog(LOG_DEBUG, "acls.chkpnt: %c acls.clear_arcbit: %c",
719 NDMP_YORN(tlm_acls.acl_checkpointed),
720 NDMP_YORN(tlm_acls.acl_clear_archive));
721
722 while (commands->tcs_reader == TLM_BACKUP_RUN &&
723 local_commands->tc_reader == TLM_BACKUP_RUN &&
724 cstack_pop(stk, (void **)&p_dir_info, 0) == 0) {
725
726 if (NLP_ISCHKPNTED(nlp))
727 (void) strlcpy(np->nr_unchkp_nm,
728 p_dir_info->fd_dir_name, TLM_MAX_PATH_NAME);
729 else
730 (void) tlm_remove_checkpoint(p_dir_info->fd_dir_name,
731 np->nr_unchkp_nm);
732
733 (void) backup_dir(np->nr_unchkp_nm, &tlm_acls, local_commands,
734 job_stats, &bks);
735
736
737 while (commands->tcs_reader == TLM_BACKUP_RUN &&
738 local_commands->tc_reader == TLM_BACKUP_RUN) {
739
740 dname_size = TLM_MAX_PATH_NAME - 1;
741
742 syslog(LOG_DEBUG,
743 "dir_name: %s", p_dir_info->fd_dir_name);
744
745 (void) memset(&ret_fh, 0, sizeof (ret_fh));
746 erc = fs_readdir(&p_dir_info->fd_dir_fh,
747 p_dir_info->fd_dir_name, &dpos,
748 dname, &dname_size, &ret_fh, &ret_attr);
749 if (erc == 0) {
750 fileid = ret_fh.fh_fid;
751 } else {
752 syslog(LOG_DEBUG,
753 "Filesystem readdir in [%s]",
754 p_dir_info->fd_dir_name);
755 retval = -ENOENT;
756 break;
757 }
758
759 /* an empty name size marks the end of the list */
760 if (dname_size == 0)
761 break;
762 dname[dname_size] = '\0';
763
764 /*
765 * If name refers to a directory, push its file
766 * handle onto the stack (skip "." and "..").
767 */
768 if (rootfs_dot_or_dotdot(dname)) {
769 fileid = 0;
770 continue;
771 }
772
773 /*
774 * Skip the:
775 * non-dir entries which should not be backed up
776 * Or
777 * dir-type entries which have have nothing under
778 * their hierarchy to be backed up.
779 */
780 if (!dbm_getone(nlp->nlp_bkmap, (u_longlong_t)fileid)) {
781 syslog(LOG_DEBUG, "Skipping %s/%s",
782 p_dir_info->fd_dir_name, dname);
783 fileid = 0;
784 continue;
785 }
786
787 if (tlm_is_excluded(np->nr_unchkp_nm, dname,
788 np->nr_excls)) {
789 fileid = 0;
790 continue;
791 }
792 if (S_ISDIR(ret_attr.st_mode)) {
793 /*
794 * only directories get pushed onto this stack,
795 * so we do not have to test for regular files.
796 */
797 t_dir_info = tlm_new_dir_info(&ret_fh,
798 p_dir_info->fd_dir_name, dname);
799 if (t_dir_info == NULL) {
800 syslog(LOG_DEBUG,
801 "While backing up [%s][%s]",
802 p_dir_info->fd_dir_name, dname);
803 } else if (cstack_push(stk, t_dir_info,
804 0) != 0) {
805 syslog(LOG_DEBUG,
806 "No enough memory stack_push");
807 retval = -ENOMEM;
808 break;
809 }
810 } else if (S_ISREG(ret_attr.st_mode) ||
811 S_ISLNK(ret_attr.st_mode)) {
812
813 fsize = backup_file(np->nr_unchkp_nm, dname,
814 &tlm_acls, commands, local_commands,
815 job_stats, &bks);
816
817 if (fsize >= 0) {
818 job_stats->js_files_so_far++;
819 job_stats->js_bytes_total += fsize;
820 } else
821 job_stats->js_errors++;
822 fileid = 0;
823 }
824 }
825 fileid = 0;
826 free(p_dir_info);
827 if (retval != 0)
828 break;
829 }
830
831 free(dname);
832
833 while (cstack_pop(stk, (void **)&p_dir_info, 0) == 0) {
834 free(p_dir_info);
835 }
836
837 cstack_delete(stk);
838 return (retval);
839 }
840
841
842 /*
843 * free_paths
844 *
845 * Free the path names
846 */
847 static void
848 free_paths(ndmp_run_args_t *np)
849 {
850 free(np->nr_chkp_nm);
851 free(np->nr_unchkp_nm);
852 free(np->nr_excls);
853 }
854
855
856 /*
857 * malloc_paths
858 *
859 * Allocate the path names (direct and checkpointed paths)
860 */
861 static boolean_t
862 malloc_paths(ndmp_run_args_t *np)
863 {
864 boolean_t rv;
865
866 rv = TRUE;
867 np->nr_chkp_nm = ndmp_malloc(TLM_MAX_PATH_NAME);
868 np->nr_unchkp_nm = ndmp_malloc(TLM_MAX_PATH_NAME);
869 if (!np->nr_chkp_nm || !np->nr_unchkp_nm) {
870 free_paths(np);
871 rv = FALSE;
872 } else if ((np->nr_excls = ndmpd_make_exc_list()) == NULL) {
873 free_paths(np);
874 rv = FALSE;
875 }
876 return (rv);
877 }
878
879
880 /*
881 * ndmp_backup_reader
882 *
883 * Backup reader thread which uses backup_work to read and TAR
884 * the files/dirs to be backed up (V2 only)
885 */
886 static int
887 ndmp_backup_reader(tlm_commands_t *commands, ndmp_lbr_params_t *nlp,
888 char *job_name)
889 {
890 int retval;
891 ndmp_run_args_t np;
892 tlm_job_stats_t *job_stats;
893 tlm_cmd_t *local_commands;
894
895 syslog(LOG_DEBUG, "bk_path: \"%s\"", nlp->nlp_backup_path);
896
897 local_commands = commands->tcs_command;
898 (void) memset(&np, 0, sizeof (np));
899 if (!malloc_paths(&np))
900 return (-1);
901 local_commands->tc_ref++;
902 commands->tcs_reader_count++;
903
904 job_stats = tlm_ref_job_stats(job_name);
905
906 retval = backup_work(nlp->nlp_backup_path, job_stats, &np,
907 commands, nlp);
908 write_tar_eof(local_commands);
909
910 commands->tcs_reader_count--;
911 local_commands->tc_writer = TLM_STOP;
912 tlm_release_reader_writer_ipc(local_commands);
913 tlm_un_ref_job_stats(job_name);
914
915 free_paths(&np);
916 return (retval);
917
918 }
919
920
921 /*
922 * ndmp_tar_writer
923 *
924 * The backup writer thread that writes the TAR records to the
925 * tape media (V2 only)
926 */
927 int
928 ndmp_tar_writer(ndmpd_session_t *session, ndmpd_module_params_t *mod_params,
929 tlm_commands_t *cmds)
930 {
931 int bidx, nw;
932 int err;
933 tlm_buffer_t *buf;
934 tlm_buffers_t *bufs;
935 tlm_cmd_t *lcmd; /* Local command */
936
937 err = 0;
938 if (session == NULL) {
939 err = -1;
940 } else if (mod_params == NULL) {
941 err = -1;
942 } else if (cmds == NULL) {
943 err = -1;
944 }
945
946 if (err != 0)
947 return (err);
948
949 lcmd = cmds->tcs_command;
950 bufs = lcmd->tc_buffers;
951
952 lcmd->tc_ref++;
953 cmds->tcs_writer_count++;
954
955 nw = 0;
956 buf = tlm_buffer_out_buf(bufs, &bidx);
957 while (cmds->tcs_writer != (int)TLM_ABORT &&
958 lcmd->tc_writer != (int)TLM_ABORT) {
959 if (buf->tb_full) {
960 if (MOD_WRITE(mod_params, buf->tb_buffer_data,
961 buf->tb_buffer_size) != 0) {
962 syslog(LOG_DEBUG,
963 "Writing buffer %d, pos: %lld",
964 bidx, session->ns_mover.md_position);
965 err = -1;
966 break;
967 }
968
969 tlm_buffer_mark_empty(buf);
970 (void) tlm_buffer_advance_out_idx(bufs);
971 buf = tlm_buffer_out_buf(bufs, &bidx);
972 tlm_buffer_release_out_buf(bufs);
973 nw++;
974 } else {
975 if (lcmd->tc_writer != TLM_BACKUP_RUN) {
976 /* No more data is comming; time to exit. */
977 break;
978 } else {
979 tlm_buffer_in_buf_timed_wait(bufs, 100);
980 }
981 }
982 }
983
984 cmds->tcs_writer_count--;
985 lcmd->tc_reader = TLM_STOP;
986 lcmd->tc_ref--;
987
988 return (err);
989 }
990
991
992 /*
993 * read_one_buf
994 *
995 * Read one buffer from the tape
996 */
997 static int
998 read_one_buf(ndmpd_module_params_t *mod_params, tlm_buffers_t *bufs,
999 tlm_buffer_t *buf)
1000 {
1001 int rv;
1002
1003 if ((rv = MOD_READ(mod_params, buf->tb_buffer_data,
1004 bufs->tbs_data_transfer_size)) == 0) {
1005 buf->tb_eof = buf->tb_eot = FALSE;
1006 buf->tb_errno = 0;
1007 buf->tb_buffer_size = bufs->tbs_data_transfer_size;
1008 buf->tb_buffer_spot = 0;
1009 buf->tb_full = TRUE;
1010 (void) tlm_buffer_advance_in_idx(bufs);
1011 }
1012
1013 return (rv);
1014 }
1015
1016
1017 /*
1018 * ndmp_tar_reader
1019 *
1020 * NDMP Tar reader thread. This threads keep reading the tar
1021 * file from the tape and wakes up the consumer thread to extract
1022 * it on the disk
1023 */
1024 int
1025 ndmp_tar_reader(ndmp_tar_reader_arg_t *argp)
1026 {
1027 int bidx;
1028 int err;
1029 tlm_buffer_t *buf;
1030 tlm_buffers_t *bufs;
1031 tlm_cmd_t *lcmd; /* Local command */
1032 ndmpd_session_t *session;
1033 ndmpd_module_params_t *mod_params;
1034 tlm_commands_t *cmds;
1035
1036 if (!argp)
1037 return (-1);
1038
1039 session = argp->tr_session;
1040 mod_params = argp->tr_mod_params;
1041 cmds = argp->tr_cmds;
1042
1043 err = 0;
1044 if (session == NULL) {
1045 err = -1;
1046 } else if (cmds == NULL) {
1047 err = -1;
1048 }
1049
1050 if (err != 0) {
1051 tlm_cmd_signal(cmds->tcs_command, TLM_TAR_READER);
1052 return (err);
1053 }
1054
1055 lcmd = cmds->tcs_command;
1056 bufs = lcmd->tc_buffers;
1057
1058 lcmd->tc_ref++;
1059 cmds->tcs_reader_count++;
1060
1061 /*
1062 * Synchronize with our parent thread.
1063 */
1064 tlm_cmd_signal(cmds->tcs_command, TLM_TAR_READER);
1065
1066 buf = tlm_buffer_in_buf(bufs, &bidx);
1067 while (cmds->tcs_reader == TLM_RESTORE_RUN &&
1068 lcmd->tc_reader == TLM_RESTORE_RUN) {
1069
1070 if (buf->tb_full) {
1071 /*
1072 * The buffer is still full, wait for the consumer
1073 * thread to use it.
1074 */
1075 tlm_buffer_out_buf_timed_wait(bufs, 100);
1076 buf = tlm_buffer_in_buf(bufs, NULL);
1077 } else {
1078 err = read_one_buf(mod_params, bufs, buf);
1079 if (err < 0) {
1080 syslog(LOG_DEBUG,
1081 "Reading buffer %d, pos: %lld",
1082 bidx, session->ns_mover.md_position);
1083
1084 /* Force the writer to stop. */
1085 buf->tb_eot = buf->tb_eof = TRUE;
1086 break;
1087 } else if (err == 1) {
1088 syslog(LOG_DEBUG,
1089 "operation aborted or session terminated");
1090 err = 0;
1091 break;
1092 }
1093
1094 buf = tlm_buffer_in_buf(bufs, &bidx);
1095 tlm_buffer_release_in_buf(bufs);
1096 }
1097 }
1098
1099 /*
1100 * If the consumer is waiting for us, wake it up so that it detects
1101 * we're quiting.
1102 */
1103 lcmd->tc_writer = TLM_STOP;
1104 tlm_buffer_release_in_buf(bufs);
1105 (void) usleep(1000);
1106
1107 /*
1108 * Clean up.
1109 */
1110 cmds->tcs_reader_count--;
1111 lcmd->tc_ref--;
1112 return (err);
1113 }
1114
1115
1116 /*
1117 * ndmpd_tar_backup
1118 *
1119 * Check must have been done that backup work directory exists, before
1120 * calling this function.
1121 */
1122 static int
1123 ndmpd_tar_backup(ndmpd_session_t *session, ndmpd_module_params_t *mod_params,
1124 ndmp_lbr_params_t *nlp)
1125 {
1126 char jname[TLM_MAX_BACKUP_JOB_NAME];
1127 int err;
1128 tlm_commands_t *cmds;
1129
1130 if (mod_params->mp_operation != NDMP_DATA_OP_BACKUP) {
1131 syslog(LOG_DEBUG,
1132 "mod_params->mp_operation != NDMP_DATA_OP_BACKUP");
1133 err = -1;
1134 } else {
1135 if (ndmpd_mark_inodes_v2(session, nlp) != 0)
1136 err = -1;
1137 else if (ndmp_get_bk_dir_ino(nlp))
1138 err = -1;
1139 else
1140 err = 0;
1141 }
1142
1143 if (err != 0)
1144 return (err);
1145
1146 if (ndmp_new_job_name(jname, sizeof (jname)) <= 0) {
1147 return (-1);
1148 }
1149 if (backup_create_structs(session, jname) < 0) {
1150 return (-1);
1151 }
1152 nlp->nlp_jstat->js_start_ltime = time(NULL);
1153 nlp->nlp_jstat->js_start_time = nlp->nlp_jstat->js_start_ltime;
1154 nlp->nlp_jstat->js_chkpnt_time = nlp->nlp_cdate;
1155
1156 if (!session->ns_data.dd_abort) {
1157
1158 cmds = &nlp->nlp_cmds;
1159 cmds->tcs_reader = cmds->tcs_writer = TLM_BACKUP_RUN;
1160 cmds->tcs_command->tc_reader = TLM_BACKUP_RUN;
1161 cmds->tcs_command->tc_writer = TLM_BACKUP_RUN;
1162
1163 if (ndmp_write_utf8magic(cmds->tcs_command) < 0) {
1164 backup_release_structs(session);
1165 return (-1);
1166 }
1167
1168 syslog(LOG_DEBUG, "Backing up \"%s\" started.",
1169 nlp->nlp_backup_path);
1170
1171 err = ndmp_backup_reader(cmds, nlp, jname);
1172 if (err != 0) {
1173 backup_release_structs(session);
1174 syslog(LOG_DEBUG, "Launch ndmp_backup_reader: %s",
1175 strerror(err));
1176 return (-1);
1177 }
1178
1179 /* Act as the writer thread. */
1180 err = ndmp_tar_writer(session, mod_params, cmds);
1181
1182 nlp->nlp_jstat->js_stop_time = time(NULL);
1183
1184 syslog(LOG_DEBUG,
1185 "Runtime [%s] %lu bytes (%llu): %d seconds",
1186 nlp->nlp_backup_path, session->ns_mover.md_data_written,
1187 session->ns_mover.md_data_written,
1188 nlp->nlp_jstat->js_stop_time -
1189 nlp->nlp_jstat->js_start_ltime);
1190 MOD_LOG(mod_params,
1191 "Runtime [%s] %lu bytes (%lu): %d seconds",
1192 nlp->nlp_backup_path, session->ns_mover.md_data_written,
1193 session->ns_mover.md_data_written,
1194 nlp->nlp_jstat->js_stop_time -
1195 nlp->nlp_jstat->js_start_ltime);
1196
1197 if (session->ns_data.dd_abort)
1198 err = -1;
1199
1200 syslog(LOG_DEBUG, "Backing up \"%s\" finished. (%d)",
1201 nlp->nlp_backup_path, err);
1202 } else {
1203 nlp->nlp_jstat->js_stop_time = time(NULL);
1204 syslog(LOG_DEBUG, "Backing up \"%s\" aborted.",
1205 nlp->nlp_backup_path);
1206 err = 0;
1207 }
1208
1209 backup_release_structs(session);
1210 return (err);
1211 }
1212
1213
1214 /*
1215 * ndmpd_tar_restore
1216 *
1217 * Restore function that launches TAR reader thread to read from the
1218 * tape and writes the extracted files/dirs to the filesystem
1219 */
1220 static int
1221 ndmpd_tar_restore(ndmpd_session_t *session, ndmpd_module_params_t *mod_params,
1222 ndmp_lbr_params_t *nlp)
1223 {
1224 char jname[TLM_MAX_BACKUP_JOB_NAME];
1225 char *rspath;
1226 int err;
1227 tlm_commands_t *cmds;
1228 ndmp_tar_reader_arg_t arg;
1229 tlm_backup_restore_arg_t tlm_arg;
1230 ndmp_name *ent;
1231 pthread_t rdtp, wrtp;
1232 int i;
1233
1234 if (mod_params->mp_operation != NDMP_DATA_OP_RECOVER) {
1235 return (-1);
1236 }
1237
1238 if (nlp->nlp_restore_path[0] != '\0')
1239 rspath = nlp->nlp_restore_path;
1240 else if (nlp->nlp_restore_bk_path[0] != '\0')
1241 rspath = nlp->nlp_restore_bk_path;
1242 else
1243 rspath = "";
1244
1245 if (ndmp_new_job_name(jname, sizeof (jname)) <= 0) {
1246 return (-1);
1247 }
1248 if (restore_create_structs(session, jname) < 0) {
1249 return (-1);
1250 }
1251
1252 nlp->nlp_jstat->js_start_ltime = time(NULL);
1253 nlp->nlp_jstat->js_start_time = time(NULL);
1254
1255 if (!session->ns_data.dd_abort) {
1256 cmds = &nlp->nlp_cmds;
1257 cmds->tcs_reader = cmds->tcs_writer = TLM_RESTORE_RUN;
1258 cmds->tcs_command->tc_reader = TLM_RESTORE_RUN;
1259 cmds->tcs_command->tc_writer = TLM_RESTORE_RUN;
1260
1261 syslog(LOG_DEBUG, "Restoring to \"%s\" started.", rspath);
1262 syslog(LOG_DEBUG, "Restoring from %s tape(s).",
1263 ndmp_data_get_mover_mode(session));
1264
1265 arg.tr_session = session;
1266 arg.tr_mod_params = mod_params;
1267 arg.tr_cmds = cmds;
1268
1269 err = pthread_create(&rdtp, NULL, (funct_t)ndmp_tar_reader,
1270 (void *)&arg);
1271 if (err == 0) {
1272 tlm_cmd_wait(cmds->tcs_command, TLM_TAR_READER);
1273 } else {
1274 syslog(LOG_DEBUG, "Launch ndmp_tar_reader: %m");
1275 return (-1);
1276 }
1277
1278 if (!ndmp_check_utf8magic(cmds->tcs_command)) {
1279 syslog(LOG_DEBUG, "UTF8Magic not found!");
1280 } else {
1281 syslog(LOG_DEBUG, "UTF8Magic found");
1282 }
1283
1284 (void) memset(&tlm_arg, 0, sizeof (tlm_backup_restore_arg_t));
1285 (void) pthread_barrier_init(&tlm_arg.ba_barrier, 0, 2);
1286
1287 /*
1288 * Set up restore parameters
1289 */
1290 tlm_arg.ba_commands = cmds;
1291 tlm_arg.ba_cmd = cmds->tcs_command;
1292 tlm_arg.ba_job = nlp->nlp_jstat->js_job_name;
1293 tlm_arg.ba_dir = nlp->nlp_restore_path;
1294 for (i = 0; i < nlp->nlp_nfiles; i++) {
1295 ent = (ndmp_name *)MOD_GETNAME(mod_params, i);
1296 tlm_arg.ba_sels[i] = strdup(ent->name);
1297 }
1298 tlm_arg.ba_count = i;
1299
1300 if (tm_tar_ops.tm_getfile != NULL) {
1301 err = pthread_create(&wrtp, NULL,
1302 (funct_t)tm_tar_ops.tm_getfile, (void *)&tlm_arg);
1303 } else {
1304 (void) pthread_barrier_destroy(&tlm_arg.ba_barrier);
1305 syslog(LOG_DEBUG,
1306 "Thread create tm_getfile: ops NULL");
1307 return (-1);
1308 }
1309 if (err == 0) {
1310 (void) pthread_barrier_wait(&tlm_arg.ba_barrier);
1311 } else {
1312 (void) pthread_barrier_destroy(&tlm_arg.ba_barrier);
1313 syslog(LOG_DEBUG, "thread create tm_getfile: %m");
1314 return (-1);
1315 }
1316
1317 (void) pthread_join(rdtp, NULL);
1318 (void) pthread_join(wrtp, NULL);
1319 (void) pthread_barrier_destroy(&tlm_arg.ba_barrier);
1320
1321 nlp->nlp_jstat->js_stop_time = time(NULL);
1322
1323 /* Send the list of un-recovered files/dirs to the client. */
1324 (void) send_unrecovered_list(mod_params, nlp);
1325
1326 ndmp_stop_local_reader(session, cmds);
1327 ndmp_wait_for_reader(cmds);
1328 ndmp_stop_remote_reader(session);
1329 syslog(LOG_DEBUG, "Restoring to \"%s\" finished. (%d)",
1330 rspath, err);
1331 } else {
1332 nlp->nlp_jstat->js_stop_time = time(NULL);
1333
1334 /* nothing restored. */
1335 (void) send_unrecovered_list(mod_params, nlp);
1336 syslog(LOG_DEBUG, "Restoring to \"%s\" aborted.",
1337 rspath);
1338 err = -1;
1339 }
1340
1341 NDMP_FREE(nlp->nlp_restore_path);
1342 backup_release_structs(session);
1343
1344 return (err);
1345 }
1346
1347
1348 /*
1349 * prefixdir
1350 *
1351 * Extract the path for a given full path entry
1352 */
1353 static char *
1354 prefixdir(char *dir, char *suffix)
1355 {
1356 static char tmp[TLM_MAX_PATH_NAME];
1357 char *tend, *send; /* tmp and suffix end */
1358
1359 if (dir == NULL || suffix == NULL)
1360 return (NULL);
1361
1362 if (*suffix == '\0')
1363 return (dir);
1364
1365 if (*dir == '\0')
1366 return (NULL);
1367
1368 (void) strlcpy(tmp, dir, TLM_MAX_PATH_NAME);
1369 tend = &tmp[strlen(tmp)];
1370 send = &suffix[strlen(suffix)];
1371
1372 /*
1373 * Move backward as far as the last part of the dir and
1374 * the suffix match.
1375 */
1376 while (tend >= tmp && send >= suffix)
1377 if (*tend == *send)
1378 tend--, send--;
1379 else
1380 break;
1381
1382 *++tend = '\0';
1383 return (tmp);
1384 }
1385
1386
1387 /*
1388 * get_nfiles
1389 *
1390 * Get the count of files to be restored
1391 */
1392 static int
1393 get_nfiles(ndmpd_session_t *session, ndmpd_module_params_t *params)
1394 {
1395 if (session->ns_data.dd_nlist_len == 0) {
1396 MOD_LOG(params, "Error: nothing specified to be restored.\n");
1397 return (-1);
1398 }
1399
1400 return (session->ns_data.dd_nlist_len);
1401 }
1402
1403
1404 /*
1405 * get_restore_dest
1406 *
1407 * Get the full pathname of where the entries should be restored to.
1408 */
1409 static char *
1410 get_restore_dest(ndmpd_module_params_t *params)
1411 {
1412 ndmp_name *ent;
1413 char *cp;
1414
1415 /*
1416 * Destination of restore:
1417 * NetBackup of Veritas(C) sends the entries like this:
1418 *
1419 * ent[i].name: is the relative pathname of what is selected in
1420 * the GUI.
1421 * ent[i].dest: is the full pathname of where the dir/file must
1422 * be restored to.
1423 * ent[i].ssi: 0
1424 * ent[i].fh_info: 0
1425 *
1426 */
1427 ent = (ndmp_name *)MOD_GETNAME(params, 0);
1428 cp = prefixdir(ent->dest, ent->name);
1429 if (cp == NULL) {
1430 MOD_LOG(params, "Error: empty restore path.\n");
1431 return (NULL);
1432 }
1433
1434 return (cp);
1435 }
1436
1437
1438 /*
1439 * correct_ents
1440 *
1441 * Correct the entries in the restore list by appending the appropriate
1442 * path to them
1443 */
1444 static int
1445 correct_ents(ndmpd_module_params_t *params, int n, char *bkpath)
1446 {
1447 char *cp, *pathname;
1448 int i, len, rv;
1449 ndmp_name *ent;
1450
1451 if ((pathname = ndmp_malloc(TLM_MAX_PATH_NAME)) == NULL) {
1452 MOD_LOG(params, "Error: insufficient memory.\n");
1453 return (-1);
1454 }
1455
1456 rv = 0;
1457 /* Append the backup path to all the "ent[].name"s. */
1458 for (i = 0; i < n; i++) {
1459 ent = (ndmp_name *)MOD_GETNAME(params, i);
1460
1461 syslog(LOG_DEBUG,
1462 "Old: ent[%d].name: \"%s\"", i, ent->name);
1463 syslog(LOG_DEBUG,
1464 "Old: ent[%d].dest: \"%s\"", i, ent->dest);
1465
1466 /* remove trailing slash */
1467 len = strlen(ent->name);
1468 if (ent->name[len - 1] == '/')
1469 ent->name[len - 1] = '\0';
1470
1471 if (!tlm_cat_path(pathname, bkpath, ent->name)) {
1472 MOD_LOG(params, "Error: path too long.\n");
1473 rv = -1;
1474 break;
1475 }
1476
1477 /* Make a copy of the new string and save it in ent->name. */
1478 cp = strdup(pathname);
1479 if (cp == NULL) {
1480 MOD_LOG(params, "Error: insufficient memory.\n");
1481 rv = -1;
1482 break;
1483 }
1484 free(ent->name);
1485 ent->name = cp;
1486
1487 syslog(LOG_DEBUG,
1488 "New: ent[%d].name: \"%s\"", i, ent->name);
1489 }
1490
1491 free(pathname);
1492 return (rv);
1493 }
1494
1495
1496 /*
1497 * check_restore_paths
1498 *
1499 * Go through the restore list and check the validity of the
1500 * restore path.
1501 */
1502 static int
1503 check_restore_paths(ndmpd_module_params_t *params, int n, char *rspath)
1504 {
1505 int i, rv;
1506 ndmp_name *ent;
1507
1508 rv = 0;
1509 if (rspath != NULL && *rspath != '\0') {
1510 syslog(LOG_DEBUG, "rspath: \"%s\"", rspath);
1511 if (!fs_volexist(rspath)) {
1512 MOD_LOG(params,
1513 "Error: Invalid volume name for restore.");
1514 rv = -1;
1515 }
1516 } else {
1517 for (i = 0; i < n; i++) {
1518 ent = (ndmp_name *)MOD_GETNAME(params, i);
1519 syslog(LOG_DEBUG,
1520 "ent[%d].name: \"%s\"", i, ent->name);
1521
1522 if (!fs_volexist(ent->name)) {
1523 MOD_LOG(params,
1524 "Error: Invalid volume name for restore.",
1525 ent->name);
1526 rv = -1;
1527 break;
1528 }
1529 }
1530 }
1531
1532 return (rv);
1533 }
1534
1535
1536 /*
1537 * check_backup_dir_validity
1538 *
1539 * Check if the backup directory is valid. Make sure it exists and
1540 * is writable. Check for snapshot and readonly cases.
1541 */
1542 static int
1543 check_backup_dir_validity(ndmpd_module_params_t *params, char *bkpath)
1544 {
1545 char *msg;
1546 int rv;
1547 struct stat64 st;
1548
1549 rv = NDMP_NO_ERR;
1550 if (stat64(bkpath, &st) < 0) {
1551 msg = strerror(errno);
1552 MOD_LOG(params, "Error: stat(%s): %s.\n", bkpath, msg);
1553 rv = NDMP_ILLEGAL_ARGS_ERR;
1554 } else if (!S_ISDIR(st.st_mode)) {
1555 MOD_LOG(params, "Error: %s is not a directory.\n", bkpath);
1556 rv = NDMP_ILLEGAL_ARGS_ERR;
1557 } else if (fs_is_rdonly(bkpath) && !fs_is_chkpntvol(bkpath) &&
1558 fs_is_chkpnt_enabled(bkpath)) {
1559 MOD_LOG(params, "Error: %s is not a checkpointed path.\n",
1560 bkpath);
1561 rv = NDMP_BAD_FILE_ERR;
1562 }
1563
1564 return (rv);
1565 }
1566
1567
1568 /*
1569 * ndmp_backup_extract_params
1570 *
1571 * Go through the backup parameters and check the validity
1572 * for each one. Then set the NLP flags according to the parameters.
1573 */
1574 int
1575 ndmp_backup_extract_params(ndmpd_session_t *session,
1576 ndmpd_module_params_t *params)
1577 {
1578 char *cp;
1579 int rv;
1580 ndmp_lbr_params_t *nlp;
1581
1582 /* Extract directory to be backed up from env variables */
1583 if ((nlp = ndmp_get_nlp(session)) == NULL) {
1584 MOD_LOG(params, "Error: Internal error: nlp == NULL.\n");
1585 return (NDMP_ILLEGAL_ARGS_ERR);
1586 }
1587 if ((nlp->nlp_backup_path = get_backup_path_v2(params)) == NULL)
1588 return (NDMP_FILE_NOT_FOUND_ERR);
1589
1590 if ((rv = check_backup_dir_validity(params,
1591 nlp->nlp_backup_path)) != NDMP_NO_ERR)
1592 return (rv);
1593
1594 /* Should the st_ctime be ignored when backing up? */
1595 if (ndmp_ignore_ctime) {
1596 syslog(LOG_DEBUG, "ignoring st_ctime");
1597 NLP_SET(nlp, NLPF_IGNCTIME);
1598 } else
1599 NLP_UNSET(nlp, NLPF_IGNCTIME);
1600
1601 /* Should the st_lmtime be ignored when backing up? */
1602 if (ndmp_include_lmtime) {
1603 syslog(LOG_DEBUG, "including st_lmtime");
1604 NLP_SET(nlp, NLPF_INCLMTIME);
1605 } else
1606 NLP_UNSET(nlp, NLPF_INCLMTIME);
1607
1608 syslog(LOG_DEBUG, "flags %x", nlp->nlp_flags);
1609
1610 /* Is backup history requested? */
1611 cp = MOD_GETENV(params, "HIST");
1612 if (cp == NULL) {
1613 syslog(LOG_DEBUG, "env(HIST) not specified");
1614 NLP_UNSET(nlp, NLPF_FH);
1615 } else {
1616 syslog(LOG_DEBUG, "env(HIST): \"%s\"", cp);
1617
1618 if (strchr("t_ty_y", *cp))
1619 NLP_SET(nlp, NLPF_FH);
1620 else
1621 NLP_UNSET(nlp, NLPF_FH);
1622 }
1623
1624 nlp->nlp_clevel = 0;
1625 /* Is it an incremental backup? */
1626 cp = MOD_GETENV(params, "LEVEL");
1627 if (cp == NULL) {
1628 syslog(LOG_DEBUG,
1629 "env(LEVEL) not specified, default to 0");
1630 } else if (*cp < '0' || *cp > '9' || *(cp+1) != '\0') {
1631 syslog(LOG_DEBUG, "Invalid backup level '%s'", cp);
1632 return (NDMP_ILLEGAL_ARGS_ERR);
1633 } else
1634 nlp->nlp_clevel = *cp - '0';
1635
1636 /* Extract last backup time from the dumpdates file */
1637 nlp->nlp_llevel = nlp->nlp_clevel;
1638 nlp->nlp_ldate = 0;
1639 if (ndmpd_get_dumptime(nlp->nlp_backup_path, &nlp->nlp_llevel,
1640 &nlp->nlp_ldate) < 0) {
1641 MOD_LOG(params, "Error: getting dumpdate for %s level %d\n",
1642 nlp->nlp_backup_path, nlp->nlp_clevel);
1643 return (NDMP_NO_MEM_ERR);
1644 }
1645
1646 syslog(LOG_DEBUG,
1647 "Date of this level %d on \"%s\": %s",
1648 nlp->nlp_clevel, nlp->nlp_backup_path, cctime(&nlp->nlp_cdate));
1649 syslog(LOG_DEBUG,
1650 "Date of last level %d on \"%s\": %s",
1651 nlp->nlp_llevel, nlp->nlp_backup_path, cctime(&nlp->nlp_ldate));
1652
1653 /* Should the dumpdate file be updated? */
1654 cp = MOD_GETENV(params, "UPDATE");
1655 if (cp == NULL) {
1656 syslog(LOG_DEBUG,
1657 "env(UPDATE) not specified, default to TRUE");
1658 NLP_SET(nlp, NLPF_UPDATE);
1659 } else {
1660 syslog(LOG_DEBUG, "env(UPDATE): \"%s\"", cp);
1661 if (strchr("t_ty_y", *cp) != NULL)
1662 NLP_SET(nlp, NLPF_UPDATE);
1663 else
1664 NLP_UNSET(nlp, NLPF_UPDATE);
1665 }
1666
1667 return (NDMP_NO_ERR);
1668 }
1669
1670
1671
1672 /*
1673 * log_bk_params_v2
1674 *
1675 * Dump the value of the parameters in the log file for debugging.
1676 */
1677 void
1678 log_bk_params_v2(ndmpd_session_t *session, ndmpd_module_params_t *params,
1679 ndmp_lbr_params_t *nlp)
1680 {
1681 MOD_LOG(params, "Date of this level %d on \"%s\": %s\n",
1682 nlp->nlp_clevel, nlp->nlp_backup_path, cctime(&nlp->nlp_cdate));
1683 MOD_LOG(params, "Date of last level %d on \"%s\": %s\n",
1684 nlp->nlp_llevel, nlp->nlp_backup_path, cctime(&nlp->nlp_ldate));
1685
1686 MOD_LOG(params, "Backing up: \"%s\".\n", nlp->nlp_backup_path);
1687 MOD_LOG(params, "Record size: %d\n", session->ns_mover.md_record_size);
1688 MOD_LOG(params, "File history: %c.\n",
1689 NDMP_YORN(NLP_ISSET(nlp, NLPF_FH)));
1690 MOD_LOG(params, "Update: %s\n",
1691 NLP_ISSET(nlp, NLPF_UPDATE) ? "TRUE" : "FALSE");
1692
1693 }
1694
1695
1696 /*
1697 * same_path
1698 *
1699 * Find out if the paths are the same regardless of the ending slash
1700 *
1701 * Examples :
1702 * /a/b/c == /a/b/c
1703 * /a/b/c/ == /a/b/c
1704 * /a/b/c == /a/b/c/
1705 */
1706 static boolean_t
1707 same_path(char *s, char *t)
1708 {
1709 boolean_t rv;
1710 int slen, tlen;
1711
1712 rv = FALSE;
1713 slen = strlen(s);
1714 tlen = strlen(t);
1715 if (slen == tlen && strcmp(s, t) == 0) {
1716 rv = TRUE;
1717 } else {
1718 if (slen == tlen - 1) {
1719 if (strncmp(s, t, slen) == 0 && t[tlen - 1] == '/')
1720 rv = TRUE;
1721 } else if (tlen == slen -1) {
1722 if (strncmp(s, t, tlen) == 0 && s[slen - 1] == '/')
1723 rv = TRUE;
1724 }
1725 }
1726
1727 syslog(LOG_DEBUG, "rv: %d", rv);
1728 return (rv);
1729 }
1730
1731
1732 /*
1733 * ndmp_restore_extract_params
1734 *
1735 * Go through the restore parameters and check them and extract them
1736 * by setting NLP flags and other values.
1737 *
1738 * Parameters:
1739 *
1740 * Returns:
1741 * 0: on success
1742 * -1: otherwise
1743 */
1744 int
1745 ndmp_restore_extract_params(ndmpd_session_t *session,
1746 ndmpd_module_params_t *params)
1747 {
1748 char *bkpath, *rspath;
1749 ndmp_lbr_params_t *nlp;
1750
1751 if ((nlp = ndmp_get_nlp(session)) == NULL) {
1752 return (-1);
1753 }
1754
1755 /* Extract directory from where the backup was made. */
1756 if ((bkpath = get_backup_path_v2(params)) == NULL)
1757 return (NDMP_ILLEGAL_ARGS_ERR);
1758
1759 nlp->nlp_restore_bk_path = bkpath;
1760
1761 /* The number of the selections. */
1762 if ((nlp->nlp_nfiles = get_nfiles(session, params)) == 0)
1763 return (NDMP_ILLEGAL_ARGS_ERR);
1764
1765 syslog(LOG_DEBUG, "nfiles: %d", nlp->nlp_nfiles);
1766
1767 if ((rspath = get_restore_dest(params)) == NULL)
1768 return (NDMP_ILLEGAL_ARGS_ERR);
1769
1770 if (fs_is_rdonly(rspath)) {
1771 MOD_LOG(params,
1772 "Error: Can't restore to a read-only volume: \"%s\"\n",
1773 rspath);
1774 return (NDMP_ILLEGAL_ARGS_ERR);
1775 }
1776 if (fs_is_chkpntvol(rspath)) {
1777 MOD_LOG(params,
1778 "Error: Can't restore to a checkpoint: \"%s\"\n", rspath);
1779 return (NDMP_ILLEGAL_ARGS_ERR);
1780 }
1781
1782 if (same_path(bkpath, rspath))
1783 rspath = "";
1784
1785 if ((nlp->nlp_restore_path = strdup(rspath)) == NULL)
1786 return (NDMP_NO_MEM_ERR);
1787
1788 bkpath = trim_name(bkpath);
1789 if (correct_ents(params, nlp->nlp_nfiles, bkpath) < 0) {
1790 free(nlp->nlp_restore_path);
1791 return (NDMP_ILLEGAL_ARGS_ERR);
1792 }
1793
1794 if (check_restore_paths(params, nlp->nlp_nfiles, rspath) < 0) {
1795 free(nlp->nlp_restore_path);
1796 return (NDMP_ILLEGAL_ARGS_ERR);
1797 }
1798
1799 MOD_LOG(params, "Restoring %d files.\n", nlp->nlp_nfiles);
1800 MOD_LOG(params, "Restoring to: \"%s\".\n", nlp->nlp_restore_path);
1801 MOD_LOG(params, "Record size: %d\n", session->ns_mover.md_record_size);
1802
1803 return (NDMP_NO_ERR);
1804 }
1805
1806 /*
1807 * ndmpd_tar_backup_starter (V2 only)
1808 *
1809 * The main backup starter function. It creates a snapshot if necessary
1810 * and calls ndmp_tar_backup to perform the actual backup. It does the cleanup
1811 * and release the snapshot at the end.
1812 */
1813 int
1814 ndmpd_tar_backup_starter(void *arg)
1815 {
1816 ndmpd_module_params_t *mod_params = arg;
1817 int err;
1818 ndmpd_session_t *session;
1819 ndmp_lbr_params_t *nlp;
1820
1821 session = (ndmpd_session_t *)(mod_params->mp_daemon_cookie);
1822 *(mod_params->mp_module_cookie) = nlp = ndmp_get_nlp(session);
1823 ndmp_session_ref(session);
1824
1825 err = 0;
1826 if (fs_is_chkpntvol(nlp->nlp_backup_path) ||
1827 fs_is_rdonly(nlp->nlp_backup_path) ||
1828 !fs_is_chkpnt_enabled(nlp->nlp_backup_path))
1829 NLP_SET(nlp, NLPF_CHKPNTED_PATH);
1830 else {
1831 NLP_UNSET(nlp, NLPF_CHKPNTED_PATH);
1832 if (backup_dataset_create(nlp) < 0) {
1833 MOD_LOG(mod_params,
1834 "Error: creating checkpoint on %s\n",
1835 nlp->nlp_backup_path);
1836 /* -1 causes halt reason to become internal error. */
1837 err = -1;
1838 }
1839 }
1840
1841 syslog(LOG_DEBUG, "NLPF_CHKPNTED_PATH: %c",
1842 NDMP_YORN(NLP_ISCHKPNTED(nlp)));
1843 syslog(LOG_DEBUG, "err: %d, update %c",
1844 err, NDMP_YORN(NLP_SHOULD_UPDATE(nlp)));
1845
1846 if (err == 0) {
1847 err = ndmp_get_cur_bk_time(nlp, &nlp->nlp_cdate);
1848 if (err != 0) {
1849 syslog(LOG_DEBUG, "err %d", err);
1850 } else {
1851 log_bk_params_v2(session, mod_params, nlp);
1852 err = ndmpd_tar_backup(session, mod_params, nlp);
1853 }
1854 }
1855
1856 if (nlp->nlp_bkmap >= 0) {
1857 (void) dbm_free(nlp->nlp_bkmap);
1858 nlp->nlp_bkmap = -1;
1859 }
1860
1861 if (!NLP_ISCHKPNTED(nlp))
1862 (void) backup_dataset_destroy(nlp);
1863
1864 syslog(LOG_DEBUG, "err %d, update %c",
1865 err, NDMP_YORN(NLP_SHOULD_UPDATE(nlp)));
1866
1867 if (err == 0 && NLP_SHOULD_UPDATE(nlp)) {
1868 if (ndmpd_put_dumptime(nlp->nlp_backup_path, nlp->nlp_clevel,
1869 nlp->nlp_cdate) < 0) {
1870 err = EPERM;
1871 MOD_LOG(mod_params,
1872 "Error: updating the dumpdates file on %s\n",
1873 nlp->nlp_backup_path);
1874 }
1875 }
1876
1877 MOD_DONE(mod_params, err);
1878
1879 /* nlp_params is allocated in start_backup() */
1880 NDMP_FREE(nlp->nlp_params);
1881
1882 NS_DEC(nbk);
1883 ndmp_session_unref(session);
1884 return (err);
1885 }
1886
1887
1888 /*
1889 * ndmpd_tar_backup_abort
1890 *
1891 * Abort the running backup by stopping the reader thread (V2 only)
1892 */
1893 int
1894 ndmpd_tar_backup_abort(void *module_cookie)
1895 {
1896 ndmp_lbr_params_t *nlp;
1897
1898 nlp = (ndmp_lbr_params_t *)module_cookie;
1899 if (nlp != NULL && nlp->nlp_session != NULL) {
1900 if (nlp->nlp_session->ns_data.dd_mover.addr_type ==
1901 NDMP_ADDR_TCP && nlp->nlp_session->ns_data.dd_sock != -1) {
1902 (void) close(nlp->nlp_session->ns_data.dd_sock);
1903 nlp->nlp_session->ns_data.dd_sock = -1;
1904 }
1905 ndmp_stop_reader_thread(nlp->nlp_session);
1906 }
1907
1908 return (0);
1909 }
1910
1911 /*
1912 * ndmpd_tar_restore_starter
1913 *
1914 * Starts the restore by running ndmpd_tar_restore function (V2 only)
1915 */
1916
1917 int
1918 ndmpd_tar_restore_starter(void *arg)
1919 {
1920 ndmpd_module_params_t *mod_params = arg;
1921 int err;
1922 ndmpd_session_t *session;
1923 ndmp_lbr_params_t *nlp;
1924
1925 session = (ndmpd_session_t *)(mod_params->mp_daemon_cookie);
1926 *(mod_params->mp_module_cookie) = nlp = ndmp_get_nlp(session);
1927 ndmp_session_ref(session);
1928
1929 err = ndmpd_tar_restore(session, mod_params, nlp);
1930 MOD_DONE(mod_params, err);
1931
1932 /* nlp_params is allocated in start_recover() */
1933 NDMP_FREE(nlp->nlp_params);
1934
1935 NS_DEC(nrs);
1936 ndmp_session_unref(session);
1937 return (err);
1938 }
1939
1940
1941 /*
1942 * ndmpd_tar_restore_abort
1943 *
1944 * Aborts the restore operation by stopping the writer thread (V2 only)
1945 */
1946 int
1947 ndmpd_tar_restore_abort(void *module_cookie)
1948 {
1949 ndmp_lbr_params_t *nlp;
1950
1951 nlp = (ndmp_lbr_params_t *)module_cookie;
1952 if (nlp != NULL && nlp->nlp_session != NULL) {
1953 (void) mutex_lock(&nlp->nlp_mtx);
1954 if (nlp->nlp_session->ns_data.dd_mover.addr_type ==
1955 NDMP_ADDR_TCP && nlp->nlp_session->ns_data.dd_sock != -1) {
1956 (void) close(nlp->nlp_session->ns_data.dd_sock);
1957 nlp->nlp_session->ns_data.dd_sock = -1;
1958 }
1959 (void) cond_broadcast(&nlp->nlp_cv);
1960 (void) mutex_unlock(&nlp->nlp_mtx);
1961 ndmp_stop_writer_thread(nlp->nlp_session);
1962 }
1963
1964 return (0);
1965 }