1 /* 2 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 3 * Use is subject to license terms. 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 #ifndef _TLM_H_ 40 #define _TLM_H_ 41 42 #include <sys/types.h> 43 #include <synch.h> 44 #include <limits.h> 45 #include <cstack.h> 46 #include <sys/acl.h> 47 #include <stdio.h> 48 #include <errno.h> 49 #include <fcntl.h> 50 #include <strings.h> 51 #include <sys/stat.h> 52 #include <time.h> 53 #include <sys/queue.h> 54 55 #define IS_SET(f, m) (((f) & (m)) != 0) 56 57 #define TLM_MAX_BACKUP_JOB_NAME 32 /* max size of a job's name */ 58 #define TLM_TAPE_BUFFERS 10 /* number of rotating tape buffers */ 59 #define TLM_LINE_SIZE 128 /* size of text messages */ 60 61 62 #define TLM_BACKUP_RUN 0x00000001 63 #define TLM_RESTORE_RUN 0x00000002 64 #define TLM_STOP 0x00000009 /* graceful stop */ 65 #define TLM_ABORT 0x99999999 /* abandon the run */ 66 67 #define TLM_EXTRA_SPACE 64 68 #define TLM_MAX_PATH_NAME (PATH_MAX + TLM_EXTRA_SPACE) 69 70 #define ENTRYTYPELEN 14 71 #define PERMS 4 72 #define ID_STR_MAX 20 73 #define APPENDED_ID_MAX (ID_STR_MAX + 1) 74 #define ACL_ENTRY_SIZE (ENTRYTYPELEN + ID_STR_MAX + PERMS + APPENDED_ID_MAX) 75 #define TLM_MAX_ACL_TXT MAX_ACL_ENTRIES * ACL_ENTRY_SIZE 76 77 78 /* operation flags */ 79 #define TLM_OP_CHOOSE_ARCHIVE 0x00000001 /* look for archive bit */ 80 81 /* 82 * Synchronization flags used when launching the TLM threads. 83 */ 84 #define TLM_TAPE_READER 0x00000001 85 #define TLM_TAPE_WRITER 0x00000002 86 #define TLM_SOCK_READER 0x00000004 87 #define TLM_SOCK_WRITER 0x00000008 88 #define TLM_BUF_READER 0x00000010 89 #define TLM_BUF_WRITER 0x00000020 90 #define TLM_TAR_READER 0x00000040 91 #define TLM_TAR_WRITER 0x00000080 92 93 #define SCSI_SERIAL_PAGE 0x80 94 #define SCSI_DEVICE_IDENT_PAGE 0x83 95 #define SCMD_READ_ELEMENT_STATUS 0xB8 96 97 #define OCTAL7CHAR 07777777 98 #define SYSATTR_RDONLY "SUNWattr_ro" 99 #define SYSATTR_RW "SUNWattr_rw" 100 101 typedef int (*func_t)(); 102 103 typedef struct scsi_serial { 104 int sr_flags; 105 char sr_num[16]; 106 } scsi_serial_t; 107 108 typedef struct fs_fhandle { 109 int fh_fid; 110 char *fh_fpath; 111 } fs_fhandle_t; 112 113 typedef struct scsi_link { 114 struct scsi_link *sl_next; 115 struct scsi_link *sl_prev; 116 struct scsi_adapter *sl_sa; 117 unsigned int sl_sid; 118 unsigned int sl_lun; 119 unsigned int sl_requested_max_active; 120 unsigned int sl_granted_max_active; 121 unsigned int sl_n_active; 122 unsigned int sl_type; /* SCSI device type */ 123 } scsi_link_t; 124 125 typedef struct scsi_adapter { 126 struct scsi_adapter *sa_next; 127 char sa_name[16]; 128 struct scsi_link sa_link_head; 129 } scsi_adapter_t; 130 131 typedef struct sasd_drive { 132 char sd_name[256]; 133 char sd_vendor[8 + 1]; 134 char sd_id[16 + 1]; 135 char sd_rev[4 + 1]; 136 char sd_serial[16 + 1]; 137 char sd_wwn[32 + 1]; 138 } sasd_drive_t; 139 140 typedef struct scsi_sasd_drive { 141 sasd_drive_t ss_sd; 142 scsi_link_t ss_slink; 143 } scsi_sasd_drive_t; 144 145 146 #define DEFAULT_SLINK_MAX_XFER (64*1024) 147 148 typedef struct tlm_info { 149 int ti_init_done; /* initialization done ? */ 150 int ti_library_count; /* number of libraries */ 151 struct tlm_library *ti_library; /* first in chain */ 152 struct tlm_chain_link *ti_job_stats; /* chain of job statistics */ 153 } tlm_info_t; 154 155 typedef struct tlm_chain_link { 156 struct tlm_chain_link *tc_next; /* next blob of statistics */ 157 struct tlm_chain_link *tc_prev; /* previous blob in the chain */ 158 int tc_ref_count; /* number of routines */ 159 void *tc_data; /* the data blob */ 160 } tlm_chain_link_t; 161 162 typedef struct tlm_robot { 163 struct tlm_robot *tr_next; 164 struct tlm_library *tr_library; 165 int tr_number; 166 } tlm_robot_t; 167 168 typedef struct tlm_drive { 169 struct tlm_drive *td_next; 170 struct tlm_library *td_library; 171 char td_job_name[TLM_MAX_BACKUP_JOB_NAME]; 172 int td_number; /* number of this tape drive */ 173 int td_element; /* the library's number for the drive */ 174 struct scsi_link *td_slink; /* because the drive may be connected */ 175 /* to a different SCSI card than the */ 176 /* library */ 177 short td_scsi_id; 178 short td_lun; 179 short td_volume_number; /* for current job */ 180 /* an index into the tape set */ 181 int td_fd; /* I/O file descriptor */ 182 int td_errno; /* system error number */ 183 long td_exists : 1; 184 185 } tlm_drive_t; 186 187 typedef struct tlm_slot { 188 struct tlm_slot *ts_next; 189 struct tlm_library *ts_library; 190 int ts_number; /* number of this slot */ 191 int ts_element; 192 short ts_use_count; /* number of times used since loaded */ 193 long ts_status_full : 1; 194 } tlm_slot_t; 195 196 typedef struct tlm_library { 197 struct tlm_library *tl_next; 198 int tl_number; /* number of this tape library */ 199 long tl_capability_robot : 1, 200 tl_capability_door : 1, 201 tl_capability_lock : 1, 202 tl_capability_slots : 1, 203 tl_capability_export : 1, 204 tl_capability_drives : 1, 205 tl_capability_barcodes : 1, 206 tl_ghost_drives : 1; 207 /* 208 * "ghost_drives" is used to make sure that 209 * all drives claimed by the library really 210 * exist ... libraries have been known to lie. 211 */ 212 struct scsi_link *tl_slink; 213 214 int tl_robot_count; 215 tlm_robot_t *tl_robot; 216 int tl_drive_count; 217 tlm_drive_t *tl_drive; 218 int tl_slot_count; 219 tlm_slot_t *tl_slot; 220 } tlm_library_t; 221 222 typedef struct { 223 unsigned char d_name[8]; 224 } device_info_t; 225 226 typedef struct { 227 unsigned char p_number[4]; 228 } port_info_t; 229 230 typedef struct { 231 #ifdef _BIG_ENDIAN 232 uint8_t di_peripheral_qual : 3, 233 di_peripheral_dev_type : 5; 234 uint8_t di_page_code; 235 uint16_t di_page_length; 236 #else 237 uint8_t di_peripheral_dev_type : 5, 238 di_peripheral_qual : 3; 239 uint8_t di_page_code; 240 uint16_t di_page_length; 241 #endif 242 } device_ident_header_t; 243 244 typedef struct { 245 #ifdef _BIG_ENDIAN 246 uint8_t ni_proto_ident : 4, 247 ni_code_set : 4; 248 249 uint8_t ni_PIV : 1, 250 : 1, 251 ni_asso : 2, 252 ni_ident_type : 4; 253 254 uint8_t ni_reserved; 255 uint8_t ni_ident_length; 256 #else 257 uint8_t ni_code_set : 4, 258 ni_proto_ident : 4; 259 260 uint8_t ni_ident_type : 4, 261 ni_asso : 2, 262 : 1, 263 ni_PIV : 1; 264 uint8_t ni_reserved; 265 uint8_t ni_ident_length; 266 #endif 267 } name_ident_t; 268 269 typedef struct { 270 device_ident_header_t np_header; 271 name_ident_t np_node; 272 device_info_t np_node_info; 273 name_ident_t np_port; 274 device_info_t np_port_info; 275 name_ident_t np_portno; 276 port_info_t np_portid; 277 } device_name_page_t; 278 279 #define TLM_NO_ERRORS 0x00000000 280 #define TLM_ERROR_BUSY 0x00000001 281 #define TLM_ERROR_INTERNAL 0x00000002 282 #define TLM_ERROR_NO_ROBOTS 0x00000003 283 #define TLM_TIMEOUT 0x00000004 284 #define TLM_ERROR_RANGE 0x00000005 285 #define TLM_EMPTY 0x00000006 286 #define TLM_DRIVE_NOT_ASSIGNED 0x00000007 287 #define TLM_NO_TAPE_NAME 0x00000008 288 #define TLM_NO_BACKUP_DIR 0x00000009 289 #define TLM_NO_BACKUP_HARDWARE 0x0000000a 290 #define TLM_NO_SOURCE_FILE 0x0000000b 291 #define TLM_NO_FREE_TAPES 0x0000000c 292 #define TLM_EOT 0x0000000d 293 #define TLM_SERIAL_NOT_FOUND 0x0000000e 294 #define TLM_SMALL_READ 0x0000000f 295 #define TLM_NO_RESTORE_FILE 0x00000010 296 #define TLM_EOF 0x00000011 297 #define TLM_NO_DIRECTORY 0x00000012 298 #define TLM_NO_MEMORY 0x00000013 299 #define TLM_WRITE_ERROR 0x00000014 300 #define TLM_NO_SCRATCH_SPACE 0x00000015 301 #define TLM_INVALID 0x00000016 302 #define TLM_MOVE 0x00000017 303 #define TLM_SKIP 0x00000018 304 #define TLM_OPEN_ERR 0x00000019 305 306 307 #define TLM_MAX_TAPE_DRIVES 16 308 #define TLM_NAME_SIZE 100 309 #define TLM_MAX_TAR_IMAGE 017777777770 310 311 #define TLM_VOLNAME_MAX_LENGTH 255 312 #define NAME_MAX 255 313 314 #define TLM_MAGIC "ustar " 315 #define TLM_SNAPSHOT_PREFIX ".zfs" 316 #define TLM_SNAPSHOT_DIR ".zfs/snapshot" 317 318 #define RECORDSIZE 512 319 #define NAMSIZ 100 320 321 typedef struct tlm_tar_hdr { 322 char th_name[TLM_NAME_SIZE]; 323 char th_mode[8]; 324 char th_uid[8]; 325 char th_gid[8]; 326 char th_size[12]; 327 char th_mtime[12]; 328 char th_chksum[8]; 329 char th_linkflag; 330 char th_linkname[TLM_NAME_SIZE]; 331 char th_magic[8]; 332 char th_uname[32]; 333 char th_gname[32]; 334 union { 335 struct { 336 char th_devmajor[8]; 337 char th_devminor[8]; 338 } th_dev; 339 char th_hlink_ino[12]; 340 } th_shared; 341 } tlm_tar_hdr_t; 342 343 344 345 /* 346 * The linkflag defines the type of file 347 */ 348 #define LF_OLDNORMAL '\0' /* Normal disk file, Unix compat */ 349 #define LF_NORMAL '0' /* Normal disk file */ 350 #define LF_LINK '1' /* Link to previously dumped file */ 351 #define LF_SYMLINK '2' /* Symbolic link */ 352 #define LF_CHR '3' /* Character special file */ 353 #define LF_BLK '4' /* Block special file */ 354 #define LF_DIR '5' /* Directory */ 355 #define LF_FIFO '6' /* FIFO special file */ 356 #define LF_CONTIG '7' /* Contiguous file */ 357 /* Further link types may be defined later. */ 358 359 #define LF_DUMPDIR 'D' 360 /* 361 * This is a dir entry that contains 362 * the names of files that were in 363 * the dir at the time the dump 364 * was made 365 */ 366 #define LF_HUMONGUS 'H' 367 /* 368 * Identifies the NEXT file on the tape 369 * as a HUGE file 370 */ 371 #define LF_LONGLINK 'K' 372 /* 373 * Identifies the NEXT file on the tape 374 * as having a long linkname 375 */ 376 #define LF_LONGNAME 'L' 377 /* 378 * Identifies the NEXT file on the tape 379 * as having a long name. 380 */ 381 #define LF_MULTIVOL 'M' 382 /* 383 * This is the continuation 384 * of a file that began on another 385 * volume 386 */ 387 388 #define LF_VOLHDR 'V' /* This file is a tape/volume header */ 389 /* Ignore it on extraction */ 390 391 #define LF_ACL 'A' /* Access Control List */ 392 393 #define LF_XATTR 'E' /* Extended attribute */ 394 395 #define KILOBYTE 1024 396 397 398 /* 399 * ACL support structure 400 */ 401 typedef struct sec_attr { 402 char attr_type; 403 char attr_len[7]; 404 char attr_info[TLM_MAX_ACL_TXT]; 405 } sec_attr_t; 406 407 typedef struct tlm_acls { 408 int acl_checkpointed : 1, /* are checkpoints active ? */ 409 acl_clear_archive : 1, /* clear archive bit ? */ 410 acl_overwrite : 1, /* always overwrite ? */ 411 acl_update : 1, /* only update ? */ 412 acl_non_trivial : 1; /* real ACLs? */ 413 /* 414 * The following fields are here to allow 415 * the backup reader to open a file one time 416 * and keep the information for ACL, ATTRs, 417 * and reading the file. 418 */ 419 sec_attr_t acl_info; 420 421 char acl_root_dir[TLM_VOLNAME_MAX_LENGTH]; /* name of root filesystem */ 422 fs_fhandle_t acl_dir_fh; /* parent dir's info */ 423 fs_fhandle_t acl_fil_fh; /* file's info */ 424 struct stat64 acl_attr; /* file system attributes */ 425 char uname[32]; 426 char gname[32]; 427 } tlm_acls_t; 428 429 430 /* 431 * Tape manager's data archiving ops vector 432 * 433 * This vector represents the granular operations for 434 * performing backup/restore. Each backend should provide 435 * such a vector interface in order to be invoked by NDMP 436 * server. 437 * The reserved callbacks are kept for different backup 438 * types which are volume-based rather than file-based 439 * e.g. zfs send. 440 */ 441 typedef struct tm_ops { 442 char *tm_name; 443 int (*tm_putfile)(); 444 int (*tm_putdir)(); 445 int (*tm_putvol)(); /* Reserved */ 446 int (*tm_getfile)(); 447 int (*tm_getdir)(); 448 int (*tm_getvol)(); /* Reserved */ 449 } tm_ops_t; 450 451 /* The checksum field is filled with this while the checksum is computed. */ 452 #define CHKBLANKS " " /* 8 blanks, no null */ 453 454 #define LONGNAME_PREFIX "././_LoNg_NaMe_" 455 extern void ndmp_log(ulong_t, char *, char *, ...); 456 char ndmp_log_info[256]; 457 #define NDMP_LOG(p, ...) { \ 458 (void) snprintf(ndmp_log_info, \ 459 sizeof (ndmp_log_info), \ 460 "[%d][%s:%d]", \ 461 (int)pthread_self(), __func__, __LINE__); \ 462 ndmp_log(p, ndmp_log_info, __VA_ARGS__); \ 463 } 464 extern void *ndmp_malloc(size_t size); 465 466 /* 467 * ZFS metadata plug-in module structures 468 */ 469 #define ZFS_MAX_PROPS 100 470 #define ZFS_META_MAGIC "ZFSMETA" 471 472 typedef struct ndmp_metadata_property { 473 char mp_name[NAME_MAX]; 474 char mp_value[NAME_MAX]; 475 char mp_source[NAME_MAX]; 476 } ndmp_metadata_property_t; 477 478 typedef struct ndmp_metadata_header { 479 char nh_plname[100]; 480 uint_t nh_plversion; 481 char nh_magic[10]; 482 void *nh_handle; 483 int nh_count; 484 char nh_dataset[NAME_MAX]; 485 ndmp_metadata_property_t nh_property[1]; 486 } ndmp_metadata_header_t; 487 488 /* 489 * Node in struct hardlink_q 490 * 491 * inode: the inode of the hardlink 492 * path: the name of the hardlink, used during restore 493 * offset: tape offset of the data records for the hardlink, used during backup 494 * is_tmp: indicate whether the file was created temporarily for restoring 495 * other links during a non-DAR partial restore 496 */ 497 struct hardlink_node { 498 unsigned long inode; 499 char *path; 500 unsigned long long offset; 501 int is_tmp; 502 SLIST_ENTRY(hardlink_node) next_hardlink; 503 }; 504 505 /* 506 * Hardlinks that have been backed up or restored. 507 * 508 * During backup, each node represents a file whose 509 * (1) inode has multiple links 510 * (2) data has been backed up 511 * 512 * When we run into a file with multiple links during backup, 513 * we first check the list to see whether a file with the same inode 514 * has been backed up. If yes, we backup an empty record, while 515 * making the file history of this file contain the data offset 516 * of the offset of the file that has been backed up. If no, 517 * we backup this file, and add an entry to the list. 518 * 519 * During restore, each node represents an LF_LINK type record whose 520 * data has been restored (v.s. a hard link has been created). 521 * 522 * During restore, when we run into a record of LF_LINK type, we 523 * first check the queue to see whether a file with the same inode 524 * has been restored. If yes, we create a hardlink to it. 525 * If no, we restore the data, and add an entry to the list. 526 */ 527 struct hardlink_q { 528 struct hardlink_node *slh_first; 529 }; 530 531 /* Utility functions from handling hardlink */ 532 extern struct hardlink_q *hardlink_q_init(); 533 extern void hardlink_q_cleanup(struct hardlink_q *qhead); 534 extern int hardlink_q_get(struct hardlink_q *qhead, unsigned long inode, 535 unsigned long long *offset, char **path); 536 extern int hardlink_q_add(struct hardlink_q *qhead, unsigned long inode, 537 unsigned long long offset, char *path, int is_tmp); 538 539 #endif /* !_TLM_H_ */ 540