29 #ifndef GLOBUS_GRIDFTP_SERVER_H 30 #define GLOBUS_GRIDFTP_SERVER_H 33 #include "globus_gridftp_server_control.h" 35 #ifdef TARGET_ARCH_WIN32 41 #ifndef TARGET_ARCH_WIN32 45 #define GLOBUS_MAPPING_STRING ":globus-mapping:" 48 #define GLOBUS_GRIDFTP_SERVER_MODULE (&globus_i_gfs_module) 50 extern globus_extension_registry_t globus_i_gfs_dsi_registry;
51 #define GLOBUS_GFS_DSI_REGISTRY &globus_i_gfs_dsi_registry 53 extern globus_extension_registry_t globus_i_gfs_acl_registry;
54 #define GLOBUS_GFS_ACL_REGISTRY &globus_i_gfs_acl_registry 60 typedef enum globus_gfs_error_type_e
62 GLOBUS_GFS_ERROR_MEMORY = 1,
63 GLOBUS_GFS_ERROR_PARAMETER,
64 GLOBUS_GFS_ERROR_SYSTEM_ERROR,
65 GLOBUS_GFS_ERROR_WRAPPED,
66 GLOBUS_GFS_ERROR_DATA,
67 GLOBUS_GFS_ERROR_GENERIC
68 } globus_gfs_error_type_t;
75 typedef enum globus_gfs_operation_type_e
77 GLOBUS_GFS_OP_FINAL_REPLY = 1,
78 GLOBUS_GFS_OP_EVENT_REPLY,
80 GLOBUS_GFS_OP_SESSION_START,
81 GLOBUS_GFS_OP_SESSION_STOP,
85 GLOBUS_GFS_OP_COMMAND,
86 GLOBUS_GFS_OP_PASSIVE,
88 GLOBUS_GFS_OP_DESTROY,
89 GLOBUS_GFS_OP_TRANSFER,
91 GLOBUS_GFS_OP_BUFFER_SEND,
92 GLOBUS_GFS_OP_HANDSHAKE,
93 GLOBUS_GFS_OP_SESSION_START_REPLY,
94 GLOBUS_GFS_OP_INTERMEDIATE_REPLY
95 } globus_gfs_operation_type_t;
97 #define GLOBUS_GFS_OP_STAT_PARTIAL GLOBUS_GFS_OP_INTERMEDIATE_REPLY 105 typedef enum globus_gfs_command_type_e
107 GLOBUS_GFS_CMD_MKD = 1,
110 GLOBUS_GFS_CMD_SITE_AUTHZ_ASSERT,
111 GLOBUS_GFS_CMD_SITE_RDEL,
115 GLOBUS_GFS_CMD_SITE_CHMOD,
116 GLOBUS_GFS_CMD_SITE_DSI,
117 GLOBUS_GFS_CMD_SITE_SETNETSTACK,
118 GLOBUS_GFS_CMD_SITE_SETDISKSTACK,
119 GLOBUS_GFS_CMD_SITE_CLIENTINFO,
121 GLOBUS_GFS_CMD_SITE_CHGRP,
122 GLOBUS_GFS_CMD_SITE_UTIME,
123 GLOBUS_GFS_CMD_SITE_SYMLINKFROM,
124 GLOBUS_GFS_CMD_SITE_SYMLINK,
125 GLOBUS_GFS_CMD_HTTP_PUT,
126 GLOBUS_GFS_CMD_HTTP_GET,
127 GLOBUS_GFS_CMD_HTTP_CONFIG,
129 GLOBUS_GFS_CMD_SITE_TASKID,
132 GLOBUS_GFS_CMD_SITE_RESTRICT = 3072,
133 GLOBUS_GFS_CMD_SITE_CHROOT,
134 GLOBUS_GFS_CMD_SITE_SHARING,
137 GLOBUS_GFS_CMD_STORATTR,
138 GLOBUS_GFS_CMD_WHOAMI,
140 GLOBUS_GFS_MIN_CUSTOM_CMD = 4096
141 } globus_gfs_command_type_t;
208 typedef enum globus_gfs_buffer_type_e
210 GLOBUS_GFS_BUFFER_EOF_INFO = 0x0001,
211 GLOBUS_GFS_BUFFER_SERVER_DEFINED = 0xFFFF
213 } globus_gfs_buffer_type_t;
220 typedef enum globus_gfs_layout_type_e
222 GLOBUS_GFS_LAYOUT_PARTITIONED = 1,
223 GLOBUS_GFS_LAYOUT_BLOCKED
224 } globus_gfs_layout_type_t;
259 typedef struct globus_i_gfs_op_info_s * globus_gfs_op_info_t;
267 typedef struct globus_gfs_data_finished_info_s
278 const char ** contact_strings;
279 } globus_gfs_data_finished_info_t;
286 typedef struct globus_gfs_cmd_finshed_info_s
289 globus_gfs_command_type_t command;
294 } globus_gfs_cmd_finshed_info_t;
301 typedef struct globus_gfs_stat_finished_info_s
313 } globus_gfs_stat_finished_info_t;
320 typedef struct globus_gfs_session_finished_info_s
328 } globus_gfs_session_finished_info_t;
335 typedef struct globus_gfs_transfer_finished_info_s
338 globus_off_t bytes_transferred;
340 } globus_gfs_transfer_finished_info_t;
347 typedef struct globus_gfs_finished_info_s
350 globus_gfs_operation_type_t type;
363 globus_gfs_session_finished_info_t session;
364 globus_gfs_data_finished_info_t data;
365 globus_gfs_cmd_finshed_info_t command;
366 globus_gfs_stat_finished_info_t stat;
367 globus_gfs_transfer_finished_info_t transfer;
371 globus_gfs_op_info_t op_info;
372 } globus_gfs_finished_info_t;
379 typedef struct globus_gfs_event_info_s
396 globus_off_t recvd_bytes;
398 globus_range_list_t recvd_ranges;
409 globus_gfs_op_info_t op_info;
410 } globus_gfs_event_info_t;
417 typedef struct globus_gfs_transfer_info_s
428 globus_off_t partial_offset;
430 globus_off_t partial_length;
432 globus_range_list_t range_list;
448 globus_off_t alloc_size;
451 char * expected_checksum;
453 char * expected_checksum_alg;
458 int traversal_options;
461 globus_gfs_op_info_t op_info;
462 } globus_gfs_transfer_info_t;
468 #define rnfr_pathname from_pathname 475 typedef struct globus_gfs_command_info_s
478 globus_gfs_command_type_t command;
483 globus_off_t cksm_offset;
485 globus_off_t cksm_length;
494 char * from_pathname;
506 globus_gfs_op_info_t op_info;
507 } globus_gfs_command_info_t;
514 typedef struct globus_gfs_data_info_s
547 const char ** contact_strings;
553 gss_cred_id_t del_cred;
556 globus_gfs_op_info_t op_info;
557 } globus_gfs_data_info_t;
564 typedef struct globus_gfs_stat_info_s
578 globus_gfs_op_info_t op_info;
579 } globus_gfs_stat_info_t;
581 typedef struct globus_gfs_session_info_s
583 gss_cred_id_t del_cred;
593 globus_gfs_op_info_t op_info;
594 } globus_gfs_session_info_t;
596 typedef enum globus_gfs_brain_reason_e
598 GLOBUS_GFS_BRAIN_REASON_ERROR = 1,
599 GLOBUS_GFS_BRAIN_REASON_COMPLETE
600 } globus_gfs_brain_reason_t;
602 typedef struct globus_i_gfs_brain_node_s
608 int current_connection;
610 } globus_i_gfs_brain_node_t;
625 typedef struct globus_l_gfs_data_operation_s * globus_gfs_operation_t;
643 globus_gfs_operation_t op,
644 globus_gfs_session_info_t * session_info);
651 (*globus_gfs_storage_destroy_t)(
660 (*globus_gfs_storage_transfer_t)(
661 globus_gfs_operation_t op,
662 globus_gfs_transfer_info_t * transfer_info,
672 (*globus_gfs_storage_command_t)(
673 globus_gfs_operation_t op,
674 globus_gfs_command_info_t * command_info,
683 (*globus_gfs_storage_stat_t)(
684 globus_gfs_operation_t op,
685 globus_gfs_stat_info_t * stat_info,
695 (*globus_gfs_storage_data_t)(
696 globus_gfs_operation_t op,
697 globus_gfs_data_info_t * data_info,
708 (*globus_gfs_storage_data_destroy_t)(
720 (*globus_gfs_storage_trev_t)(
721 globus_gfs_event_info_t * event_info,
731 (*globus_gfs_storage_set_cred_t)(
732 gss_cred_id_t del_cred,
742 (*globus_gfs_storage_buffer_send_t)(
759 (*globus_gfs_storage_realpath_t)(
760 const char * in_path,
761 char ** out_realpath,
765 #define GLOBUS_GFS_DSI_DESCRIPTOR_SENDER (1 << 0) 766 #define GLOBUS_GFS_DSI_DESCRIPTOR_BLOCKING (1 << 1) 767 #define GLOBUS_GFS_DSI_DESCRIPTOR_HAS_REALPATH (1 << 2) 768 #define GLOBUS_GFS_DSI_DESCRIPTOR_REQUIRES_ORDERED_DATA (1 << 3) 769 #define GLOBUS_GFS_DSI_DESCRIPTOR_SETS_ERROR_RESPONSES (1 << 4) 770 #define GLOBUS_GFS_DSI_DESCRIPTOR_SAFE_RDEL (1 << 5) 780 typedef struct globus_gfs_storage_iface_s
786 globus_gfs_storage_destroy_t destroy_func;
789 globus_gfs_storage_transfer_t list_func;
790 globus_gfs_storage_transfer_t send_func;
791 globus_gfs_storage_transfer_t recv_func;
792 globus_gfs_storage_trev_t trev_func;
795 globus_gfs_storage_data_t active_func;
796 globus_gfs_storage_data_t passive_func;
797 globus_gfs_storage_data_destroy_t data_destroy_func;
799 globus_gfs_storage_command_t command_func;
800 globus_gfs_storage_stat_t stat_func;
802 globus_gfs_storage_set_cred_t set_cred_func;
803 globus_gfs_storage_buffer_send_t buffer_send_func;
804 globus_gfs_storage_realpath_t realpath_func;
805 } globus_gfs_storage_iface_t;
821 globus_gfs_operation_t op,
823 globus_gfs_finished_info_t * finished_info);
833 globus_gridftp_server_operation_event(
834 globus_gfs_operation_t op,
836 globus_gfs_event_info_t * event_info);
844 globus_gridftp_server_begin_transfer(
845 globus_gfs_operation_t op,
855 globus_gridftp_server_finished_transfer(
856 globus_gfs_operation_t op,
866 globus_gridftp_server_finished_session_start(
867 globus_gfs_operation_t op,
881 globus_gridftp_server_finished_command(
882 globus_gfs_operation_t op,
884 char * command_response);
886 globus_gridftp_server_intermediate_command(
887 globus_gfs_operation_t op,
889 char * command_response);
897 globus_gridftp_server_finished_stat(
898 globus_gfs_operation_t op,
904 globus_gridftp_server_finished_stat_partial(
905 globus_gfs_operation_t op,
911 globus_gridftp_server_finished_stat_custom_list(
912 globus_gfs_operation_t op,
924 globus_gridftp_server_finished_active_data(
925 globus_gfs_operation_t op,
936 globus_gridftp_server_finished_passive_data(
937 globus_gfs_operation_t op,
941 const char ** contact_strings,
961 globus_gfs_operation_t op,
968 globus_gridftp_server_register_write(
969 globus_gfs_operation_t op,
987 (*globus_gridftp_server_read_cb_t)(
988 globus_gfs_operation_t op,
997 globus_gridftp_server_register_read(
998 globus_gfs_operation_t op,
1001 globus_gridftp_server_read_cb_t callback,
1040 globus_gridftp_server_add_command(
1041 globus_gfs_operation_t op,
1042 const char * command_name,
1046 const char * help_string,
1062 GLOBUS_GFS_OP_INFO_CMD_ARGS = 1
1072 globus_gridftp_server_query_op_info(
1073 globus_gfs_operation_t op,
1074 globus_gfs_op_info_t op_info,
1089 globus_gridftp_server_get_recv_attr_string(
1090 globus_gfs_operation_t op,
1091 const char * requested_attr,
1101 globus_gridftp_server_get_recv_modification_time(
1102 globus_gfs_operation_t op,
1116 globus_gridftp_server_update_bytes_written(
1117 globus_gfs_operation_t op,
1118 globus_off_t offset,
1119 globus_off_t length);
1132 globus_gridftp_server_update_bytes_recvd(
1133 globus_gfs_operation_t op,
1134 globus_off_t length);
1147 globus_gridftp_server_update_range_recvd(
1148 globus_gfs_operation_t op,
1149 globus_off_t offset,
1150 globus_off_t length);
1159 globus_gridftp_server_get_optimal_concurrency(
1160 globus_gfs_operation_t op,
1171 globus_gridftp_server_get_block_size(
1172 globus_gfs_operation_t op,
1182 globus_gridftp_server_get_stripe_block_size(
1183 globus_gfs_operation_t op,
1194 globus_gridftp_server_get_session_username(
1195 globus_gfs_operation_t op,
1207 globus_gridftp_server_get_delegated_cred(
1208 globus_gfs_operation_t op,
1209 gss_cred_id_t * del_cred);
1223 globus_gridftp_server_get_sec_context(
1224 globus_gfs_operation_t op,
1225 gss_ctx_id_t * context);
1244 globus_gridftp_server_set_ordered_data(
1245 globus_gfs_operation_t op,
1249 globus_gridftp_server_get_ordered_data(
1250 globus_gfs_operation_t op,
1260 globus_gridftp_server_get_config_string(
1261 globus_gfs_operation_t op,
1262 char ** config_string);
1272 globus_gridftp_server_get_config_data(
1273 globus_gfs_operation_t op,
1275 char ** config_data);
1278 globus_gfs_data_get_file_stack_list(
1279 globus_gfs_operation_t in_op,
1283 globus_gridftp_server_get_update_interval(
1284 globus_gfs_operation_t op,
1296 globus_gridftp_server_get_read_range(
1297 globus_gfs_operation_t op,
1298 globus_off_t * offset,
1299 globus_off_t * length);
1312 globus_gridftp_server_get_write_range(
1313 globus_gfs_operation_t op,
1314 globus_off_t * offset,
1315 globus_off_t * length);
1322 GLOBUS_GFS_LOG_ERR = 0x01,
1323 GLOBUS_GFS_LOG_WARN = 0x02,
1324 GLOBUS_GFS_LOG_TRANSFER = 0x04,
1325 GLOBUS_GFS_LOG_INFO = 0x08,
1326 GLOBUS_GFS_LOG_DUMP = 0x10,
1328 GLOBUS_GFS_LOG_ALL = 0xFF
1329 } globus_gfs_log_type_t;
1332 globus_gfs_log_message(
1333 globus_gfs_log_type_t type,
1334 const char * format,
1338 globus_gfs_log_result(
1339 globus_gfs_log_type_t type,
1346 GLOBUS_GFS_DEBUG_TRACE = 8,
1347 GLOBUS_GFS_DEBUG_INFO = 16,
1348 GLOBUS_GFS_DEBUG_STATE = 32
1352 #define GlobusGFSName(func) static const char * _gfs_name __attribute__((__unused__)) = #func 1354 #define GlobusGFSName(func) static const char * _gfs_name = #func 1357 GlobusDebugDeclare(GLOBUS_GRIDFTP_SERVER);
1359 #define GlobusGFSDebugPrintf(level, message) \ 1360 GlobusDebugPrintf(GLOBUS_GRIDFTP_SERVER, level, message) 1362 #define GlobusGFSDebugInfo(_msg) \ 1363 GlobusGFSDebugPrintf( \ 1364 GLOBUS_GFS_DEBUG_INFO, \ 1365 ("[%s] %s\n", __func__, _msg)) 1367 #define GlobusGFSDebugEnter() \ 1368 GlobusGFSDebugPrintf( \ 1369 GLOBUS_GFS_DEBUG_TRACE, \ 1370 ("[%s] Entering\n", __func__)) 1372 #define GlobusGFSDebugExit() \ 1373 GlobusGFSDebugPrintf( \ 1374 GLOBUS_GFS_DEBUG_TRACE, \ 1375 ("[%s] Exiting\n", __func__)) 1377 #define GlobusGFSDebugState(_state) \ 1378 GlobusGFSDebugPrintf( \ 1379 GLOBUS_GFS_DEBUG_INFO, \ 1380 ("[%s] State: %d\n", __func__, _state)) 1382 #define GlobusGFSDebugExitWithError() \ 1383 GlobusGFSDebugPrintf( \ 1384 GLOBUS_GFS_DEBUG_TRACE, \ 1385 ("[%s] Exiting with error\n", __func__)) 1387 #define GlobusGFSErrorParameter(mem_name) \ 1388 globus_error_put(GlobusGFSErrorObjParameter(mem_name)) 1390 #define GlobusGFSErrorIPC() \ 1391 globus_error_put(GlobusGFSErrorObjIPC()) 1393 #define GlobusGFSErrorObjIPC() \ 1394 globus_error_construct_error( \ 1397 GLOBUS_GFS_ERROR_MEMORY, \ 1401 "IPC Communication error.") 1403 #define GlobusGFSErrorObjParameter(param_name) \ 1404 globus_error_construct_error( \ 1407 GLOBUS_GFS_ERROR_PARAMETER, \ 1411 "invalid parameter: %s", \ 1414 #define GlobusGFSErrorSystemError(system_func, system_errno) \ 1415 globus_error_put(GlobusGFSErrorObjSystemError(\ 1416 (system_func), (system_errno))) 1417 #define GlobusGFSErrorObjSystemError(system_func, system_errno) \ 1418 globus_i_gfs_error_system( \ 1419 0, (system_errno), \ 1420 "System error%s%s", \ 1421 (system_func) != NULL ? " in " : "", \ 1422 (system_func) != NULL ? (system_func) : "") 1424 #define GlobusGFSErrorWrapFailed(failed_func, result) \ 1425 globus_error_put(GlobusGFSErrorObjWrapFailed(failed_func, result)) 1427 #define GlobusGFSErrorObjWrapFailed(failed_func, result) \ 1428 globus_error_construct_error( \ 1430 globus_error_get((result)), \ 1431 GLOBUS_GFS_ERROR_WRAPPED, \ 1438 #define GlobusGFSErrorData(reason) \ 1439 globus_error_put(GlobusGFSErrorObjData(reason)) 1441 #define GlobusGFSErrorObjData(reason) \ 1442 globus_error_construct_error( \ 1445 GLOBUS_GFS_ERROR_DATA, \ 1452 #define GlobusGFSErrorGeneric(reason) \ 1453 globus_error_put(GlobusGFSErrorObjGeneric(reason)) 1455 #define GlobusGFSErrorObjGeneric(reason) \ 1456 globus_error_construct_error( \ 1459 GLOBUS_GFS_ERROR_GENERIC, \ 1469 globus_object_t * base_cause,
1471 const char *response_error_code,
1477 globus_object_t * error,
1479 globus_object_t * base_cause,
1481 const char * response_error_code,
1486 globus_object_t * error,
1488 globus_object_t * base_cause,
1490 const char * response_error_code,
1496 globus_object_t * error);
1500 globus_object_t * error);
1504 globus_object_t * error,
1505 const char * response_error_code);
1507 extern const globus_object_type_t
1510 #define GLOBUS_GFS_ERROR_FTP_RESPONSE_TYPE \ 1511 (&GLOBUS_GFS_ERROR_FTP_RESPONSE_TYPE_DEFINITION) 1514 #define GlobusGFSErrorFtpResponse(cause, code, response_error_code, ...) \ 1515 globus_error_put(GlobusGFSErrorObjFtpResponse( \ 1516 cause, code, response_error_code, __VA_ARGS__)) 1518 #define GlobusGFSErrorObjFtpResponse(cause, code, response_error_code, ...) \ 1519 globus_gfs_ftp_response_error_construct( \ 1523 response_error_code, \ 1529 #define GlobusGFSErrorMemory(mem) \ 1530 globus_error_put(GlobusGFSErrorObjMemory(mem)) 1531 #define GlobusGFSErrorObjMemory(mem) \ 1532 GlobusGFSErrorObjSystemError("malloc", errno) 1534 #define GlobusGFSErrorObj(cause, response_code, ...) \ 1535 GlobusGFSErrorObjFtpResponse(cause, response_code, __VA_ARGS__) 1537 #define GlobusGFSErrorPathNotFound(p) \ 1538 globus_error_put(GlobusGFSErrorObjPathNotFound(NULL, p)) 1539 #define GlobusGFSErrorObjPathNotFound(cause, p) \ 1540 GlobusGFSErrorObj((cause), 550, "PATH_NOT_FOUND", \ 1542 ((p) != NULL) ? "GridFTP-Path: \"" : "", \ 1543 ((p) != NULL) ? (p) : "", \ 1544 ((p) != NULL) ? "\"" : "") 1546 #define GlobusGFSErrorIncorrectChecksum(computed, expected) \ 1547 globus_error_put(GlobusGFSErrorObjIncorrectChecksum( \ 1548 NULL, computed, expected)) 1549 #define GlobusGFSErrorObjIncorrectChecksum(cause, computed, expected) \ 1550 GlobusGFSErrorObj( \ 1553 "INCORRECT_CHECKSUM", \ 1554 "GridFTP-Computed-Checksum: %s\n" \ 1555 "GridFTP-Expected-Checksum: %s", (computed), (expected)) 1557 #define GlobusGFSErrorMultipartUploadNotFound() \ 1558 globus_error_put(GlobusGFSErrorObjMultipartUploadNotFound(NULL)) 1559 #define GlobusGFSErrorObjMultipartUploadNotFound(cause) \ 1560 GlobusGFSErrorObj(cause, 553, "MULTI_PART_UPLOAD_NOT_FOUND", NULL) 1562 #define GlobusGFSErrorAppendNotSupported() \ 1563 globus_error_put(GlobusGFSErrorObjAppendNotSupported(NULL)) 1564 #define GlobusGFSErrorObjAppendNotSupported(cause) \ 1565 GlobusGFSErrorObj((cause), 553, "APPEND_NOT_SUPPORTED", NULL) 1567 #define GlobusGFSErrorAmbiguousPath(ambiguity) \ 1568 globus_error_put(GlobusGFSErrorObjAmbiguousPath(NULL, ambiguity)) 1569 #define GlobusGFSErrorObjAmbiguousPath(cause, ambiguity) \ 1570 GlobusGFSErrorObj( \ 1574 "GridFTP-Path: %s", \ 1577 #define GlobusGFSErrorTooBusy() \ 1578 globus_error_put(GlobusGFSErrorObjTooBusy(NULL)) 1579 #define GlobusGFSErrorObjTooBusy(cause) \ 1580 GlobusGFSErrorObj((cause), 451, "TOO_BUSY", NULL) 1582 #define GlobusGFSErrorDataChannelAuthenticationFailure() \ 1583 globus_error_put(GlobusGFSErrorObjDataChannelAuthenticationFailure( \ 1585 #define GlobusGFSErrorObjDataChannelAuthenticationFailure(cause) \ 1586 GlobusGFSErrorObj((cause), 425, \ 1587 "DATA_CHANNEL_AUTHENTICATION_FAILURE", NULL) 1589 #define GlobusGFSErrorDataChannelCommunicationFailure() \ 1590 globus_error_put(GlobusGFSErrorObjDataChannelCommunicationFailure( \ 1592 #define GlobusGFSErrorObjDataChannelCommunicationFailure(cause) \ 1593 GlobusGFSErrorObj((cause), 425, \ 1594 "DATA_CHANNEL_COMMUNICATION_FAILURE", NULL) 1596 #define GlobusGFSErrorLoginDenied() \ 1597 globus_error_put(GlobusGFSErrorObjLoginDenied(NULL)) 1598 #define GlobusGFSErrorObjLoginDenied(cause) \ 1599 GlobusGFSErrorObj((cause), 530, "LOGIN_DENIED", NULL) 1601 #define GlobusGFSErrorPermissionDenied() \ 1602 globus_error_put(GlobusGFSErrorObjPermissionDenied(NULL)) 1603 #define GlobusGFSErrorObjPermissionDenied(cause) \ 1604 GlobusGFSErrorObj((cause), 550, "PERMISSION_DENIED", NULL) 1606 #define GlobusGFSErrorQuotaExceeded() \ 1607 globus_error_put(GlobusGFSErrorObjQuotaExceeded(NULL)) 1608 #define GlobusGFSErrorObjQuotaExceeded(cause) \ 1609 GlobusGFSErrorObj((cause), 451, "QUOTA_EXCEEDED", NULL) 1611 #define GlobusGFSErrorNoSpaceLeft() \ 1612 globus_error_put(GlobusGFSErrorObjNoSpaceLeft(NULL)) 1613 #define GlobusGFSErrorObjNoSpaceLeft(cause) \ 1614 GlobusGFSErrorObj((cause), 451, "NO_SPACE_LEFT", NULL) 1616 #define GlobusGFSErrorInvalidPathName(name) \ 1617 globus_error_put(GlobusGFSErrorObjInvalidPathName(NULL, name)) 1618 #define GlobusGFSErrorObjInvalidPathName(cause, name) \ 1619 GlobusGFSErrorObj((cause), 553, "INVALID_PATH_NAME", \ 1620 "GridFTP-Path: %s", name) 1622 #define GlobusGFSErrorPathExists(name) \ 1623 globus_error_put(GlobusGFSErrorObjPathExists(NULL, name)) 1624 #define GlobusGFSErrorObjPathExists(cause, name) \ 1625 GlobusGFSErrorObj((cause), 553, "PATH_EXISTS", \ 1626 "GridFTP-Path: %s", name) 1628 #define GlobusGFSErrorIsADirectory(name) \ 1629 globus_error_put(GlobusGFSErrorObjIsADirectory(NULL, name)) 1630 #define GlobusGFSErrorObjIsADirectory(cause, name) \ 1631 GlobusGFSErrorObj((cause), 553, "IS_A_DIRECTORY", \ 1632 "GridFTP-Path: %s", name) 1634 #define GlobusGFSErrorNotADirectory(name) \ 1635 globus_error_put(GlobusGFSErrorObjNotADirectory(NULL, name)) 1636 #define GlobusGFSErrorObjNotADirectory(cause, name) \ 1637 GlobusGFSErrorObj((cause), 553, "NOT_A_DIRECTORY", \ 1638 "GridFTP-Path: %s", name) 1640 #define GlobusGFSErrorCRLError() \ 1641 globus_error_put(GlobusGFSErrorObjCRLError(NULL)) 1642 #define GlobusGFSErrorObjCRLError(cause) \ 1643 GlobusGFSErrorObj((cause), 530, "CRL_ERROR", NULL) 1645 #define GlobusGFSErrorInternalError(generic_string) \ 1646 globus_error_put(GlobusGFSErrorObjInternalError( \ 1647 NULL, (generic_string))) 1648 #define GlobusGFSErrorObjInternalError(cause, generic_string) \ 1649 GlobusGFSErrorObj((cause), 500, "INTERNAL_ERROR", \ 1651 ((generic_string) != NULL) ? "GridFTP-Error: " : "", \ 1652 ((generic_string) != NULL) ? generic_string : "") 1654 #define GlobusGFSErrorNotImplemented() \ 1655 globus_error_put(GlobusGFSErrorObjNotImplemented(NULL)) 1656 #define GlobusGFSErrorObjNotImplemented(cause) \ 1657 GlobusGFSErrorObj((cause), 500, "NOT_IMPLEMETED", NULL) 1659 #define GlobusGFSErrorNotImplementedFeature(feature) \ 1660 globus_error_put(GlobusGFSErrorObjNotImplementedFeature(NULL, feature)) 1661 #define GlobusGFSErrorObjNotImplementedFeature(cause, feature) \ 1662 GlobusGFSErrorObj((cause), 500, \ 1663 "NOT_IMPLEMETED", "GridFTP-Feature: %s", (feature)) 1665 #define GlobusGFSErrorConfigurationError() \ 1666 globus_error_put(GlobusGFSErrorObjConfigurationError(NULL)) 1667 #define GlobusGFSErrorObjConfigurationError(cause) \ 1668 GlobusGFSErrorObj((cause), 500, "CONFIGURATION_ERROR", NULL) 1675 typedef struct globus_i_gfs_ipc_handle_s * globus_gfs_ipc_handle_t;
1700 (*globus_gfs_ipc_callback_t)(
1701 globus_gfs_ipc_handle_t ipc_handle,
1703 globus_gfs_finished_info_t * reply,
1707 (*globus_gfs_ipc_event_callback_t)(
1708 globus_gfs_ipc_handle_t ipc_handle,
1710 globus_gfs_event_info_t * reply,
1714 (*globus_gfs_ipc_close_callback_t)(
1715 globus_gfs_ipc_handle_t ipc_handle,
1720 (*globus_gfs_ipc_open_callback_t)(
1721 globus_gfs_ipc_handle_t ipc_handle,
1723 globus_gfs_finished_info_t * reply,
1727 (*globus_gfs_ipc_error_callback_t)(
1728 globus_gfs_ipc_handle_t ipc_handle,
1733 globus_gfs_ipc_reply_finished(
1734 globus_gfs_ipc_handle_t ipc_handle,
1735 globus_gfs_finished_info_t * reply);
1738 globus_gfs_ipc_reply_event(
1739 globus_gfs_ipc_handle_t ipc_handle,
1740 globus_gfs_event_info_t * reply);
1743 globus_gfs_ipc_reply_session(
1744 globus_gfs_ipc_handle_t ipc_handle,
1745 globus_gfs_finished_info_t * reply);
1759 (*globus_i_gfs_ipc_data_callback_t)(
1760 globus_gfs_finished_info_t * reply,
1764 (*globus_i_gfs_ipc_data_event_callback_t)(
1765 globus_gfs_event_info_t * reply,
1769 (*globus_i_gfs_ipc_done_callback_t)(
1780 (*globus_gfs_ipc_iface_session_start_t)(
1781 globus_gfs_ipc_handle_t ipc_handle,
1782 const gss_ctx_id_t context,
1783 globus_gfs_session_info_t * session_info,
1784 globus_i_gfs_ipc_data_callback_t cb,
1788 globus_gfs_ipc_start_session(
1789 globus_gfs_ipc_handle_t ipc_handle,
1790 globus_gfs_session_info_t * session_info,
1791 globus_gfs_ipc_callback_t cb,
1796 (*globus_gfs_ipc_iface_session_stop_t)(
1797 globus_gfs_ipc_handle_t ipc_handle,
1798 void * session_handle);
1801 globus_gfs_ipc_iface_session_stop(
1802 globus_gfs_ipc_handle_t ipc_handle,
1803 void * session_handle);
1806 (*globus_gfs_ipc_iface_set_cred_t)(
1807 globus_gfs_ipc_handle_t ipc_handle,
1808 void * session_handle,
1809 gss_cred_id_t del_cred);
1812 globus_gfs_ipc_set_cred(
1813 globus_gfs_ipc_handle_t ipc_handle,
1814 gss_cred_id_t del_cred);
1817 (*globus_gfs_ipc_iface_buffer_send_t)(
1818 globus_gfs_ipc_handle_t ipc_handle,
1819 void * session_handle,
1825 globus_gfs_ipc_request_buffer_send(
1826 globus_gfs_ipc_handle_t ipc_handle,
1837 (*globus_gfs_ipc_iface_recv_t)(
1838 globus_gfs_ipc_handle_t ipc_handle,
1839 void * session_handle,
1841 globus_gfs_transfer_info_t * recv_info,
1842 globus_i_gfs_ipc_data_callback_t cb,
1843 globus_i_gfs_ipc_data_event_callback_t event_cb,
1847 globus_gfs_ipc_request_recv(
1848 globus_gfs_ipc_handle_t ipc_handle,
1849 globus_gfs_transfer_info_t * recv_info,
1850 globus_gfs_ipc_callback_t cb,
1851 globus_gfs_ipc_event_callback_t event_cb,
1860 (*globus_gfs_ipc_iface_send_t)(
1861 globus_gfs_ipc_handle_t ipc_handle,
1862 void * session_handle,
1864 globus_gfs_transfer_info_t * send_info,
1865 globus_i_gfs_ipc_data_callback_t cb,
1866 globus_i_gfs_ipc_data_event_callback_t event_cb,
1870 globus_gfs_ipc_request_send(
1871 globus_gfs_ipc_handle_t ipc_handle,
1872 globus_gfs_transfer_info_t * send_info,
1873 globus_gfs_ipc_callback_t cb,
1874 globus_gfs_ipc_event_callback_t event_cb,
1878 (*globus_gfs_ipc_iface_list_t)(
1879 globus_gfs_ipc_handle_t ipc_handle,
1880 void * session_handle,
1882 globus_gfs_transfer_info_t * list_info,
1883 globus_i_gfs_ipc_data_callback_t cb,
1884 globus_i_gfs_ipc_data_event_callback_t event_cb,
1888 globus_gfs_ipc_request_list(
1889 globus_gfs_ipc_handle_t ipc_handle,
1890 globus_gfs_transfer_info_t * data_info,
1891 globus_gfs_ipc_callback_t cb,
1892 globus_gfs_ipc_event_callback_t event_cb,
1901 (*globus_gfs_ipc_iface_command_t)(
1902 globus_gfs_ipc_handle_t ipc_handle,
1903 void * session_handle,
1905 globus_gfs_command_info_t * cmd_info,
1906 globus_i_gfs_ipc_data_callback_t cb,
1910 globus_gfs_ipc_request_command(
1911 globus_gfs_ipc_handle_t ipc_handle,
1912 globus_gfs_command_info_t * cmd_info,
1913 globus_gfs_ipc_callback_t cb,
1922 (*globus_gfs_ipc_iface_active_data_t)(
1923 globus_gfs_ipc_handle_t ipc_handle,
1924 void * session_handle,
1926 globus_gfs_data_info_t * data_info,
1927 globus_i_gfs_ipc_data_callback_t cb,
1931 globus_gfs_ipc_request_active_data(
1932 globus_gfs_ipc_handle_t ipc_handle,
1933 globus_gfs_data_info_t * data_info,
1934 globus_gfs_ipc_callback_t cb,
1943 (*globus_gfs_ipc_iface_passive_data_t)(
1944 globus_gfs_ipc_handle_t ipc_handle,
1945 void * session_handle,
1947 globus_gfs_data_info_t * data_info,
1948 globus_i_gfs_ipc_data_callback_t cb,
1952 globus_gfs_ipc_request_passive_data(
1953 globus_gfs_ipc_handle_t ipc_handle,
1954 globus_gfs_data_info_t * data_info,
1955 globus_gfs_ipc_callback_t cb,
1962 (*globus_gfs_ipc_iface_stat_t)(
1963 globus_gfs_ipc_handle_t ipc_handle,
1964 void * session_handle,
1966 globus_gfs_stat_info_t * stat_info,
1967 globus_i_gfs_ipc_data_callback_t cb,
1971 globus_gfs_ipc_request_stat(
1972 globus_gfs_ipc_handle_t ipc_handle,
1973 globus_gfs_stat_info_t * stat_info,
1974 globus_gfs_ipc_callback_t cb,
1981 (*globus_gfs_ipc_iface_transfer_event_t)(
1982 globus_gfs_ipc_handle_t ipc_handle,
1983 void * session_handle,
1984 globus_gfs_event_info_t * event_info);
1988 globus_gfs_ipc_request_transfer_event(
1989 globus_gfs_ipc_handle_t ipc_handle,
1990 globus_gfs_event_info_t * event_info);
1997 (*globus_gfs_ipc_iface_data_destroy_t)(
1998 globus_gfs_ipc_handle_t ipc_handle,
1999 void * session_handle,
2003 globus_gfs_ipc_request_data_destroy(
2004 globus_gfs_ipc_handle_t ipc_handle,
2007 typedef struct globus_i_gfs_ipc_iface_s
2009 globus_gfs_ipc_iface_session_start_t session_start_func;
2010 globus_gfs_ipc_iface_session_stop_t session_stop_func;
2011 globus_gfs_ipc_iface_recv_t recv_func;
2012 globus_gfs_ipc_iface_send_t send_func;
2013 globus_gfs_ipc_iface_command_t command_func;
2014 globus_gfs_ipc_iface_active_data_t active_func;
2015 globus_gfs_ipc_iface_passive_data_t passive_func;
2016 globus_gfs_ipc_iface_data_destroy_t data_destroy_func;
2017 globus_gfs_ipc_iface_stat_t stat_func;
2018 globus_gfs_ipc_iface_list_t list_func;
2019 globus_gfs_ipc_iface_transfer_event_t transfer_event_func;
2020 globus_gfs_ipc_iface_set_cred_t set_cred;
2021 globus_gfs_ipc_iface_buffer_send_t buffer_send;
2022 } globus_gfs_ipc_iface_t;
2033 globus_gfs_ipc_handle_create(
2034 globus_gfs_ipc_iface_t * iface,
2035 globus_xio_system_socket_t system_handle,
2036 globus_i_gfs_ipc_done_callback_t done_cb,
2043 globus_gfs_ipc_close(
2044 globus_gfs_ipc_handle_t ipc_handle,
2045 globus_gfs_ipc_close_callback_t cb,
2049 globus_gfs_ipc_reply_close(
2050 globus_gfs_ipc_handle_t ipc_handle);
2053 globus_gfs_ipc_session_stop(
2054 globus_gfs_ipc_handle_t ipc_handle);
2057 globus_gfs_ipc_handle_connect(
2058 globus_gfs_session_info_t * session_info,
2059 globus_gfs_ipc_open_callback_t cb,
2061 globus_gfs_ipc_error_callback_t error_cb,
2062 void * error_user_arg);
2065 globus_gfs_ipc_handle_connect_ex(
2066 globus_gfs_session_info_t * session_info,
2067 globus_gfs_ipc_open_callback_t cb,
2069 globus_gfs_ipc_error_callback_t error_cb,
2070 void * error_user_arg,
2073 const char *auth_mode,
2074 const char *subject,
2075 time_t connect_timeout,
2076 time_t idle_timeout,
2080 globus_gfs_ipc_handle_obtain(
2081 globus_gfs_session_info_t * session_info,
2082 globus_gfs_ipc_iface_t * iface,
2083 globus_gfs_ipc_open_callback_t cb,
2085 globus_gfs_ipc_error_callback_t error_cb,
2086 void * error_user_arg);
2091 #define BRAIN_SYMBOL_NAME (void*)"gridftp_brain" 2092 extern globus_extension_registry_t brain_i_registry;
2095 (*globus_i_gfs_brain_select_nodes_func_t)(
2096 globus_i_gfs_brain_node_t *** out_node_array,
2097 int * out_array_length,
2098 const char * repo_name,
2099 globus_off_t filesize,
2104 (*globus_i_gfs_brain_release_node_func_t)(
2105 globus_i_gfs_brain_node_t * contact_node,
2106 globus_gfs_brain_reason_t reason);
2109 (*globus_i_gfs_brain_init_func_t)();
2112 (*globus_i_gfs_brain_stop_func_t)();
2115 (*globus_i_gfs_brain_get_available_func_t)(
2116 const char * user_id,
2117 const char * repo_name,
2121 typedef struct globus_i_gfs_brain_module_s
2123 globus_i_gfs_brain_init_func_t init_func;
2124 globus_i_gfs_brain_stop_func_t stop_func;
2125 globus_i_gfs_brain_select_nodes_func_t select_func;
2126 globus_i_gfs_brain_release_node_func_t release_func;
2127 globus_i_gfs_brain_get_available_func_t available_func;
2128 } globus_i_gfs_brain_module_t;
2130 extern globus_i_gfs_brain_module_t globus_i_gfs_default_brain;
2133 globus_gfs_brain_select_nodes(
2134 globus_i_gfs_brain_node_t *** out_node_array,
2135 int * out_array_length,
2136 const char * repo_name,
2137 globus_off_t filesize,
2142 globus_gfs_brain_release_node(
2143 globus_i_gfs_brain_node_t * contact_node,
2144 globus_gfs_brain_reason_t reason);
2147 globus_gfs_brain_get_available(
2148 const char * user_id,
2149 const char * repo_name,
2153 globus_gfs_ipc_handle_get_contact_string(
2154 globus_gfs_ipc_handle_t ipc_handle,
2155 char ** contact_string);
2158 globus_gfs_ipc_init(
2165 globus_gfs_ipc_add_server(
2166 globus_xio_server_t server_handle);
2168 extern globus_gfs_ipc_iface_t globus_gfs_ipc_default_iface;
2181 typedef struct globus_i_gfs_acl_handle_s * globus_gfs_acl_handle_t;
2186 typedef enum globus_gfs_acl_action_e
2189 GFS_ACL_ACTION_INIT = 1,
2191 GFS_ACL_ACTION_DELETE,
2193 GFS_ACL_ACTION_WRITE,
2195 GFS_ACL_ACTION_CREATE,
2197 GFS_ACL_ACTION_READ,
2199 GFS_ACL_ACTION_LOOKUP,
2203 GFS_ACL_ACTION_AUTHZ_ASSERT,
2206 GFS_ACL_ACTION_COMMIT,
2209 } globus_gfs_acl_action_t;
2213 typedef struct globus_gfs_acl_info_s
2220 gss_ctx_id_t context;
2221 } globus_gfs_acl_info_t;
2225 typedef struct globus_gfs_acl_object_desc_s
2246 globus_gfs_op_info_t op_info;
2247 } globus_gfs_acl_object_desc_t;
2250 typedef enum globus_gfs_acl_status_e
2253 GLOBUS_GFS_ACL_COMPLETE = 1,
2256 GLOBUS_GFS_ACL_WOULD_BLOCK
2257 } globus_gfs_acl_status_t;
2274 (*globus_gfs_acl_init_t)(
2276 globus_gfs_acl_info_t * acl_info,
2277 globus_gfs_acl_handle_t acl_handle,
2290 (*globus_gfs_acl_authorize_t)(
2292 globus_gfs_acl_action_t action,
2293 globus_gfs_acl_object_desc_t * object,
2294 globus_gfs_acl_info_t * acl_info,
2295 globus_gfs_acl_handle_t acl_handle,
2300 (*globus_gfs_acl_destroy_t)(
2306 (*globus_gfs_acl_audit_t)(
2308 globus_gfs_acl_action_t action,
2309 globus_gfs_acl_object_desc_t * object,
2310 const char * message);
2314 typedef struct globus_gfs_acl_module_s
2316 globus_gfs_acl_init_t init_func;
2317 globus_gfs_acl_authorize_t authorize_func;
2318 globus_gfs_acl_destroy_t destroy_func;
2319 globus_gfs_acl_audit_t audit_func;
2320 } globus_gfs_acl_module_t;
2326 globus_gfs_acl_authorized_finished(
2327 globus_gfs_acl_handle_t acl_handle,
2333 globus_gfs_acl_action_to_string(
2334 globus_gfs_acl_action_t action);
2343 (*globus_i_gfs_config_set_string_cb_t)(
2344 const char * option_name,
2350 (*globus_i_gfs_config_set_int_cb_t)(
2351 const char * option_name,
2360 } globus_i_gfs_config_option_cb_ent_t;
2363 globus_gfs_config_enable_cb(
2364 globus_i_gfs_config_option_cb_ent_t * cb_handle,
2368 globus_gfs_config_add_cb(
2369 globus_i_gfs_config_option_cb_ent_t ** cb_handle,
2375 globus_gfs_config_get_bool(
2376 const char * option_name);
2379 globus_gfs_config_get_string(
2380 const char * option_name);
2383 globus_gfs_config_get_list(
2384 const char * option_name);
2387 globus_gfs_config_get(
2388 const char * option_name);
2391 globus_gfs_config_get_int(
2392 const char * option_name);
2395 globus_gfs_config_set_int(
2400 globus_gfs_config_set_bool(
2405 globus_gfs_config_set_ptr(
2410 globus_gfs_config_inc_int(
Definition: globus_gridftp_server.h:195
globus_bool_t globus_gfs_error_match_response_error_code(globus_object_t *error, const char *response_error_code)
Definition: globus_i_gfs_ftp_response_error.c:326
Definition: globus_gridftp_server.h:201
Definition: globus_gridftp_server.h:166
void globus_gridftp_server_operation_finished(globus_gfs_operation_t op, globus_result_t result, globus_gfs_finished_info_t *finished_info)
Definition: globus_i_gfs_data.c:12874
Definition: globus_gridftp_server.h:169
int globus_bool_t
Boolean type.
Definition: globus_types.h:93
globus_object_t * globus_gfs_ftp_response_error_construct(globus_module_descriptor_t *base_source, globus_object_t *base_cause, int response_code, const char *response_error_code, const char *fmt,...)
Definition: globus_i_gfs_ftp_response_error.c:67
Definition: globus_gridftp_server.h:192
globus_object_t * globus_gfs_ftp_response_error_v_initialize(globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t *base_cause, int response_code, const char *response_error_code, const char *fmt, va_list ap)
Definition: globus_i_gfs_ftp_response_error.c:185
globus_gfs_op_info_param_t
Definition: globus_gridftp_server.h:1054
Definition: globus_gridftp_server.h:187
List data type.
Definition: globus_list.h:43
void(* globus_gridftp_server_write_cb_t)(globus_gfs_operation_t op, globus_result_t result, globus_byte_t *buffer, globus_size_t nbytes, void *user_arg)
Definition: globus_gridftp_server.h:960
Definition: globus_gridftp_server_control.h:205
Definition: globus_gridftp_server.h:173
void(* globus_gfs_storage_init_t)(globus_gfs_operation_t op, globus_gfs_session_info_t *session_info)
Definition: globus_gridftp_server.h:642
size_t globus_size_t
Standard size of memory objectThe globus_size_t is the size of a memory object. It is identical to si...
Definition: globus_types.h:48
globus_gfs_event_type_e
Event types.
Definition: globus_gridftp_server.h:162
enum globus_gfs_event_type_e globus_gfs_event_type_t
Event types.
unsigned char globus_byte_t
Unsigned byte datatypeThis is used for byte-addressable arrays of arbitrary data which is not subject...
Definition: globus_types.h:85
Definition: globus_gridftp_server.h:182
Headers common to all of Globus.
globus_object_t * globus_gfs_ftp_response_error_initialize(globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t *base_cause, int response_code, const char *response_error_code, const char *fmt,...)
Definition: globus_i_gfs_ftp_response_error.c:132
uint32_t globus_result_t
Definition: globus_types.h:99
Definition: globus_gridftp_server.h:198
globus_object_t * globus_i_gfs_error_system(int ftp_code, int system_errno, const char *fmt,...)
Definition: globus_i_gfs_ftp_response_error.c:473
int globus_gfs_error_get_ftp_response_code(globus_object_t *error)
Definition: globus_i_gfs_ftp_response_error.c:261
Definition: globus_gridftp_server.h:177
const char * globus_gfs_error_get_ftp_response_error_code(globus_object_t *error)
Definition: globus_i_gfs_ftp_response_error.c:293
const globus_object_type_t GLOBUS_GFS_ERROR_FTP_RESPONSE_TYPE_DEFINITION
Definition: globus_i_gfs_ftp_response_error.c:618
Module Descriptor.
Definition: globus_module.h:69