/usr/include/globus/globus_gram_protocol.h is in libglobus-gram-protocol-dev 11.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | /*
* Copyright 1999-2006 University of Chicago
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#if !defined(GLOBUS_GRAM_PROTOCOL_H)
#define GLOBUS_GRAM_PROTOCOL_H
/**
* @mainpage Globus GRAM Protocol
*
* The Globus GRAM Protocol Library implements the GRAM protocol. It is used
* by the GRAM Client and GRAM Job Manager. It provides the constants used
* by in the sending and receiving of GRAM messages. It also provides
* functions to encode GRAM requests and replies, and to send and receive
* the GRAM queries.
*
* - @ref globus_gram_protocol_functions "GRAM Protocol Functions"
* - @ref globus_gram_protocol_job_state_t "Job States"
* - @ref globus_gram_protocol_job_signal_t "Signals"
* - @ref globus_gram_protocol_error_t "GRAM Errors"
* - @ref globus_gram_protocol "GRAM Protocol Message Format"
*/
#ifndef EXTERN_C_BEGIN
# ifdef __cplusplus
# define EXTERN_C_BEGIN extern "C" {
# define EXTERN_C_END }
# else
# define EXTERN_C_BEGIN
# define EXTERN_C_END
# endif
#endif
#include "globus_io.h"
#include "globus_gram_protocol_constants.h"
EXTERN_C_BEGIN
enum { GLOBUS_GRAM_PROTOCOL_VERSION = 2 };
enum { GLOBUS_GRAM_PROTOCOL_MAX_MSG_SIZE = 64000 };
enum { GLOBUS_GRAM_PROTOCOL_PARAM_SIZE = 1024 };
/**
* @typedef globus_gram_protocol_handle_t
* @brief Unique GRAM protocol identifier
* @ingroup globus_gram_protocol_io
*
* @details
* The @a #globus_gram_protocol_handle_t data type is used by functions in
* the GRAM protocol API as a unique discriminant between instances
* of a callback invocation.
*
* There are no public functions that operate on these handles. They are
* used as identifiers for callback functions.
*/
typedef unsigned long globus_gram_protocol_handle_t;
/**
* @typedef globus_gram_protocol_extension_t
* @brief GRAM protocol extension attribute-value pair
* @ingroup globus_gram_protocol_io
*
* @details
* The @a globus_gram_protocol_extension_t data type contains an attribute
* value pair that represents an extension to the GRAM2 protocol.
*/
typedef struct globus_gram_protocol_hash_entry_s
{
/** Name of the extension attribute */
char * attribute;
/** Value of the extension attribute */
char * value;
}
globus_gram_protocol_extension_t;
typedef void (*globus_gram_protocol_callback_t)(
void * arg,
globus_gram_protocol_handle_t handle,
globus_byte_t * message,
globus_size_t msgsize,
int errorcode,
char * uri);
typedef void (*globus_gram_protocol_delegation_callback_t)(
void * arg,
globus_gram_protocol_handle_t handle,
gss_cred_id_t credential,
int errorcode);
#define GLOBUS_GRAM_PROTOCOL_MODULE (&globus_i_gram_protocol_module)
extern globus_module_descriptor_t globus_i_gram_protocol_module;
extern gss_cred_id_t globus_i_gram_protocol_credential;
/*
* creates a default set of TCP attributes (authentication with self, SSL
* wrappers around messages)
*/
int
globus_gram_protocol_setup_attr(
globus_io_attr_t * attr);
/*
* authorizes the remote party if the remote party is the same as the
* local party
*/
globus_bool_t
globus_gram_protocol_authorize_self(
gss_ctx_id_t context);
/*
* replaces all credentials used in this module with the given ones
*/
int
globus_gram_protocol_set_credentials(gss_cred_id_t new_credentials);
/*
* sets up and registers a listener. returns port and host. user_ptr
* must contain the read callback to be used.
*/
int
globus_gram_protocol_allow_attach(
char ** url,
globus_gram_protocol_callback_t callback,
void * callback_arg);
/*
* kills the listener at the specified URL.
*/
int
globus_gram_protocol_callback_disallow(
char * url);
/* Frame and send a GRAM protocol message. */
int
globus_gram_protocol_post(
const char * url,
globus_gram_protocol_handle_t * handle,
globus_io_attr_t * attr,
globus_byte_t * message,
globus_size_t message_size,
globus_gram_protocol_callback_t callback,
void * callback_arg);
/* Frame and send a GRAM protocol message, following up an ok reply with
* a GSSAPI delegation handshake.
*/
int
globus_gram_protocol_post_delegation(
const char * url,
globus_gram_protocol_handle_t * handle,
globus_io_attr_t * attr,
globus_byte_t * message,
globus_size_t message_size,
gss_cred_id_t cred_handle,
gss_OID_set restriction_oids,
gss_buffer_set_t restriction_buffers,
OM_uint32 req_flags,
OM_uint32 time_req,
globus_gram_protocol_callback_t callback,
void * callback_arg);
/* Frame and send a GRAM protocol reply. */
int
globus_gram_protocol_reply(
globus_gram_protocol_handle_t handle,
int code,
globus_byte_t * message,
globus_size_t message_size);
/* Frame and send a GRAM protocol reply indicating that we will
* accept a delegated credential now. Call back when the delegation
* is completed.
*
* After delegation is complete, the user must call
* globus_gram_protocol_reply to indicate the status after the delegation.
*/
int
globus_gram_protocol_accept_delegation(
globus_gram_protocol_handle_t handle,
gss_OID_set restriction_oids,
gss_buffer_set_t restriction_bufers,
OM_uint32 req_flags,
OM_uint32 time_req,
globus_gram_protocol_delegation_callback_t
callback,
void * arg);
/* Frame a GRAM protocol message */
int
globus_gram_protocol_frame_request(
const char * url,
const globus_byte_t * msg,
globus_size_t msgsize,
globus_byte_t ** framedmsg,
globus_size_t * framedsize);
/* Frame a GRAM protocol reply */
int
globus_gram_protocol_frame_reply(
int code,
const globus_byte_t * msg,
globus_size_t msgsize,
globus_byte_t ** framedmsg,
globus_size_t * framedsize);
/************************ "HTTP" pack/unpack functions *********************/
int
globus_gram_protocol_pack_job_request(
int job_state_mask,
const char * callback_url,
const char * rsl,
globus_byte_t ** query,
globus_size_t * querysize);
int
globus_gram_protocol_unpack_job_request(
const globus_byte_t * query,
globus_size_t querysize,
int * job_state_mask,
char ** callback_url,
char ** description);
int
globus_gram_protocol_pack_job_request_reply(
int status,
const char * job_contact, /* may be null */
globus_byte_t ** reply,
globus_size_t * replysize);
int
globus_gram_protocol_unpack_job_request_reply(
const globus_byte_t * reply,
globus_size_t replysize,
int * status,
char ** job_contact);
int
globus_gram_protocol_pack_job_request_reply_with_extensions(
int status,
const char * job_contact, /* may be null */
globus_hashtable_t * extensions,
globus_byte_t ** reply,
globus_size_t * replysize);
int
globus_gram_protocol_unpack_job_request_reply_with_extensions(
const globus_byte_t * reply,
globus_size_t replysize,
int * status,
char ** job_contact,
globus_hashtable_t * extensions);
int
globus_gram_protocol_pack_status_request(
const char * status_request,
globus_byte_t ** query,
globus_size_t * querysize);
int
globus_gram_protocol_unpack_status_request(
const globus_byte_t * query,
globus_size_t querysize,
char ** status_requst);
int
globus_gram_protocol_pack_status_reply(
int job_status,
int failure_code,
int job_failure_code,
globus_byte_t ** reply,
globus_size_t * replysize);
int
globus_gram_protocol_pack_status_reply_with_extensions(
int job_status,
int failure_code,
int job_failure_code,
globus_hashtable_t * extensions,
globus_byte_t ** reply,
globus_size_t * replysize);
int
globus_gram_protocol_unpack_status_reply(
const globus_byte_t * reply,
globus_size_t replysize,
int * job_status,
int * failure_code,
int * job_failure_code);
int
globus_gram_protocol_unpack_status_reply_with_extensions(
const globus_byte_t * reply,
globus_size_t replysize,
globus_hashtable_t * extensions);
int
globus_gram_protocol_pack_status_update_message(
char * job_contact,
int status,
int failure_code,
globus_byte_t ** reply,
globus_size_t * replysize);
int
globus_gram_protocol_unpack_status_update_message(
const globus_byte_t * reply,
globus_size_t replysize,
char ** job_contact,
int * status,
int * failure_code);
int
globus_gram_protocol_pack_status_update_message_with_extensions(
char * job_contact,
int status,
int failure_code,
globus_hashtable_t * extensions,
globus_byte_t ** reply,
globus_size_t * replysize);
int
globus_gram_protocol_unpack_status_update_message_with_extensions(
const globus_byte_t * reply,
globus_size_t replysize,
globus_hashtable_t * message_hash);
int
globus_gram_protocol_unpack_message(
const char * message,
size_t message_length,
globus_hashtable_t * message_attributes);
int
globus_gram_protocol_pack_version_request(
char ** request,
size_t * requestsize);
void
globus_gram_protocol_hash_destroy(
globus_hashtable_t * message_hash);
globus_gram_protocol_extension_t *
globus_gram_protocol_create_extension(
const char * attribute,
const char * format,
...);
int
globus_gram_protocol_get_sec_context(
globus_gram_protocol_handle_t handle,
gss_ctx_id_t * context);
const char *
globus_gram_protocol_error_string(int error_code);
/* To be used only by the GRAM client API */
void
globus_gram_protocol_error_7_hack_replace_message(const char * message);
void
globus_gram_protocol_error_10_hack_replace_message(const char * message);
/*
* RSL Parameters
*/
#define GLOBUS_GRAM_PROTOCOL_EXECUTABLE_PARAM "executable"
#define GLOBUS_GRAM_PROTOCOL_ARGUMENTS_PARAM "arguments"
#define GLOBUS_GRAM_PROTOCOL_ENVIRONMENT_PARAM "environment"
#define GLOBUS_GRAM_PROTOCOL_DIR_PARAM "directory"
#define GLOBUS_GRAM_PROTOCOL_COUNT_PARAM "count"
#define GLOBUS_GRAM_PROTOCOL_STDIN_PARAM "stdin"
#define GLOBUS_GRAM_PROTOCOL_STDOUT_PARAM "stdout"
#define GLOBUS_GRAM_PROTOCOL_STDERR_PARAM "stderr"
#define GLOBUS_GRAM_PROTOCOL_MAX_WALL_TIME_PARAM "maxwalltime"
#define GLOBUS_GRAM_PROTOCOL_MAX_CPU_TIME_PARAM "maxcputime"
#define GLOBUS_GRAM_PROTOCOL_MAX_TIME_PARAM "maxtime"
#define GLOBUS_GRAM_PROTOCOL_PARADYN_PARAM "paradyn"
#define GLOBUS_GRAM_PROTOCOL_JOB_TYPE_PARAM "jobtype"
#define GLOBUS_GRAM_PROTOCOL_MYJOB_PARAM "grammyjob"
#define GLOBUS_GRAM_PROTOCOL_QUEUE_PARAM "queue"
#define GLOBUS_GRAM_PROTOCOL_PROJECT_PARAM "project"
#define GLOBUS_GRAM_PROTOCOL_HOST_COUNT_PARAM "hostcount"
#define GLOBUS_GRAM_PROTOCOL_DRY_RUN_PARAM "dryrun"
#define GLOBUS_GRAM_PROTOCOL_MIN_MEMORY_PARAM "minmemory"
#define GLOBUS_GRAM_PROTOCOL_MAX_MEMORY_PARAM "maxmemory"
#define GLOBUS_GRAM_PROTOCOL_START_TIME_PARAM "starttime"
#define GLOBUS_GRAM_PROTOCOL_RESERVATION_HANDLE_PARAM "reservationhandle"
#define GLOBUS_GRAM_PROTOCOL_STDOUT_POSITION_PARAM "stdoutposition"
#define GLOBUS_GRAM_PROTOCOL_STDERR_POSITION_PARAM "stderrposition"
#define GLOBUS_GRAM_PROTOCOL_SAVE_STATE_PARAM "savestate"
#define GLOBUS_GRAM_PROTOCOL_RESTART_PARAM "restart"
#define GLOBUS_GRAM_PROTOCOL_TWO_PHASE_COMMIT_PARAM "twophase"
#define GLOBUS_GRAM_PROTOCOL_REMOTE_IO_URL_PARAM "remoteiourl"
#define GLOBUS_GRAM_PROTOCOL_FILE_STAGE_IN_PARAM "filestagein"
#define GLOBUS_GRAM_PROTOCOL_FILE_STAGE_IN_SHARED_PARAM "filestageinshared"
#define GLOBUS_GRAM_PROTOCOL_FILE_STAGE_OUT_PARAM "filestageout"
#define GLOBUS_GRAM_PROTOCOL_FILE_CLEANUP_PARAM "filecleanup"
#define GLOBUS_GRAM_PROTOCOL_SCRATCHDIR_PARAM "scratchdir"
#define GLOBUS_GRAM_PROTOCOL_GASS_CACHE_PARAM "gasscache"
#define GLOBUS_GRAM_PROTOCOL_PROXY_TIMEOUT_PARAM "proxytimeout"
#define GLOBUS_GRAM_PROTOCOL_USER_NAME "username"
#define GLOBUS_GRAM_PROTOCOL_DEFAULT_STDIN "/dev/null"
#define GLOBUS_GRAM_PROTOCOL_DEFAULT_STDOUT "/dev/null"
#define GLOBUS_GRAM_PROTOCOL_DEFAULT_STDERR "/dev/null"
#define GLOBUS_GRAM_PROTOCOL_DEFAULT_MYJOB "collective"
#define GLOBUS_GRAM_PROTOCOL_DEFAULT_JOBTYPE "multiple"
#define GLOBUS_GRAM_PROTOCOL_DEFAULT_DRYRUN "no"
#define GLOBUS_GRAM_PROTOCOL_DEFAULT_START_TIME "none"
EXTERN_C_END
#endif
|