19 #ifndef GLOBUS_GRIDFTP_SERVER_H
20 #define GLOBUS_GRIDFTP_SERVER_H
23 #include "globus_gridftp_server_control.h"
25 #ifdef TARGET_ARCH_WIN32
31 #ifndef TARGET_ARCH_WIN32
35 #define GLOBUS_MAPPING_STRING ":globus-mapping:"
38 #define GLOBUS_GRIDFTP_SERVER_MODULE (&globus_i_gfs_module)
40 extern globus_extension_registry_t globus_i_gfs_dsi_registry;
41 #define GLOBUS_GFS_DSI_REGISTRY &globus_i_gfs_dsi_registry
43 extern globus_extension_registry_t globus_i_gfs_acl_registry;
44 #define GLOBUS_GFS_ACL_REGISTRY &globus_i_gfs_acl_registry
50 typedef enum globus_gfs_error_type_e
52 GLOBUS_GFS_ERROR_MEMORY = 1,
53 GLOBUS_GFS_ERROR_PARAMETER,
54 GLOBUS_GFS_ERROR_SYSTEM_ERROR,
55 GLOBUS_GFS_ERROR_WRAPPED,
56 GLOBUS_GFS_ERROR_DATA,
57 GLOBUS_GFS_ERROR_GENERIC
58 } globus_gfs_error_type_t;
65 typedef enum globus_gfs_operation_type_e
67 GLOBUS_GFS_OP_FINAL_REPLY = 1,
68 GLOBUS_GFS_OP_EVENT_REPLY,
70 GLOBUS_GFS_OP_SESSION_START,
71 GLOBUS_GFS_OP_SESSION_STOP,
75 GLOBUS_GFS_OP_COMMAND,
76 GLOBUS_GFS_OP_PASSIVE,
78 GLOBUS_GFS_OP_DESTROY,
79 GLOBUS_GFS_OP_TRANSFER,
81 GLOBUS_GFS_OP_BUFFER_SEND,
82 GLOBUS_GFS_OP_HANDSHAKE,
83 GLOBUS_GFS_OP_SESSION_START_REPLY,
84 GLOBUS_GFS_OP_INTERMEDIATE_REPLY
85 } globus_gfs_operation_type_t;
87 #define GLOBUS_GFS_OP_STAT_PARTIAL GLOBUS_GFS_OP_INTERMEDIATE_REPLY
95 typedef enum globus_gfs_command_type_e
97 GLOBUS_GFS_CMD_MKD = 1,
100 GLOBUS_GFS_CMD_SITE_AUTHZ_ASSERT,
101 GLOBUS_GFS_CMD_SITE_RDEL,
105 GLOBUS_GFS_CMD_SITE_CHMOD,
106 GLOBUS_GFS_CMD_SITE_DSI,
107 GLOBUS_GFS_CMD_SITE_SETNETSTACK,
108 GLOBUS_GFS_CMD_SITE_SETDISKSTACK,
109 GLOBUS_GFS_CMD_SITE_CLIENTINFO,
111 GLOBUS_GFS_CMD_SITE_CHGRP,
112 GLOBUS_GFS_CMD_SITE_UTIME,
113 GLOBUS_GFS_CMD_SITE_SYMLINKFROM,
114 GLOBUS_GFS_CMD_SITE_SYMLINK,
115 GLOBUS_GFS_CMD_HTTP_PUT,
116 GLOBUS_GFS_CMD_HTTP_GET,
117 GLOBUS_GFS_CMD_HTTP_CONFIG,
119 GLOBUS_GFS_CMD_SITE_TASKID,
122 GLOBUS_GFS_CMD_SITE_RESTRICT = 3072,
123 GLOBUS_GFS_CMD_SITE_CHROOT,
124 GLOBUS_GFS_CMD_SITE_SHARING,
127 GLOBUS_GFS_CMD_STORATTR,
128 GLOBUS_GFS_CMD_WHOAMI,
130 GLOBUS_GFS_MIN_CUSTOM_CMD = 4096
131 } globus_gfs_command_type_t;
198 typedef enum globus_gfs_buffer_type_e
200 GLOBUS_GFS_BUFFER_EOF_INFO = 0x0001,
201 GLOBUS_GFS_BUFFER_SERVER_DEFINED = 0xFFFF
203 } globus_gfs_buffer_type_t;
210 typedef enum globus_gfs_layout_type_e
212 GLOBUS_GFS_LAYOUT_PARTITIONED = 1,
213 GLOBUS_GFS_LAYOUT_BLOCKED
214 } globus_gfs_layout_type_t;
249 typedef struct globus_i_gfs_op_info_s * globus_gfs_op_info_t;
257 typedef struct globus_gfs_data_finished_info_s
268 const char ** contact_strings;
269 } globus_gfs_data_finished_info_t;
276 typedef struct globus_gfs_cmd_finshed_info_s
279 globus_gfs_command_type_t command;
284 } globus_gfs_cmd_finshed_info_t;
291 typedef struct globus_gfs_stat_finished_info_s
303 } globus_gfs_stat_finished_info_t;
310 typedef struct globus_gfs_session_finished_info_s
318 } globus_gfs_session_finished_info_t;
325 typedef struct globus_gfs_transfer_finished_info_s
328 globus_off_t bytes_transferred;
330 } globus_gfs_transfer_finished_info_t;
337 typedef struct globus_gfs_finished_info_s
340 globus_gfs_operation_type_t type;
353 globus_gfs_session_finished_info_t session;
354 globus_gfs_data_finished_info_t data;
355 globus_gfs_cmd_finshed_info_t command;
356 globus_gfs_stat_finished_info_t stat;
357 globus_gfs_transfer_finished_info_t transfer;
361 globus_gfs_op_info_t op_info;
362 } globus_gfs_finished_info_t;
369 typedef struct globus_gfs_event_info_s
386 globus_off_t recvd_bytes;
388 globus_range_list_t recvd_ranges;
399 globus_gfs_op_info_t op_info;
400 } globus_gfs_event_info_t;
407 typedef struct globus_gfs_transfer_info_s
418 globus_off_t partial_offset;
420 globus_off_t partial_length;
422 globus_range_list_t range_list;
438 globus_off_t alloc_size;
441 char * expected_checksum;
443 char * expected_checksum_alg;
448 int traversal_options;
451 globus_gfs_op_info_t op_info;
452 } globus_gfs_transfer_info_t;
458 #define rnfr_pathname from_pathname
465 typedef struct globus_gfs_command_info_s
468 globus_gfs_command_type_t command;
473 globus_off_t cksm_offset;
475 globus_off_t cksm_length;
484 char * from_pathname;
496 globus_gfs_op_info_t op_info;
497 } globus_gfs_command_info_t;
504 typedef struct globus_gfs_data_info_s
537 const char ** contact_strings;
543 gss_cred_id_t del_cred;
546 globus_gfs_op_info_t op_info;
547 } globus_gfs_data_info_t;
554 typedef struct globus_gfs_stat_info_s
568 globus_gfs_op_info_t op_info;
569 } globus_gfs_stat_info_t;
571 typedef struct globus_gfs_session_info_s
573 gss_cred_id_t del_cred;
583 globus_gfs_op_info_t op_info;
584 } globus_gfs_session_info_t;
586 typedef enum globus_gfs_brain_reason_e
588 GLOBUS_GFS_BRAIN_REASON_ERROR = 1,
589 GLOBUS_GFS_BRAIN_REASON_COMPLETE
590 } globus_gfs_brain_reason_t;
592 typedef struct globus_i_gfs_brain_node_s
598 int current_connection;
600 } globus_i_gfs_brain_node_t;
615 typedef struct globus_l_gfs_data_operation_s * globus_gfs_operation_t;
633 globus_gfs_operation_t op,
634 globus_gfs_session_info_t * session_info);
641 (*globus_gfs_storage_destroy_t)(
650 (*globus_gfs_storage_transfer_t)(
651 globus_gfs_operation_t op,
652 globus_gfs_transfer_info_t * transfer_info,
662 (*globus_gfs_storage_command_t)(
663 globus_gfs_operation_t op,
664 globus_gfs_command_info_t * command_info,
673 (*globus_gfs_storage_stat_t)(
674 globus_gfs_operation_t op,
675 globus_gfs_stat_info_t * stat_info,
685 (*globus_gfs_storage_data_t)(
686 globus_gfs_operation_t op,
687 globus_gfs_data_info_t * data_info,
698 (*globus_gfs_storage_data_destroy_t)(
710 (*globus_gfs_storage_trev_t)(
711 globus_gfs_event_info_t * event_info,
721 (*globus_gfs_storage_set_cred_t)(
722 gss_cred_id_t del_cred,
732 (*globus_gfs_storage_buffer_send_t)(
749 (*globus_gfs_storage_realpath_t)(
750 const char * in_path,
751 char ** out_realpath,
755 #define GLOBUS_GFS_DSI_DESCRIPTOR_SENDER (1 << 0)
756 #define GLOBUS_GFS_DSI_DESCRIPTOR_BLOCKING (1 << 1)
757 #define GLOBUS_GFS_DSI_DESCRIPTOR_HAS_REALPATH (1 << 2)
758 #define GLOBUS_GFS_DSI_DESCRIPTOR_REQUIRES_ORDERED_DATA (1 << 3)
759 #define GLOBUS_GFS_DSI_DESCRIPTOR_SETS_ERROR_RESPONSES (1 << 4)
760 #define GLOBUS_GFS_DSI_DESCRIPTOR_SAFE_RDEL (1 << 5)
761 #define GLOBUS_GFS_DSI_DESCRIPTOR_USERNAME_INCLUDES_DOMAIN (1 << 6)
770 typedef struct globus_gfs_storage_iface_s
776 globus_gfs_storage_destroy_t destroy_func;
779 globus_gfs_storage_transfer_t list_func;
780 globus_gfs_storage_transfer_t send_func;
781 globus_gfs_storage_transfer_t recv_func;
782 globus_gfs_storage_trev_t trev_func;
785 globus_gfs_storage_data_t active_func;
786 globus_gfs_storage_data_t passive_func;
787 globus_gfs_storage_data_destroy_t data_destroy_func;
789 globus_gfs_storage_command_t command_func;
790 globus_gfs_storage_stat_t stat_func;
792 globus_gfs_storage_set_cred_t set_cred_func;
793 globus_gfs_storage_buffer_send_t buffer_send_func;
794 globus_gfs_storage_realpath_t realpath_func;
795 } globus_gfs_storage_iface_t;
811 globus_gfs_operation_t op,
813 globus_gfs_finished_info_t * finished_info);
823 globus_gridftp_server_operation_event(
824 globus_gfs_operation_t op,
826 globus_gfs_event_info_t * event_info);
834 globus_gridftp_server_begin_transfer(
835 globus_gfs_operation_t op,
845 globus_gridftp_server_finished_transfer(
846 globus_gfs_operation_t op,
856 globus_gridftp_server_finished_session_start(
857 globus_gfs_operation_t op,
871 globus_gridftp_server_finished_command(
872 globus_gfs_operation_t op,
874 char * command_response);
876 globus_gridftp_server_intermediate_command(
877 globus_gfs_operation_t op,
879 char * command_response);
887 globus_gridftp_server_finished_stat(
888 globus_gfs_operation_t op,
894 globus_gridftp_server_finished_stat_partial(
895 globus_gfs_operation_t op,
901 globus_gridftp_server_finished_stat_custom_list(
902 globus_gfs_operation_t op,
914 globus_gridftp_server_finished_active_data(
915 globus_gfs_operation_t op,
926 globus_gridftp_server_finished_passive_data(
927 globus_gfs_operation_t op,
931 const char ** contact_strings,
951 globus_gfs_operation_t op,
958 globus_gridftp_server_register_write(
959 globus_gfs_operation_t op,
977 (*globus_gridftp_server_read_cb_t)(
978 globus_gfs_operation_t op,
987 globus_gridftp_server_register_read(
988 globus_gfs_operation_t op,
991 globus_gridftp_server_read_cb_t callback,
1030 globus_gridftp_server_add_command(
1031 globus_gfs_operation_t op,
1032 const char * command_name,
1036 const char * help_string,
1056 globus_gfs_operation_t op,
1057 const char * cksm_str);
1071 GLOBUS_GFS_OP_INFO_CMD_ARGS = 1
1081 globus_gridftp_server_query_op_info(
1082 globus_gfs_operation_t op,
1083 globus_gfs_op_info_t op_info,
1098 globus_gridftp_server_get_recv_attr_string(
1099 globus_gfs_operation_t op,
1100 const char * requested_attr,
1110 globus_gridftp_server_get_recv_modification_time(
1111 globus_gfs_operation_t op,
1125 globus_gridftp_server_update_bytes_written(
1126 globus_gfs_operation_t op,
1127 globus_off_t offset,
1128 globus_off_t length);
1141 globus_gridftp_server_update_bytes_recvd(
1142 globus_gfs_operation_t op,
1143 globus_off_t length);
1156 globus_gridftp_server_update_range_recvd(
1157 globus_gfs_operation_t op,
1158 globus_off_t offset,
1159 globus_off_t length);
1168 globus_gridftp_server_get_optimal_concurrency(
1169 globus_gfs_operation_t op,
1180 globus_gridftp_server_get_block_size(
1181 globus_gfs_operation_t op,
1191 globus_gridftp_server_get_stripe_block_size(
1192 globus_gfs_operation_t op,
1203 globus_gridftp_server_get_session_username(
1204 globus_gfs_operation_t op,
1216 globus_gridftp_server_get_delegated_cred(
1217 globus_gfs_operation_t op,
1218 gss_cred_id_t * del_cred);
1232 globus_gridftp_server_get_sec_context(
1233 globus_gfs_operation_t op,
1234 gss_ctx_id_t * context);
1253 globus_gridftp_server_set_ordered_data(
1254 globus_gfs_operation_t op,
1258 globus_gridftp_server_get_ordered_data(
1259 globus_gfs_operation_t op,
1269 globus_gridftp_server_get_config_string(
1270 globus_gfs_operation_t op,
1271 char ** config_string);
1280 globus_gridftp_server_get_config_data(
1281 globus_gfs_operation_t op,
1283 char ** config_data);
1286 globus_gfs_data_get_file_stack_list(
1287 globus_gfs_operation_t in_op,
1291 globus_gridftp_server_get_update_interval(
1292 globus_gfs_operation_t op,
1304 globus_gridftp_server_get_read_range(
1305 globus_gfs_operation_t op,
1306 globus_off_t * offset,
1307 globus_off_t * length);
1320 globus_gridftp_server_get_write_range(
1321 globus_gfs_operation_t op,
1322 globus_off_t * offset,
1323 globus_off_t * length);
1330 GLOBUS_GFS_LOG_ERR = 0x01,
1331 GLOBUS_GFS_LOG_WARN = 0x02,
1332 GLOBUS_GFS_LOG_TRANSFER = 0x04,
1333 GLOBUS_GFS_LOG_INFO = 0x08,
1334 GLOBUS_GFS_LOG_DUMP = 0x10,
1335 GLOBUS_GFS_LOG_ALL = 0xFF,
1336 GLOBUS_GFS_LOG_AUDIT = 0x100
1337 } globus_gfs_log_type_t;
1340 globus_gfs_log_message(
1341 globus_gfs_log_type_t type,
1342 const char * format,
1346 globus_gfs_log_result(
1347 globus_gfs_log_type_t type,
1354 GLOBUS_GFS_DEBUG_TRACE = 8,
1355 GLOBUS_GFS_DEBUG_INFO = 16,
1356 GLOBUS_GFS_DEBUG_STATE = 32
1360 #define GlobusGFSName(func) static const char * _gfs_name __attribute__((__unused__)) = #func
1362 #define GlobusGFSName(func) static const char * _gfs_name = #func
1365 GlobusDebugDeclare(GLOBUS_GRIDFTP_SERVER);
1367 #define GlobusGFSDebugPrintf(level, message) \
1368 GlobusDebugPrintf(GLOBUS_GRIDFTP_SERVER, level, message)
1370 #define GlobusGFSDebugInfo(_msg) \
1371 GlobusGFSDebugPrintf( \
1372 GLOBUS_GFS_DEBUG_INFO, \
1373 ("[%s] %s\n", __func__, _msg))
1375 #define GlobusGFSDebugEnter() \
1376 GlobusGFSDebugPrintf( \
1377 GLOBUS_GFS_DEBUG_TRACE, \
1378 ("[%s] Entering\n", __func__))
1380 #define GlobusGFSDebugExitResult(res) \
1381 GlobusGFSDebugPrintf( \
1382 GLOBUS_GFS_DEBUG_TRACE, \
1383 ("[%s] Exiting%s\n", \
1385 (res != GLOBUS_SUCCESS) ? " with error" : ""))
1387 #define GlobusGFSDebugExit() \
1388 GlobusGFSDebugPrintf( \
1389 GLOBUS_GFS_DEBUG_TRACE, \
1390 ("[%s] Exiting\n", __func__))
1392 #define GlobusGFSDebugState(_state) \
1393 GlobusGFSDebugPrintf( \
1394 GLOBUS_GFS_DEBUG_INFO, \
1395 ("[%s] State: %d\n", __func__, _state))
1397 #define GlobusGFSDebugExitWithError() \
1398 GlobusGFSDebugPrintf( \
1399 GLOBUS_GFS_DEBUG_TRACE, \
1400 ("[%s] Exiting with error\n", __func__))
1402 #define GlobusGFSErrorParameter(mem_name) \
1403 globus_error_put(GlobusGFSErrorObjParameter(mem_name))
1405 #define GlobusGFSErrorIPC() \
1406 globus_error_put(GlobusGFSErrorObjIPC())
1408 #define GlobusGFSErrorObjIPC() \
1409 globus_error_construct_error( \
1412 GLOBUS_GFS_ERROR_MEMORY, \
1416 "IPC Communication error.")
1418 #define GlobusGFSErrorObjParameter(param_name) \
1419 globus_error_construct_error( \
1422 GLOBUS_GFS_ERROR_PARAMETER, \
1426 "invalid parameter: %s", \
1429 #define GlobusGFSErrorSystemError(system_func, system_errno) \
1430 globus_error_put(GlobusGFSErrorObjSystemError(\
1431 (system_func), (system_errno)))
1432 #define GlobusGFSErrorObjSystemError(system_func, system_errno) \
1433 globus_i_gfs_error_system( \
1434 0, (system_errno), \
1435 "System error%s%s", \
1436 (system_func) != NULL ? " in " : "", \
1437 (system_func) != NULL ? (system_func) : "")
1439 #define GlobusGFSErrorWrapFailed(failed_func, result) \
1440 globus_error_put(GlobusGFSErrorObjWrapFailed(failed_func, result))
1442 #define GlobusGFSErrorObjWrapFailed(failed_func, result) \
1443 globus_error_construct_error( \
1445 globus_error_get((result)), \
1446 GLOBUS_GFS_ERROR_WRAPPED, \
1453 #define GlobusGFSErrorData(reason) \
1454 globus_error_put(GlobusGFSErrorObjData(reason))
1456 #define GlobusGFSErrorObjData(reason) \
1457 globus_error_construct_error( \
1460 GLOBUS_GFS_ERROR_DATA, \
1467 #define GlobusGFSErrorGeneric(reason) \
1468 globus_error_put(GlobusGFSErrorObjGeneric(reason))
1470 #define GlobusGFSErrorObjGeneric(reason) \
1471 globus_error_construct_error( \
1474 GLOBUS_GFS_ERROR_GENERIC, \
1484 globus_object_t * base_cause,
1486 const char *response_error_code,
1492 globus_object_t * error,
1494 globus_object_t * base_cause,
1496 const char * response_error_code,
1501 globus_object_t * error,
1503 globus_object_t * base_cause,
1505 const char * response_error_code,
1511 globus_object_t * error);
1515 globus_object_t * error);
1519 globus_object_t * error,
1520 const char * response_error_code);
1522 extern const globus_object_type_t
1525 #define GLOBUS_GFS_ERROR_FTP_RESPONSE_TYPE \
1526 (&GLOBUS_GFS_ERROR_FTP_RESPONSE_TYPE_DEFINITION)
1529 #define GlobusGFSErrorFtpResponse(cause, code, response_error_code, ...) \
1530 globus_error_put(GlobusGFSErrorObjFtpResponse( \
1531 cause, code, response_error_code, __VA_ARGS__))
1533 #define GlobusGFSErrorObjFtpResponse(cause, code, response_error_code, ...) \
1534 globus_gfs_ftp_response_error_construct( \
1538 response_error_code, \
1544 #define GlobusGFSErrorMemory(mem) \
1545 globus_error_put(GlobusGFSErrorObjMemory(mem))
1546 #define GlobusGFSErrorObjMemory(mem) \
1547 GlobusGFSErrorObjSystemError("malloc", errno)
1549 #define GlobusGFSErrorObj(cause, response_code, ...) \
1550 GlobusGFSErrorObjFtpResponse(cause, response_code, __VA_ARGS__)
1552 #define GlobusGFSErrorPathNotFound(p) \
1553 globus_error_put(GlobusGFSErrorObjPathNotFound(NULL, p))
1554 #define GlobusGFSErrorObjPathNotFound(cause, p) \
1555 GlobusGFSErrorObj((cause), 550, "PATH_NOT_FOUND", \
1557 ((p) != NULL) ? "GridFTP-Path: \"" : "", \
1558 ((p) != NULL) ? (p) : "", \
1559 ((p) != NULL) ? "\"" : "")
1561 #define GlobusGFSErrorIncorrectChecksum(computed, expected) \
1562 globus_error_put(GlobusGFSErrorObjIncorrectChecksum( \
1563 NULL, computed, expected))
1564 #define GlobusGFSErrorObjIncorrectChecksum(cause, computed, expected) \
1565 GlobusGFSErrorObj( \
1568 "INCORRECT_CHECKSUM", \
1569 "GridFTP-Computed-Checksum: %s\n" \
1570 "GridFTP-Expected-Checksum: %s", (computed), (expected))
1572 #define GlobusGFSErrorMultipartUploadNotFound() \
1573 globus_error_put(GlobusGFSErrorObjMultipartUploadNotFound(NULL))
1574 #define GlobusGFSErrorObjMultipartUploadNotFound(cause) \
1575 GlobusGFSErrorObj(cause, 553, "MULTI_PART_UPLOAD_NOT_FOUND", NULL)
1577 #define GlobusGFSErrorAppendNotSupported() \
1578 globus_error_put(GlobusGFSErrorObjAppendNotSupported(NULL))
1579 #define GlobusGFSErrorObjAppendNotSupported(cause) \
1580 GlobusGFSErrorObj((cause), 553, "APPEND_NOT_SUPPORTED", NULL)
1582 #define GlobusGFSErrorAmbiguousPath(ambiguity) \
1583 globus_error_put(GlobusGFSErrorObjAmbiguousPath(NULL, ambiguity))
1584 #define GlobusGFSErrorObjAmbiguousPath(cause, ambiguity) \
1585 GlobusGFSErrorObj( \
1589 "GridFTP-Path: %s", \
1592 #define GlobusGFSErrorTooBusy() \
1593 globus_error_put(GlobusGFSErrorObjTooBusy(NULL))
1594 #define GlobusGFSErrorObjTooBusy(cause) \
1595 GlobusGFSErrorObj((cause), 451, "TOO_BUSY", NULL)
1597 #define GlobusGFSErrorDataChannelAuthenticationFailure() \
1598 globus_error_put(GlobusGFSErrorObjDataChannelAuthenticationFailure( \
1600 #define GlobusGFSErrorObjDataChannelAuthenticationFailure(cause) \
1601 GlobusGFSErrorObj((cause), 425, \
1602 "DATA_CHANNEL_AUTHENTICATION_FAILURE", NULL)
1604 #define GlobusGFSErrorDataChannelCommunicationFailure() \
1605 globus_error_put(GlobusGFSErrorObjDataChannelCommunicationFailure( \
1607 #define GlobusGFSErrorObjDataChannelCommunicationFailure(cause) \
1608 GlobusGFSErrorObj((cause), 425, \
1609 "DATA_CHANNEL_COMMUNICATION_FAILURE", NULL)
1611 #define GlobusGFSErrorLoginDenied() \
1612 globus_error_put(GlobusGFSErrorObjLoginDenied(NULL))
1613 #define GlobusGFSErrorObjLoginDenied(cause) \
1614 GlobusGFSErrorObj((cause), 530, "LOGIN_DENIED", NULL)
1616 #define GlobusGFSErrorPermissionDenied() \
1617 globus_error_put(GlobusGFSErrorObjPermissionDenied(NULL))
1618 #define GlobusGFSErrorObjPermissionDenied(cause) \
1619 GlobusGFSErrorObj((cause), 550, "PERMISSION_DENIED", NULL)
1621 #define GlobusGFSErrorQuotaExceeded() \
1622 globus_error_put(GlobusGFSErrorObjQuotaExceeded(NULL))
1623 #define GlobusGFSErrorObjQuotaExceeded(cause) \
1624 GlobusGFSErrorObj((cause), 451, "QUOTA_EXCEEDED", NULL)
1626 #define GlobusGFSErrorNoSpaceLeft() \
1627 globus_error_put(GlobusGFSErrorObjNoSpaceLeft(NULL))
1628 #define GlobusGFSErrorObjNoSpaceLeft(cause) \
1629 GlobusGFSErrorObj((cause), 451, "NO_SPACE_LEFT", NULL)
1631 #define GlobusGFSErrorInvalidPathName(name) \
1632 globus_error_put(GlobusGFSErrorObjInvalidPathName(NULL, name))
1633 #define GlobusGFSErrorObjInvalidPathName(cause, name) \
1634 GlobusGFSErrorObj((cause), 553, "INVALID_PATH_NAME", \
1635 "GridFTP-Path: %s", name)
1637 #define GlobusGFSErrorPathExists(name) \
1638 globus_error_put(GlobusGFSErrorObjPathExists(NULL, name))
1639 #define GlobusGFSErrorObjPathExists(cause, name) \
1640 GlobusGFSErrorObj((cause), 553, "PATH_EXISTS", \
1641 "GridFTP-Path: %s", name)
1643 #define GlobusGFSErrorIsADirectory(name) \
1644 globus_error_put(GlobusGFSErrorObjIsADirectory(NULL, name))
1645 #define GlobusGFSErrorObjIsADirectory(cause, name) \
1646 GlobusGFSErrorObj((cause), 553, "IS_A_DIRECTORY", \
1647 "GridFTP-Path: %s", name)
1649 #define GlobusGFSErrorNotADirectory(name) \
1650 globus_error_put(GlobusGFSErrorObjNotADirectory(NULL, name))
1651 #define GlobusGFSErrorObjNotADirectory(cause, name) \
1652 GlobusGFSErrorObj((cause), 553, "NOT_A_DIRECTORY", \
1653 "GridFTP-Path: %s", name)
1655 #define GlobusGFSErrorCRLError() \
1656 globus_error_put(GlobusGFSErrorObjCRLError(NULL))
1657 #define GlobusGFSErrorObjCRLError(cause) \
1658 GlobusGFSErrorObj((cause), 530, "CRL_ERROR", NULL)
1660 #define GlobusGFSErrorInternalError(generic_string) \
1661 globus_error_put(GlobusGFSErrorObjInternalError( \
1662 NULL, (generic_string)))
1663 #define GlobusGFSErrorObjInternalError(cause, generic_string) \
1664 GlobusGFSErrorObj((cause), 500, "INTERNAL_ERROR", \
1666 ((generic_string) != NULL) ? "GridFTP-Error: " : "", \
1667 ((generic_string) != NULL) ? generic_string : "")
1669 #define GlobusGFSErrorNotImplemented() \
1670 globus_error_put(GlobusGFSErrorObjNotImplemented(NULL))
1671 #define GlobusGFSErrorObjNotImplemented(cause) \
1672 GlobusGFSErrorObj((cause), 500, "NOT_IMPLEMETED", NULL)
1674 #define GlobusGFSErrorNotImplementedFeature(feature) \
1675 globus_error_put(GlobusGFSErrorObjNotImplementedFeature(NULL, feature))
1676 #define GlobusGFSErrorObjNotImplementedFeature(cause, feature) \
1677 GlobusGFSErrorObj((cause), 500, \
1678 "NOT_IMPLEMETED", "GridFTP-Feature: %s", (feature))
1680 #define GlobusGFSErrorConfigurationError() \
1681 globus_error_put(GlobusGFSErrorObjConfigurationError(NULL))
1682 #define GlobusGFSErrorObjConfigurationError(cause) \
1683 GlobusGFSErrorObj((cause), 500, "CONFIGURATION_ERROR", NULL)
1690 typedef struct globus_i_gfs_ipc_handle_s * globus_gfs_ipc_handle_t;
1715 (*globus_gfs_ipc_callback_t)(
1716 globus_gfs_ipc_handle_t ipc_handle,
1718 globus_gfs_finished_info_t * reply,
1722 (*globus_gfs_ipc_event_callback_t)(
1723 globus_gfs_ipc_handle_t ipc_handle,
1725 globus_gfs_event_info_t * reply,
1729 (*globus_gfs_ipc_close_callback_t)(
1730 globus_gfs_ipc_handle_t ipc_handle,
1735 (*globus_gfs_ipc_open_callback_t)(
1736 globus_gfs_ipc_handle_t ipc_handle,
1738 globus_gfs_finished_info_t * reply,
1742 (*globus_gfs_ipc_error_callback_t)(
1743 globus_gfs_ipc_handle_t ipc_handle,
1748 globus_gfs_ipc_reply_finished(
1749 globus_gfs_ipc_handle_t ipc_handle,
1750 globus_gfs_finished_info_t * reply);
1753 globus_gfs_ipc_reply_event(
1754 globus_gfs_ipc_handle_t ipc_handle,
1755 globus_gfs_event_info_t * reply);
1758 globus_gfs_ipc_reply_session(
1759 globus_gfs_ipc_handle_t ipc_handle,
1760 globus_gfs_finished_info_t * reply);
1774 (*globus_i_gfs_ipc_data_callback_t)(
1775 globus_gfs_finished_info_t * reply,
1779 (*globus_i_gfs_ipc_data_event_callback_t)(
1780 globus_gfs_event_info_t * reply,
1784 (*globus_i_gfs_ipc_done_callback_t)(
1795 (*globus_gfs_ipc_iface_session_start_t)(
1796 globus_gfs_ipc_handle_t ipc_handle,
1797 const gss_ctx_id_t context,
1798 globus_gfs_session_info_t * session_info,
1799 globus_i_gfs_ipc_data_callback_t cb,
1803 globus_gfs_ipc_start_session(
1804 globus_gfs_ipc_handle_t ipc_handle,
1805 globus_gfs_session_info_t * session_info,
1806 globus_gfs_ipc_callback_t cb,
1811 (*globus_gfs_ipc_iface_session_stop_t)(
1812 globus_gfs_ipc_handle_t ipc_handle,
1813 void * session_handle);
1816 globus_gfs_ipc_iface_session_stop(
1817 globus_gfs_ipc_handle_t ipc_handle,
1818 void * session_handle);
1821 (*globus_gfs_ipc_iface_set_cred_t)(
1822 globus_gfs_ipc_handle_t ipc_handle,
1823 void * session_handle,
1824 gss_cred_id_t del_cred);
1827 globus_gfs_ipc_set_cred(
1828 globus_gfs_ipc_handle_t ipc_handle,
1829 gss_cred_id_t del_cred);
1832 (*globus_gfs_ipc_iface_buffer_send_t)(
1833 globus_gfs_ipc_handle_t ipc_handle,
1834 void * session_handle,
1840 globus_gfs_ipc_request_buffer_send(
1841 globus_gfs_ipc_handle_t ipc_handle,
1852 (*globus_gfs_ipc_iface_recv_t)(
1853 globus_gfs_ipc_handle_t ipc_handle,
1854 void * session_handle,
1856 globus_gfs_transfer_info_t * recv_info,
1857 globus_i_gfs_ipc_data_callback_t cb,
1858 globus_i_gfs_ipc_data_event_callback_t event_cb,
1862 globus_gfs_ipc_request_recv(
1863 globus_gfs_ipc_handle_t ipc_handle,
1864 globus_gfs_transfer_info_t * recv_info,
1865 globus_gfs_ipc_callback_t cb,
1866 globus_gfs_ipc_event_callback_t event_cb,
1875 (*globus_gfs_ipc_iface_send_t)(
1876 globus_gfs_ipc_handle_t ipc_handle,
1877 void * session_handle,
1879 globus_gfs_transfer_info_t * send_info,
1880 globus_i_gfs_ipc_data_callback_t cb,
1881 globus_i_gfs_ipc_data_event_callback_t event_cb,
1885 globus_gfs_ipc_request_send(
1886 globus_gfs_ipc_handle_t ipc_handle,
1887 globus_gfs_transfer_info_t * send_info,
1888 globus_gfs_ipc_callback_t cb,
1889 globus_gfs_ipc_event_callback_t event_cb,
1893 (*globus_gfs_ipc_iface_list_t)(
1894 globus_gfs_ipc_handle_t ipc_handle,
1895 void * session_handle,
1897 globus_gfs_transfer_info_t * list_info,
1898 globus_i_gfs_ipc_data_callback_t cb,
1899 globus_i_gfs_ipc_data_event_callback_t event_cb,
1903 globus_gfs_ipc_request_list(
1904 globus_gfs_ipc_handle_t ipc_handle,
1905 globus_gfs_transfer_info_t * data_info,
1906 globus_gfs_ipc_callback_t cb,
1907 globus_gfs_ipc_event_callback_t event_cb,
1916 (*globus_gfs_ipc_iface_command_t)(
1917 globus_gfs_ipc_handle_t ipc_handle,
1918 void * session_handle,
1920 globus_gfs_command_info_t * cmd_info,
1921 globus_i_gfs_ipc_data_callback_t cb,
1925 globus_gfs_ipc_request_command(
1926 globus_gfs_ipc_handle_t ipc_handle,
1927 globus_gfs_command_info_t * cmd_info,
1928 globus_gfs_ipc_callback_t cb,
1937 (*globus_gfs_ipc_iface_active_data_t)(
1938 globus_gfs_ipc_handle_t ipc_handle,
1939 void * session_handle,
1941 globus_gfs_data_info_t * data_info,
1942 globus_i_gfs_ipc_data_callback_t cb,
1946 globus_gfs_ipc_request_active_data(
1947 globus_gfs_ipc_handle_t ipc_handle,
1948 globus_gfs_data_info_t * data_info,
1949 globus_gfs_ipc_callback_t cb,
1958 (*globus_gfs_ipc_iface_passive_data_t)(
1959 globus_gfs_ipc_handle_t ipc_handle,
1960 void * session_handle,
1962 globus_gfs_data_info_t * data_info,
1963 globus_i_gfs_ipc_data_callback_t cb,
1967 globus_gfs_ipc_request_passive_data(
1968 globus_gfs_ipc_handle_t ipc_handle,
1969 globus_gfs_data_info_t * data_info,
1970 globus_gfs_ipc_callback_t cb,
1977 (*globus_gfs_ipc_iface_stat_t)(
1978 globus_gfs_ipc_handle_t ipc_handle,
1979 void * session_handle,
1981 globus_gfs_stat_info_t * stat_info,
1982 globus_i_gfs_ipc_data_callback_t cb,
1986 globus_gfs_ipc_request_stat(
1987 globus_gfs_ipc_handle_t ipc_handle,
1988 globus_gfs_stat_info_t * stat_info,
1989 globus_gfs_ipc_callback_t cb,
1996 (*globus_gfs_ipc_iface_transfer_event_t)(
1997 globus_gfs_ipc_handle_t ipc_handle,
1998 void * session_handle,
1999 globus_gfs_event_info_t * event_info);
2003 globus_gfs_ipc_request_transfer_event(
2004 globus_gfs_ipc_handle_t ipc_handle,
2005 globus_gfs_event_info_t * event_info);
2012 (*globus_gfs_ipc_iface_data_destroy_t)(
2013 globus_gfs_ipc_handle_t ipc_handle,
2014 void * session_handle,
2018 globus_gfs_ipc_request_data_destroy(
2019 globus_gfs_ipc_handle_t ipc_handle,
2022 typedef struct globus_i_gfs_ipc_iface_s
2024 globus_gfs_ipc_iface_session_start_t session_start_func;
2025 globus_gfs_ipc_iface_session_stop_t session_stop_func;
2026 globus_gfs_ipc_iface_recv_t recv_func;
2027 globus_gfs_ipc_iface_send_t send_func;
2028 globus_gfs_ipc_iface_command_t command_func;
2029 globus_gfs_ipc_iface_active_data_t active_func;
2030 globus_gfs_ipc_iface_passive_data_t passive_func;
2031 globus_gfs_ipc_iface_data_destroy_t data_destroy_func;
2032 globus_gfs_ipc_iface_stat_t stat_func;
2033 globus_gfs_ipc_iface_list_t list_func;
2034 globus_gfs_ipc_iface_transfer_event_t transfer_event_func;
2035 globus_gfs_ipc_iface_set_cred_t set_cred;
2036 globus_gfs_ipc_iface_buffer_send_t buffer_send;
2037 } globus_gfs_ipc_iface_t;
2048 globus_gfs_ipc_handle_create(
2049 globus_gfs_ipc_iface_t * iface,
2050 globus_xio_system_socket_t system_handle,
2051 globus_i_gfs_ipc_done_callback_t done_cb,
2058 globus_gfs_ipc_close(
2059 globus_gfs_ipc_handle_t ipc_handle,
2060 globus_gfs_ipc_close_callback_t cb,
2064 globus_gfs_ipc_reply_close(
2065 globus_gfs_ipc_handle_t ipc_handle);
2068 globus_gfs_ipc_session_stop(
2069 globus_gfs_ipc_handle_t ipc_handle);
2072 globus_gfs_ipc_handle_connect(
2073 globus_gfs_session_info_t * session_info,
2074 globus_gfs_ipc_open_callback_t cb,
2076 globus_gfs_ipc_error_callback_t error_cb,
2077 void * error_user_arg);
2080 globus_gfs_ipc_handle_connect_ex(
2081 globus_gfs_session_info_t * session_info,
2082 globus_gfs_ipc_open_callback_t cb,
2084 globus_gfs_ipc_error_callback_t error_cb,
2085 void * error_user_arg,
2088 const char *auth_mode,
2089 const char *subject,
2090 time_t connect_timeout,
2091 time_t idle_timeout,
2095 globus_gfs_ipc_handle_obtain(
2096 globus_gfs_session_info_t * session_info,
2097 globus_gfs_ipc_iface_t * iface,
2098 globus_gfs_ipc_open_callback_t cb,
2100 globus_gfs_ipc_error_callback_t error_cb,
2101 void * error_user_arg);
2106 #define BRAIN_SYMBOL_NAME (void*)"gridftp_brain"
2107 extern globus_extension_registry_t brain_i_registry;
2110 (*globus_i_gfs_brain_select_nodes_func_t)(
2111 globus_i_gfs_brain_node_t *** out_node_array,
2112 int * out_array_length,
2113 const char * repo_name,
2114 globus_off_t filesize,
2119 (*globus_i_gfs_brain_release_node_func_t)(
2120 globus_i_gfs_brain_node_t * contact_node,
2121 globus_gfs_brain_reason_t reason);
2124 (*globus_i_gfs_brain_init_func_t)();
2127 (*globus_i_gfs_brain_stop_func_t)();
2130 (*globus_i_gfs_brain_get_available_func_t)(
2131 const char * user_id,
2132 const char * repo_name,
2136 typedef struct globus_i_gfs_brain_module_s
2138 globus_i_gfs_brain_init_func_t init_func;
2139 globus_i_gfs_brain_stop_func_t stop_func;
2140 globus_i_gfs_brain_select_nodes_func_t select_func;
2141 globus_i_gfs_brain_release_node_func_t release_func;
2142 globus_i_gfs_brain_get_available_func_t available_func;
2143 } globus_i_gfs_brain_module_t;
2145 extern globus_i_gfs_brain_module_t globus_i_gfs_default_brain;
2148 globus_gfs_brain_select_nodes(
2149 globus_i_gfs_brain_node_t *** out_node_array,
2150 int * out_array_length,
2151 const char * repo_name,
2152 globus_off_t filesize,
2157 globus_gfs_brain_release_node(
2158 globus_i_gfs_brain_node_t * contact_node,
2159 globus_gfs_brain_reason_t reason);
2162 globus_gfs_brain_get_available(
2163 const char * user_id,
2164 const char * repo_name,
2168 globus_gfs_ipc_handle_get_contact_string(
2169 globus_gfs_ipc_handle_t ipc_handle,
2170 char ** contact_string);
2173 globus_gfs_ipc_init(
2180 globus_gfs_ipc_add_server(
2181 globus_xio_server_t server_handle);
2183 extern globus_gfs_ipc_iface_t globus_gfs_ipc_default_iface;
2196 typedef struct globus_i_gfs_acl_handle_s * globus_gfs_acl_handle_t;
2201 typedef enum globus_gfs_acl_action_e
2204 GFS_ACL_ACTION_INIT = 1,
2206 GFS_ACL_ACTION_DELETE,
2208 GFS_ACL_ACTION_WRITE,
2210 GFS_ACL_ACTION_CREATE,
2212 GFS_ACL_ACTION_READ,
2214 GFS_ACL_ACTION_LOOKUP,
2218 GFS_ACL_ACTION_AUTHZ_ASSERT,
2221 GFS_ACL_ACTION_COMMIT,
2224 } globus_gfs_acl_action_t;
2228 typedef struct globus_gfs_acl_info_s
2235 gss_ctx_id_t context;
2236 } globus_gfs_acl_info_t;
2240 typedef struct globus_gfs_acl_object_desc_s
2261 globus_gfs_op_info_t op_info;
2262 } globus_gfs_acl_object_desc_t;
2265 typedef enum globus_gfs_acl_status_e
2268 GLOBUS_GFS_ACL_COMPLETE = 1,
2271 GLOBUS_GFS_ACL_WOULD_BLOCK
2272 } globus_gfs_acl_status_t;
2289 (*globus_gfs_acl_init_t)(
2291 globus_gfs_acl_info_t * acl_info,
2292 globus_gfs_acl_handle_t acl_handle,
2305 (*globus_gfs_acl_authorize_t)(
2307 globus_gfs_acl_action_t action,
2308 globus_gfs_acl_object_desc_t * object,
2309 globus_gfs_acl_info_t * acl_info,
2310 globus_gfs_acl_handle_t acl_handle,
2315 (*globus_gfs_acl_destroy_t)(
2321 (*globus_gfs_acl_audit_t)(
2323 globus_gfs_acl_action_t action,
2324 globus_gfs_acl_object_desc_t * object,
2325 const char * message);
2329 typedef struct globus_gfs_acl_module_s
2331 globus_gfs_acl_init_t init_func;
2332 globus_gfs_acl_authorize_t authorize_func;
2333 globus_gfs_acl_destroy_t destroy_func;
2334 globus_gfs_acl_audit_t audit_func;
2335 } globus_gfs_acl_module_t;
2341 globus_gfs_acl_authorized_finished(
2342 globus_gfs_acl_handle_t acl_handle,
2348 globus_gfs_acl_action_to_string(
2349 globus_gfs_acl_action_t action);
2358 (*globus_i_gfs_config_set_string_cb_t)(
2359 const char * option_name,
2365 (*globus_i_gfs_config_set_int_cb_t)(
2366 const char * option_name,
2375 } globus_i_gfs_config_option_cb_ent_t;
2378 globus_gfs_config_enable_cb(
2379 globus_i_gfs_config_option_cb_ent_t * cb_handle,
2383 globus_gfs_config_add_cb(
2384 globus_i_gfs_config_option_cb_ent_t ** cb_handle,
2390 globus_gfs_config_get_bool(
2391 const char * option_name);
2394 globus_gfs_config_get_string(
2395 const char * option_name);
2398 globus_gfs_config_get_list(
2399 const char * option_name);
2402 globus_gfs_config_get(
2403 const char * option_name);
2406 globus_gfs_config_get_int(
2407 const char * option_name);
2410 globus_gfs_config_set_int(
2415 globus_gfs_config_set_bool(
2420 globus_gfs_config_set_ptr(
2425 globus_gfs_config_inc_int(