; ; ************************************************************************* ; * * ; * © Copyright 2010, Hewlett-Packard Development Company, L.P. * ; * * ; * Confidential computer software. Valid license from HP and/or * ; * its subsidiaries required for possession, use, or copying. * ; * * ; * Consistent with FAR 12.211 and 12.212, Commercial Computer Software, * ; * Computer Software Documentation, and Technical Data for Commercial * ; * Items are licensed to the U.S. Government under vendor's standard * ; * commercial license. * ; * * ; * Neither HP nor any of its subsidiaries shall be liable for technical * ; * or editorial errors or omissions contained herein. The information * ; * in this document is provided "as is" without warranty of any kind and * ; * is subject to change without notice. The warranties for HP products * ; * are set forth in the express limited warranty statements accompanying * ; * such products. Nothing herein should be construed as constituting an * ; * additional warranty. * ; * * ; ************************************************************************* ; ******************************************************************************************************************************** ; Created: 30-Mar-2010 17:25:56 by OpenVMS SDL EV3-3 ; Source: 13-FEB-2008 00:08:30 $1$DGA7274:[BACKUP.SRC]BAPIDEF.SDL;1 ; ******************************************************************************************************************************** .MACRO bckapidef,..EQU=<=>,..COL=<:> ; IDENT X-18 S_bck$pointer'..equ'8 bck$pointer'..equ'0 string_ptr'..equ'0 ; 32/64-bit compatible address/pointer ptr_extended'..equ'4 ; bit 31 of "ptr" (previous field) ; sign-extended bckdsc64$S_bck64$descriptor'..equ'24 bck64$descriptor'..equ'0 bckdsc64$w_mbo'..equ'0 ; Must Be == 1 bckdsc64$b_dtype'..equ'2 bckdsc64$b_class'..equ'3 bckdsc64$l_mbmo'..equ'4 ; Must_Be_MINUS_ONE (-1) bckdsc64$S_length'..equ'8 bckdsc64$q_length'..equ'8 ; 64-bit length bckdsc64$r_pointer'..equ'16 ; 64-bit address/pointer bckevt_S_bckEvent'..equ'28 bckEvent'..equ'0 bckevt_r_event_buffer'..equ'0 ; pointer to the event data bckevt_l_event_type'..equ'8 ; type of event bckevt_l_event_subtype'..equ'12 ; Additional event specifiers bckevt_S_event_ctx'..equ'8 bckevt_q_event_ctx'..equ'16 ; (reserved for future use) bckevt_l_event_handle'..equ'24 ; (reserved for future use) ; ; BACKUP Operation Event Types ; BCK_K_EVENT_MIN'..equ'1 BCK_EVENT_K_CONTROL'..equ'1 BCK_EVENT_K_ERROR_MSG'..equ'2 BCK_EVENT_K_FILE_OPEN'..equ'3 BCK_EVENT_K_FILE_READ'..equ'4 BCK_EVENT_K_FILE_WRITE'..equ'5 BCK_EVENT_K_FILE_CLOSE'..equ'6 BCK_EVENT_K_JOURNAL_OPEN'..equ'7 BCK_EVENT_K_JOURNAL_WRITE'..equ'8 BCK_EVENT_K_JOURNAL_CLOSE'..equ'9 BCK_EVENT_K_LIST_OPEN'..equ'10 BCK_EVENT_K_LIST_WRITE'..equ'11 BCK_EVENT_K_LISTJOUR_WRITE'..equ'12 BCK_EVENT_K_LIST_CLOSE'..equ'13 BCK_EVENT_K_LOG'..equ'14 BCK_EVENT_K_OP_PHASE'..equ'15 BCK_EVENT_K_SAVESET_OPEN'..equ'16 BCK_EVENT_K_SAVESET_READ'..equ'17 BCK_EVENT_K_SAVESET_WRITE'..equ'18 BCK_EVENT_K_SAVESET_CLOSE'..equ'19 BCK_EVENT_K_STATISTICS'..equ'20 BCK_EVENT_K_USER_MSG'..equ'21 ; ! Start for New callback event by R.Sato BCK_EVENT_K_CONVERT_FILENAME'..equ'22 ; ! End for New callback event by R.Sato BCK_K_EVENT_MAX'..equ'22 BCK_K_EVENT_ALL'..equ'-1 ; ; BACKUP Operation Event Type MASK def's ; BCK_EVENT_M_CONTROL'..equ'^X1 BCK_EVENT_M_ERROR_MSG'..equ'^X2 BCK_EVENT_M_FILE_OPEN'..equ'^X4 BCK_EVENT_M_FILE_READ'..equ'^X8 BCK_EVENT_M_FILE_WRITE'..equ'^X10 BCK_EVENT_M_FILE_CLOSE'..equ'^X20 BCK_EVENT_M_JOURNAL_OPEN'..equ'^X40 BCK_EVENT_M_JOURNAL_WRITE'..equ'^X80 BCK_EVENT_M_JOURNAL_CLOSE'..equ'^X100 BCK_EVENT_M_LIST_OPEN'..equ'^X200 BCK_EVENT_M_LIST_WRITE'..equ'^X400 BCK_EVENT_M_LISTJOUR_WRITE'..equ'^X800 BCK_EVENT_M_LIST_CLOSE'..equ'^X1000 BCK_EVENT_M_LOG'..equ'^X2000 BCK_EVENT_M_OP_PHASE'..equ'^X4000 BCK_EVENT_M_SAVESET_OPEN'..equ'^X8000 BCK_EVENT_M_SAVESET_READ'..equ'^X10000 BCK_EVENT_M_SAVESET_WRITE'..equ'^X20000 BCK_EVENT_M_SAVESET_CLOSE'..equ'^X40000 BCK_EVENT_M_STATISTICS'..equ'^X80000 BCK_EVENT_M_USER_MSG'..equ'^X100000 BCK_EVENT_M_CONVERT_FILENAME'..equ'^X200000 BCK_EVENT_M_ALL'..equ'^X400000 BCK_EVENT_V_CONTROL'..equ'0 BCK_EVENT_V_ERROR_MSG'..equ'1 BCK_EVENT_V_FILE_OPEN'..equ'2 BCK_EVENT_V_FILE_READ'..equ'3 BCK_EVENT_V_FILE_WRITE'..equ'4 BCK_EVENT_V_FILE_CLOSE'..equ'5 BCK_EVENT_V_JOURNAL_OPEN'..equ'6 BCK_EVENT_V_JOURNAL_WRITE'..equ'7 BCK_EVENT_V_JOURNAL_CLOSE'..equ'8 BCK_EVENT_V_LIST_OPEN'..equ'9 BCK_EVENT_V_LIST_WRITE'..equ'10 BCK_EVENT_V_LISTJOUR_WRITE'..equ'11 BCK_EVENT_V_LIST_CLOSE'..equ'12 BCK_EVENT_V_LOG'..equ'13 BCK_EVENT_V_OP_PHASE'..equ'14 BCK_EVENT_V_SAVESET_OPEN'..equ'15 BCK_EVENT_V_SAVESET_READ'..equ'16 BCK_EVENT_V_SAVESET_WRITE'..equ'17 BCK_EVENT_V_SAVESET_CLOSE'..equ'18 BCK_EVENT_V_STATISTICS'..equ'19 BCK_EVENT_V_USER_MSG'..equ'20 ; ! Start for New callback event by R.Sato BCK_EVENT_V_CONVERT_FILENAME'..equ'21 ; ! End for New callback event by R.Sato BCK_EVENT_V_ALL'..equ'22 ; ; BACKUP Operation Event Subtypes ; BCKEVTST_K_MIN_EVENT'..equ'1 BCKEVTST_K_CONFIRM_EVENT'..equ'1 BCKEVTST_K_ASSIST_EVENT'..equ'2 BCKEVTST_K_RESTART_EVENT'..equ'3 BCKEVTST_K_MAX_EVENT'..equ'1 ; ; Journal List Information ; bck_S_bckLisJourblk'..equ'28 bckLisJourblk'..equ'0 bck_R_LJ_SS_Name'..equ'0 ; [Current] Saveset Filename bck_S_LJ_SS_Date'..equ'8 bck_Q_LJ_SS_Date'..equ'8 ; " Saveset Creation Date bck_R_LJ_Vol_Name'..equ'16 ; [Current] Volume Name bck_L_LJ_Vol_Number'..equ'24 ; " Relative Volume Number ; ; BACKUP API Message structure definitions ; BCKMSGDESC_HDR_SIZE'..equ'8 S_bckMsgDesc'..equ'40 bckMsgDesc'..equ'0 ; User-Supplied Message Descriptor msg_code'..equ'0 ; Error/condition value FAOarg_count'..equ'4 ; Number of FAO parameters new_msg_options'..equ'6 ; Message options for the current msg. S_FAO_param'..equ'32 FAO_param'..equ'8 ; FAO parameters (<9 for backup msgs) BCKMSGVECT_HDR_SIZE'..equ'4 S_bckMsgVect'..equ'84 bckMsgVect'..equ'0 ; Std. Message Argument Vector bckMsgVect_argcnt'..equ'0 ; Number of msg descriptors bckMsgVect_defmsgopts'..equ'2 ; Default message options bckMsgVect_msgdescs'..equ'4 ; VARIABLE LENGTH array ; (used [2] for C compiler compatibility) ; ; BACKUP API Control definitions ; bckCntrl_m_response_required'..equ'^X1 bckCntrl_S_bckControl'..equ'32 bckControl'..equ'0 bckCntrl_l_event'..equ'0 ; control event type bckCntrl_l_function'..equ'4 ; backup operation type bckCntrl_a_outmsgvect'..equ'8 ; output messages and parameters bckCntrl_l_ctlflags'..equ'12 ; flags bckCntrl_v_response_required'..equ'0 ; response required = 1 bckCntrl_r_response_buffer'..equ'16 ; desc. for buffer to which ; response text is to be written bckCntrl_l_response_status'..equ'24 ; (reserved for future use) bckCntrl_l_control_options'..equ'28 ; (reserved for future use) ; ; BACKUP Operation Control Event Types ; BCKCNTRL_K_MIN_EVENT'..equ'1 BCKCNTRL_K_CONFIRM_EVENT'..equ'1 BCKCNTRL_K_OPER_ASSIST_EVENT'..equ'2 BCKCNTRL_K_USER_ASSIST_EVENT'..equ'4 BCKCNTRL_K_RESTART_EVENT'..equ'8 BCKCNTRL_K_MAX_EVENT'..equ'8 ; ; backup operation type definitions ; BCK_OP_K_MIN'..equ'1 BCK_OP_K_SAVE'..equ'1 BCK_OP_K_RESTORE'..equ'2 BCK_OP_K_COPY'..equ'4 BCK_OP_K_LIST'..equ'8 BCK_OP_K_COMPARE'..equ'16 BCK_OP_K_MAX'..equ'16 BCK_K_OP_MASK'..equ'31 ; ; arg buffer items/options ; BCK_OPT_K_BCK_K_OPT_MIN'..equ'0 ; ; NEVER REMOVE from the following list !!! (obsolete items will be denoted) ; ; Always ADD items to the END of the following list !!! ; (To maintain interface compatibility with prior versions) ; BCK_OPT_K_END_OPT'..equ'0 BCK_OPT_K_ALIAS'..equ'1 BCK_OPT_K_ASSIST'..equ'2 BCK_OPT_K_BACKUP'..equ'3 BCK_OPT_K_BEFORE_TYPE'..equ'4 ; before_backup usage is /BEFORE=BACKUP BCK_OPT_K_BEFORE_VALUE'..equ'5 BCK_OPT_K_BLOCK'..equ'6 ; block_value BCK_OPT_K_CREATED'..equ'7 BCK_OPT_K_CARTRIDGE_MEDIA_IN'..equ'8 BCK_OPT_K_CARTRIDGE_NAME_IN'..equ'9 BCK_OPT_K_CARTRIDGE_SIDE_IN'..equ'10 BCK_OPT_K_CARTRIDGE_MEDIA_OUT'..equ'11 BCK_OPT_K_CARTRIDGE_NAME_OUT'..equ'12 BCK_OPT_K_CARTRIDGE_SIDE_OUT'..equ'13 BCK_OPT_K_COMMAND'..equ'14 BCK_OPT_K_COMMENT'..equ'15 BCK_OPT_K_COMPARE'..equ'16 BCK_OPT_K_CONFIRM'..equ'17 BCK_OPT_K_CRC'..equ'18 BCK_OPT_K_DELETE'..equ'19 BCK_OPT_K_DENSITY'..equ'20 BCK_OPT_K_DISMOUNT'..equ'21 ; Note: ; Dismount is _NOT_ supported and _NOT_ implemented, (ignored), ; but is included here as a place-holder. BCK_OPT_K_DISPOSITION'..equ'22 ; disp_keep ; disp_release BCK_OPT_K_DRIVE_CLASS_IN'..equ'23 BCK_OPT_K_DRIVE_CLASS_OUT'..equ'24 BCK_OPT_K_ENCRYPT'..equ'25 BCK_OPT_K_ENCRYPT_USERALG'..equ'26 BCK_OPT_K_ENCRYPT_USERKEY'..equ'27 BCK_OPT_K_ENCRYPT_KEY_VALUE'..equ'28 BCK_OPT_K_EVENT_CALLBACK'..equ'29 BCK_OPT_K_EXACT_ORDER'..equ'30 BCK_OPT_K_EXCLUDE'..equ'31 BCK_OPT_K_EXPIRED'..equ'32 BCK_OPT_K_FAST'..equ'33 BCK_OPT_K_FILE_CALLBACK'..equ'34 ; Note: ; File_callback is _NOT_ implemented, but is included here as a place-holder. ; BCK_OPT_K_FILEMERGE'..equ'35 ; Note: ; Filemerge is _NOT_ supported and _NOT_ implemented, ; but is included here as a place-holder. ; BCK_OPT_K_FULL'..equ'36 BCK_OPT_K_GROUP'..equ'37 BCK_OPT_K_HANDLE'..equ'38 BCK_OPT_K_IGNORE_TYPES'..equ'39 ; ignore_access ; ignore_interlock ; ignore_label ; ignore_nobackup BCK_OPT_K_IMAGE'..equ'40 BCK_OPT_K_INCREMENTAL'..equ'41 BCK_OPT_K_INITIALIZE'..equ'42 BCK_OPT_K_INPUT'..equ'43 BCK_OPT_K_INTERCHANGE'..equ'44 BCK_OPT_K_JOURNAL'..equ'45 BCK_OPT_K_JOURNAL_FILE'..equ'46 BCK_OPT_K_LABEL'..equ'47 BCK_OPT_K_LIST'..equ'48 BCK_OPT_K_LIST_FILE'..equ'49 BCK_OPT_K_LOG'..equ'50 BCK_OPT_K_MEDIA_FORMAT'..equ'51 ; media_compaction ; media_no_compaction BCK_OPT_K_MODIFIED'..equ'52 BCK_OPT_K_NEW_VERSION'..equ'53 BCK_OPT_K_OPERATION_TYPE'..equ'54 ; compare ; copy ; list ; save ; restore BCK_OPT_K_OUTPUT'..equ'55 BCK_OPT_K_OVERLAY'..equ'56 BCK_OPT_K_OWNER_IN_VALUE'..equ'57 ; own_uic (value or default) BCK_OPT_K_OWNER_OUT_TYPE'..equ'58 ; own_default ; own_original ; own_parent ; own_uic BCK_OPT_K_OWNER_OUT_VALUE'..equ'59 BCK_OPT_K_PHYSICAL'..equ'60 BCK_OPT_K_PROTECTION'..equ'61 BCK_OPT_K_RECORD'..equ'62 BCK_OPT_K_RELEASE_TAPE'..equ'63 BCK_OPT_K_REPLACE'..equ'64 ; rewind is now obsolete, please use either REWIND_IN or REWIND_OUT. BCK_OPT_K_REWIND'..equ'65 ; rewind is now obsolete, please use either REWIND_IN or REWIND_OUT. BCK_OPT_K_REWIND_IN'..equ'66 BCK_OPT_K_REWIND_OUT'..equ'67 BCK_OPT_K_SAVE_SET_IN'..equ'68 BCK_OPT_K_SAVE_SET_OUT'..equ'69 BCK_OPT_K_SCRATCH_ASGN_TYPE'..equ'70 BCK_OPT_K_SCRATCH_COLLECTION'..equ'71 BCK_OPT_K_SCRATCH_LOCATION'..equ'72 BCK_OPT_K_SCRATCH_MEDIA_NAME'..equ'73 BCK_OPT_K_SELECT'..equ'74 BCK_OPT_K_SINCE_TYPE'..equ'75 ; since_backup usage is /SINCE=BACKUP BCK_OPT_K_SINCE_VALUE'..equ'76 BCK_OPT_K_STORAGE_MANAGEMENT'..equ'77 BCK_OPT_K_TAPE_EXPIRATION'..equ'78 BCK_OPT_K_TRUNCATE'..equ'79 BCK_OPT_K_VALIDATE_PARAMETERS'..equ'80 BCK_OPT_K_VERIFY'..equ'81 BCK_OPT_K_UNSHELVE'..equ'82 BCK_OPT_K_VOLUME'..equ'83 ; ; Items added in V7.2 ; BCK_OPT_K_SNAPSHOT'..equ'84 BCK_OPT_K_CONVERT'..equ'85 BCK_OPT_K_MT3_DENSITY'..equ'86 ; ; Items added *after* V7.2 for HSM support ; Changed HSM to HSMHEADER_ONLY ; HSM was never used so I changed it because ; HSMHEADER_ONLY does the same thing that HSM was suppose ; to do BCK_OPT_K_HSMHEADER_ONLY'..equ'87 ; Changed OPTIONS_IN AND OPTIONS_OUT to /HSMOPTIONS_* ; they were not used before and I put am using /HSMOPTIONS ; for the qualifier so we do not waste a good /OPTIONS qualifier BCK_OPT_K_HSMOPTIONS_IN'..equ'88 BCK_OPT_K_HSMOPTIONS_OUT'..equ'89 BCK_OPT_K_PRESHELVED'..equ'90 BCK_OPT_K_SHELVED'..equ'91 ; Item added for /FILES_SELECTED and /INPUT_FILES BCK_OPT_K_FILES_SELECTED_IN'..equ'92 BCK_OPT_K_INPUT_FILES_IN'..equ'93 BCK_OPT_K_DVE_LIMIT'..equ'94 BCK_OPT_K_DVE_SIZE'..equ'95 BCK_OPT_K_IO_LOAD'..equ'96 BCK_OPT_K_PROGRESS'..equ'97 BCK_OPT_K_REPAIR'..equ'98 BCK_OPT_K_DATA_FORMAT'..equ'99 BCK_OPT_K_DATA_FORMAT_COMPRESS'..equ'100 BCK_OPT_K_NOCONVERT'..equ'101 BCK_OPT_K_WINDOW_TYPES'..equ'102 ; window_full ; window_limited ; ; NEVER REMOVE items from the above list !!! ; (obsolete items will be denoted) ; ; Always ADD items to the END of the above list !!! ; (To maintain interface compatibility with prior versions) ; BCK_K_OPT_MAX'..equ'102 ; ; Flag Definitions for various Types of Options ; BCK_OPTYP_BEFORE_K_BACKUP'..equ'1 ; usage is /BEFORE=BACKUP BCK_K_OPTYP_BEFORE_MASK'..equ'1 BCK_OPTYP_RELTAPE_K_NONE'..equ'0 BCK_OPTYP_RELTAPE_K_UNLOAD'..equ'1 BCK_OPTYP_RELTAPE_K_NO_UNLOAD'..equ'2 BCK_OPTYP_DISMOU_K_UNLOAD'..equ'1 BCK_OPTYP_DISMOU_K_NO_UNLOAD'..equ'2 BCK_OPTYP_DISP_K_KEEP'..equ'1 BCK_OPTYP_DISP_K_RELEASE'..equ'2 BCK_OPTYP_IGNORE_K_NOBACKUP'..equ'1 BCK_OPTYP_IGNORE_K_INTERLOCK'..equ'2 BCK_OPTYP_IGNORE_K_LABELS'..equ'4 BCK_OPTYP_IGNORE_K_ACCESS'..equ'8 BCK_OPTYP_IGNORE_K_LIMIT'..equ'1024 BCK_K_OPTYP_IGNORE_MASK'..equ'2047 BCK_OPTYP_MEDIA_K_COMPACTION'..equ'1 BCK_OPTYP_MEDIA_K_NO_COMPACTION'..equ'2 BCK_OPTYP_OWN_OUT_K_DEFAULT'..equ'1 BCK_OPTYP_OWN_OUT_K_ORIGINAL'..equ'2 BCK_OPTYP_OWN_OUT_K_PARENT'..equ'3 BCK_OPTYP_OWN_OUT_K_UIC'..equ'4 BCK_OPTYP_SCR_ASGN_K_BASE'..equ'1 BCK_OPTYP_SCR_ASGN_K_COMPOUND'..equ'2 BCK_OPTYP_SCR_ASGN_K_PREASGN'..equ'4 BCK_OPTYP_SCR_ASGN_K_SIDE'..equ'8 BCK_K_OPTYP_SCR_ASGN_MASK'..equ'15 BCK_OPTYP_SINCE_K_BACKUP'..equ'1 ; usage is /SINCE=BACKUP BCK_K_OPTYP_SINCE_MASK'..equ'1 BCK_OPTYP_WINDOW_K_FULL'..equ'1 BCK_OPTYP_WINDOW_K_LIMITED'..equ'2 ; *** RESERVED FOR POSSIBLE FUTURE USE *** ; File name string format flags, (used to indicate non-escaped/non-generated ; file name strings that are compatible with QIO parameter calls). ; BCK_FNSTR_K_ODS2'..equ'1 BCK_FNSTR_K_EXTENDED'..equ'2 BCK_FNSTR_K_UCS2'..equ'4 BCK_K_FNSTR_MASK'..equ'7 ; ; Backup Option Structures, (used to specify backup operation attributes). ; bck_opt_struct_flag_k_len'..equ'8 S_bck_opt_struct_flag'..equ'8 bck_opt_struct_flag'..equ'0 option_type'..equ'0 ; type of option/operation opt_flag_value'..equ'4 ; option flag(s) bck_opt_struct_int_k_len'..equ'16 S_bck_opt_struct_int'..equ'16 bck_opt_struct_int'..equ'0 opt_int_type'..equ'0 ; type of option/operation int_filler'..equ'4 ; (Quadword alignment filler) S_opt_int_value'..equ'8 opt_int_value'..equ'8 ; 64-bit/32-bit integer ; Note: the 32-bit integer should be ; sign-extended into 2nd longword bck_opt_struct_adr_k_len'..equ'16 S_bck_opt_struct_adr'..equ'16 bck_opt_struct_adr'..equ'0 opt_adr_type'..equ'0 ; type of option/operation opt_adr_attributes'..equ'4 ; Address Attributes (uses) S_opt_adr_value'..equ'8 opt_adr_value'..equ'8 ; 64-bit/32-bit address ; Note: the 32-bit address should be ; sign-extended into 2nd longword bck_opt_struct_dsc_k_len'..equ'16 S_bck_opt_struct_dsc'..equ'16 bck_opt_struct_dsc'..equ'0 opt_dsc_type'..equ'0 ; type of option/operation dsc_flags'..equ'4 ; Flags & Quadword alignment opt_dsc'..equ'8 ; 32-bit string descriptor bck_opt_struct_dsc_k_len64'..equ'32 S_bck_opt_struct_dsc64'..equ'32 bck_opt_struct_dsc64'..equ'0 opt_dsc64_type'..equ'0 ; type of option/operation dsc64_flags'..equ'4 ; Flags & Quadword alignment opt_dsc64'..equ'8 ; 64-bit string descriptor bck_opt_struct_dt_k_len'..equ'16 S_bck_opt_struct_dt'..equ'16 bck_opt_struct_dt'..equ'0 opt_adt_type'..equ'0 ; type of option/operation adt_filler'..equ'4 ; (Quadword alignment filler) S_opt_adt_value'..equ'8 opt_adt_value'..equ'8 ; date-time (ADT) .ENDM