cctools
chirp_reli.h
Go to the documentation of this file.
1 /*
2 Copyright (C) 2003-2004 Douglas Thain and the University of Wisconsin
3 Copyright (C) 2005- The University of Notre Dame
4 This software is distributed under the GNU General Public License.
5 See the file COPYING for details.
6 */
7 
32 #ifndef CHIRP_RELI_H
33 #define CHIRP_RELI_H
34 
35 #include "chirp_types.h"
36 
37 #include <sys/types.h>
38 #include <stdio.h>
39 #include <dirent.h>
40 
59 struct chirp_file *chirp_reli_open(const char *host, const char *path, INT64_T flags, INT64_T mode, time_t stoptime);
60 
69 INT64_T chirp_reli_close(struct chirp_file *file, time_t stoptime);
70 
81 INT64_T chirp_reli_pread(struct chirp_file *file, void *buffer, INT64_T length, INT64_T offset, time_t stoptime);
82 
94 INT64_T chirp_reli_pwrite(struct chirp_file *file, const void *buffer, INT64_T length, INT64_T offset, time_t stoptime);
95 
106 INT64_T chirp_reli_pread_unbuffered(struct chirp_file *file, void *buffer, INT64_T length, INT64_T offset, time_t stoptime);
107 
118 INT64_T chirp_reli_pwrite_unbuffered(struct chirp_file *file, const void *buffer, INT64_T length, INT64_T offset, time_t stoptime);
119 
134 INT64_T chirp_reli_sread(struct chirp_file *file, void *buffer, INT64_T length, INT64_T stride_length, INT64_T stride_skip, INT64_T offset, time_t stoptime);
135 
150 INT64_T chirp_reli_swrite(struct chirp_file *file, const void *buffer, INT64_T length, INT64_T stride_length, INT64_T stride_skip, INT64_T offset, time_t stoptime);
151 
160 INT64_T chirp_reli_fstat(struct chirp_file *file, struct chirp_stat *info, time_t stoptime);
161 
170 INT64_T chirp_reli_fstatfs(struct chirp_file *file, struct chirp_statfs *info, time_t stoptime);
171 
181 INT64_T chirp_reli_fchown(struct chirp_file *file, INT64_T uid, INT64_T gid, time_t stoptime);
182 
192 INT64_T chirp_reli_fchmod(struct chirp_file *file, INT64_T mode, time_t stoptime);
193 
201 INT64_T chirp_reli_ftruncate(struct chirp_file *file, INT64_T length, time_t stoptime);
202 
212 INT64_T chirp_reli_flush(struct chirp_file *file, time_t stoptime);
213 
214 INT64_T chirp_reli_fsync(struct chirp_file *file, time_t stoptime);
215 
228 INT64_T chirp_reli_getfile(const char *host, const char *path, FILE * stream, time_t stoptime);
229 
241 INT64_T chirp_reli_getfile_buffer(const char *host, const char *path, char **buffer, time_t stoptime);
242 
256 INT64_T chirp_reli_putfile(const char *host, const char *path, FILE * stream, INT64_T mode, INT64_T length, time_t stoptime);
257 
270 INT64_T chirp_reli_putfile_buffer(const char *host, const char *path, const void *buffer, INT64_T mode, size_t length, time_t stoptime);
271 
282 CHIRP_SEARCH *chirp_reli_opensearch( const char *host, const char *paths, const char *pattern, int flags, time_t stoptime );
283 
294 INT64_T chirp_reli_getlongdir(const char *host, const char *path, chirp_longdir_t callback, void *arg, time_t stoptime);
295 
307 INT64_T chirp_reli_getdir(const char *host, const char *path, chirp_dir_t callback, void *arg, time_t stoptime);
308 
319 struct chirp_dir *chirp_reli_opendir(const char *host, const char *path, time_t stoptime);
320 
331 struct chirp_dirent *chirp_reli_readdir(struct chirp_dir *dir);
332 
341 void chirp_reli_closedir(struct chirp_dir *dir);
342 
343 /* FIXME document */
344 INT64_T chirp_reli_ticket_create(const char *host, char name[CHIRP_PATH_MAX], unsigned bits, time_t stoptime);
345 INT64_T chirp_reli_ticket_register(const char *host, const char *name, const char *subject, time_t duration, time_t stoptime);
346 INT64_T chirp_reli_ticket_delete(const char *host, const char *name, time_t stoptime);
347 INT64_T chirp_reli_ticket_list(const char *host, const char *subject, char ***list, time_t stoptime);
348 INT64_T chirp_reli_ticket_get(const char *host, const char *name, char **subject, char **ticket, time_t * duration, char ***rights, time_t stoptime);
349 INT64_T chirp_reli_ticket_modify(const char *host, const char *name, const char *path, const char *aclmask, time_t stoptime);
350 
360 INT64_T chirp_reli_getacl(const char *host, const char *path, chirp_dir_t callback, void *arg, time_t stoptime);
361 
371 INT64_T chirp_reli_setacl(const char *host, const char *path, const char *subject, const char *rights, time_t stoptime);
372 
381 INT64_T chirp_reli_resetacl(const char *host, const char *path, const char *rights, time_t stoptime);
382 
391 INT64_T chirp_reli_locate(const char *host, const char *path, chirp_loc_t callback, void *arg, time_t stoptime);
392 
401 INT64_T chirp_reli_whoami(const char *host, char *subject, INT64_T length, time_t stoptime);
402 
413 INT64_T chirp_reli_whoareyou(const char *host, const char *rhost, char *subject, INT64_T length, time_t stoptime);
414 
422 INT64_T chirp_reli_unlink(const char *host, const char *path, time_t stoptime);
423 
432 INT64_T chirp_reli_rename(const char *host, const char *path, const char *newpath, time_t stoptime);
433 
442 INT64_T chirp_reli_link(const char *host, const char *path, const char *newpath, time_t stoptime);
443 
452 INT64_T chirp_reli_symlink(const char *host, const char *path, const char *newpath, time_t stoptime);
453 
463 INT64_T chirp_reli_readlink(const char *host, const char *path, char *buf, INT64_T length, time_t stoptime);
464 
465 
474 INT64_T chirp_reli_mkdir(const char *host, const char *path, INT64_T mode, time_t stoptime);
475 
484 INT64_T chirp_reli_mkdir_recursive(const char *host, const char *path, INT64_T mode, time_t stoptime);
485 
494 INT64_T chirp_reli_rmdir(const char *host, const char *path, time_t stoptime);
495 
506 INT64_T chirp_reli_rmall(const char *host, const char *path, time_t stoptime);
507 
517 INT64_T chirp_reli_stat(const char *host, const char *path, struct chirp_stat *info, time_t stoptime);
518 
529 INT64_T chirp_reli_lstat(const char *host, const char *path, struct chirp_stat *info, time_t stoptime);
530 
539 INT64_T chirp_reli_statfs(const char *host, const char *path, struct chirp_statfs *info, time_t stoptime);
540 
552 INT64_T chirp_reli_access(const char *host, const char *path, INT64_T flags, time_t stoptime);
553 
565 INT64_T chirp_reli_chmod(const char *host, const char *path, INT64_T mode, time_t stoptime);
566 
577 INT64_T chirp_reli_chown(const char *host, const char *path, INT64_T uid, INT64_T gid, time_t stoptime);
578 
589 INT64_T chirp_reli_lchown(const char *host, const char *path, INT64_T uid, INT64_T gid, time_t stoptime);
590 
599 INT64_T chirp_reli_truncate(const char *host, const char *path, INT64_T length, time_t stoptime);
600 
610 INT64_T chirp_reli_utime(const char *host, const char *path, time_t actime, time_t modtime, time_t stoptime);
611 
626 INT64_T chirp_reli_hash(const char *host, const char *path, const char *algorithm, unsigned char digest[CHIRP_DIGEST_MAX], time_t stoptime);
627 
641 INT64_T chirp_reli_md5(const char *host, const char *path, unsigned char digest[16], time_t stoptime);
642 
653 INT64_T chirp_reli_setrep(const char *host, const char *path, int nreps, time_t stoptime );
654 
655 INT64_T chirp_reli_getxattr(const char *host, const char *path, const char *name, void *data, size_t size, time_t stoptime);
656 INT64_T chirp_reli_fgetxattr(struct chirp_file *file, const char *name, void *data, size_t size, time_t stoptime);
657 INT64_T chirp_reli_lgetxattr(const char *host, const char *path, const char *name, void *data, size_t size, time_t stoptime);
658 INT64_T chirp_reli_listxattr(const char *host, const char *path, char *list, size_t size, time_t stoptime);
659 INT64_T chirp_reli_flistxattr(struct chirp_file *file, char *list, size_t size, time_t stoptime);
660 INT64_T chirp_reli_llistxattr(const char *host, const char *path, char *list, size_t size, time_t stoptime);
661 INT64_T chirp_reli_setxattr(const char *host, const char *path, const char *name, const void *data, size_t size, int flags, time_t stoptime);
662 INT64_T chirp_reli_fsetxattr(struct chirp_file *file, const char *name, const void *data, size_t size, int flags, time_t stoptime);
663 INT64_T chirp_reli_lsetxattr(const char *host, const char *path, const char *name, const void *data, size_t size, int flags, time_t stoptime);
664 INT64_T chirp_reli_removexattr(const char *host, const char *path, const char *name, time_t stoptime);
665 INT64_T chirp_reli_fremovexattr(struct chirp_file *file, const char *name, time_t stoptime);
666 INT64_T chirp_reli_lremovexattr(const char *host, const char *path, const char *name, time_t stoptime);
667 
668 INT64_T chirp_reli_job_create (const char *host, const char *json, chirp_jobid_t *id, time_t stoptime);
669 INT64_T chirp_reli_job_commit (const char *host, const char *json, time_t stoptime);
670 INT64_T chirp_reli_job_kill (const char *host, const char *json, time_t stoptime);
671 INT64_T chirp_reli_job_status (const char *host, const char *json, char **status, time_t stoptime);
672 INT64_T chirp_reli_job_wait (const char *host, chirp_jobid_t id, INT64_T timeout, char **status, time_t stoptime);
673 INT64_T chirp_reli_job_reap (const char *host, const char *json, time_t stoptime);
674 
682 INT64_T chirp_reli_remote_debug(const char *host, const char *flag, time_t stoptime);
683 
697 INT64_T chirp_reli_localpath(const char *host, const char *path, char *localpath, int length, time_t stoptime);
698 
710 INT64_T chirp_reli_audit(const char *host, const char *path, struct chirp_audit **list, time_t stoptime);
711 
724 INT64_T chirp_reli_thirdput(const char *host, const char *path, const char *thirdhost, const char *thirdpath, time_t stoptime);
725 
737 INT64_T chirp_reli_mkalloc(const char *host, const char *path, INT64_T size, INT64_T mode, time_t stoptime);
738 
750 INT64_T chirp_reli_lsalloc(const char *host, const char *path, char *allocpath, INT64_T * total, INT64_T * inuse, time_t stoptime);
751 
762 INT64_T chirp_reli_bulkio(struct chirp_bulkio *list, int count, time_t stoptime);
763 
771 INT64_T chirp_reli_blocksize_get();
772 
780 void chirp_reli_blocksize_set(INT64_T bs);
781 
790 
794 void chirp_reli_disconnect( const char *host );
795 
796 #endif
797 
798 /* vim: set noexpandtab tabstop=4: */
INT64_T chirp_reli_mkalloc(const char *host, const char *path, INT64_T size, INT64_T mode, time_t stoptime)
Create a space allocation.
INT64_T chirp_reli_getfile(const char *host, const char *path, FILE *stream, time_t stoptime)
Get an entire file efficiently.
INT64_T chirp_reli_setrep(const char *host, const char *path, int nreps, time_t stoptime)
Set replication factor.
struct chirp_dir * chirp_reli_opendir(const char *host, const char *path, time_t stoptime)
Open a directory for listing.
INT64_T chirp_reli_swrite(struct chirp_file *file, const void *buffer, INT64_T length, INT64_T stride_length, INT64_T stride_skip, INT64_T offset, time_t stoptime)
Strided write to a file.
INT64_T chirp_reli_lsalloc(const char *host, const char *path, char *allocpath, INT64_T *total, INT64_T *inuse, time_t stoptime)
List a space allocation.
INT64_T chirp_reli_stat(const char *host, const char *path, struct chirp_stat *info, time_t stoptime)
Get file status.
INT64_T chirp_reli_symlink(const char *host, const char *path, const char *newpath, time_t stoptime)
Create a symbolic link.
INT64_T chirp_reli_getacl(const char *host, const char *path, chirp_dir_t callback, void *arg, time_t stoptime)
Get an access control list.
INT64_T chirp_reli_putfile(const char *host, const char *path, FILE *stream, INT64_T mode, INT64_T length, time_t stoptime)
Put an entire file efficiently.
INT64_T chirp_reli_access(const char *host, const char *path, INT64_T flags, time_t stoptime)
Check access permissions.
INT64_T chirp_reli_flush(struct chirp_file *file, time_t stoptime)
Flush any pending changes to a file.
INT64_T chirp_reli_unlink(const char *host, const char *path, time_t stoptime)
Delete a file.
#define CHIRP_PATH_MAX
The maximum length of a full path in any Chirp operation.
Definition: chirp_protocol.h:20
INT64_T chirp_reli_chmod(const char *host, const char *path, INT64_T mode, time_t stoptime)
Change mode bits.
INT64_T chirp_reli_thirdput(const char *host, const char *path, const char *thirdhost, const char *thirdpath, time_t stoptime)
Third party transfer.
INT64_T chirp_reli_ftruncate(struct chirp_file *file, INT64_T length, time_t stoptime)
Truncate an open file.
struct chirp_stat info
The properties of the directory entry.
Definition: chirp_types.h:98
INT64_T chirp_reli_remote_debug(const char *host, const char *flag, time_t stoptime)
Set the debug options on the remote server.
CHIRP_SEARCH * chirp_reli_opensearch(const char *host, const char *paths, const char *pattern, int flags, time_t stoptime)
Open a file search stream Performs a search operation on the Chirp server and stores its results to ...
INT64_T chirp_reli_fchmod(struct chirp_file *file, INT64_T mode, time_t stoptime)
Change the mode bits of a file.
Describes a bulk I/O operation.
Definition: chirp_types.h:158
struct chirp_file * chirp_reli_open(const char *host, const char *path, INT64_T flags, INT64_T mode, time_t stoptime)
Creates or opens a file in preparation for I/O.
INT64_T chirp_reli_audit(const char *host, const char *path, struct chirp_audit **list, time_t stoptime)
Measure remote space consumption.
INT64_T chirp_reli_fchown(struct chirp_file *file, INT64_T uid, INT64_T gid, time_t stoptime)
Change the ownership of a file.
INT64_T chirp_reli_pwrite(struct chirp_file *file, const void *buffer, INT64_T length, INT64_T offset, time_t stoptime)
Write data to a file.
INT64_T chirp_reli_hash(const char *host, const char *path, const char *algorithm, unsigned char digest[CHIRP_DIGEST_MAX], time_t stoptime)
Checksum a remote file.
INT64_T chirp_reli_truncate(const char *host, const char *path, INT64_T length, time_t stoptime)
Truncate a file.
char * name
The name of the directory entry.
Definition: chirp_types.h:96
void(* chirp_longdir_t)(const char *path, struct chirp_stat *info, void *arg)
A callback function typedef used to display a detailed directory.
Definition: chirp_types.h:201
INT64_T chirp_reli_chown(const char *host, const char *path, INT64_T uid, INT64_T gid, time_t stoptime)
Change the ownership of a file.
INT64_T chirp_reli_fstatfs(struct chirp_file *file, struct chirp_statfs *info, time_t stoptime)
Get file system status.
void(* chirp_loc_t)(const char *location, void *arg)
A callback function typedef used to display a file&#39;s location(s).
Definition: chirp_types.h:211
Describes the properties of a file, much like the Unix stat structure.
Definition: chirp_types.h:34
INT64_T chirp_reli_getdir(const char *host, const char *path, chirp_dir_t callback, void *arg, time_t stoptime)
Get a simple directory listing.
INT64_T chirp_reli_localpath(const char *host, const char *path, char *localpath, int length, time_t stoptime)
Return the local path of a file.
INT64_T chirp_reli_utime(const char *host, const char *path, time_t actime, time_t modtime, time_t stoptime)
Change the modification times of a file.
INT64_T chirp_reli_rmdir(const char *host, const char *path, time_t stoptime)
Delete a directory if it is empty.
INT64_T chirp_reli_pread_unbuffered(struct chirp_file *file, void *buffer, INT64_T length, INT64_T offset, time_t stoptime)
Read data from a file without buffering.
void chirp_reli_closedir(struct chirp_dir *dir)
Close a directory.
INT64_T chirp_reli_mkdir_recursive(const char *host, const char *path, INT64_T mode, time_t stoptime)
Create a new directory recursively.
void(* chirp_dir_t)(const char *path, void *arg)
A callback function typedef used to display a directory or access control list.
Definition: chirp_types.h:190
Descibes the space consumed by a single user on a Chirp server.
Definition: chirp_types.h:175
INT64_T chirp_reli_bulkio(struct chirp_bulkio *list, int count, time_t stoptime)
Perform multiple I/O operations in bulk.
INT64_T chirp_reli_fstat(struct chirp_file *file, struct chirp_stat *info, time_t stoptime)
Get file status.
INT64_T chirp_reli_mkdir(const char *host, const char *path, INT64_T mode, time_t stoptime)
Create a new directory.
struct chirp_dirent * chirp_reli_readdir(struct chirp_dir *dir)
Read one item from a directory.
INT64_T chirp_reli_sread(struct chirp_file *file, void *buffer, INT64_T length, INT64_T stride_length, INT64_T stride_skip, INT64_T offset, time_t stoptime)
Strided read from a file.
INT64_T chirp_reli_pwrite_unbuffered(struct chirp_file *file, const void *buffer, INT64_T length, INT64_T offset, time_t stoptime)
Write data to a file without buffering.
INT64_T chirp_reli_setacl(const char *host, const char *path, const char *subject, const char *rights, time_t stoptime)
Modify an access control list.
INT64_T chirp_reli_lchown(const char *host, const char *path, INT64_T uid, INT64_T gid, time_t stoptime)
Change the ownership of a file or link.
INT64_T chirp_reli_whoami(const char *host, char *subject, INT64_T length, time_t stoptime)
Return the caller&#39;s identity.
INT64_T chirp_reli_lstat(const char *host, const char *path, struct chirp_stat *info, time_t stoptime)
Get file or link status.
INT64_T chirp_reli_pread(struct chirp_file *file, void *buffer, INT64_T length, INT64_T offset, time_t stoptime)
Read data from a file.
INT64_T chirp_reli_getlongdir(const char *host, const char *path, chirp_longdir_t callback, void *arg, time_t stoptime)
Get a detailed directory listing.
int64_t chirp_jobid_t
The type of Chirp job identifiers.
Definition: chirp_types.h:216
INT64_T chirp_reli_link(const char *host, const char *path, const char *newpath, time_t stoptime)
Create a hard link.
void chirp_reli_cleanup_before_fork()
Prepare to fork in a parallel program.
INT64_T chirp_reli_resetacl(const char *host, const char *path, const char *rights, time_t stoptime)
Reset an access control list.
INT64_T chirp_reli_statfs(const char *host, const char *path, struct chirp_statfs *info, time_t stoptime)
Get filesystem status.
INT64_T chirp_reli_locate(const char *host, const char *path, chirp_loc_t callback, void *arg, time_t stoptime)
Identify the true location of a path.
INT64_T chirp_reli_rmall(const char *host, const char *path, time_t stoptime)
Delete a directory recursively.
INT64_T chirp_reli_getfile_buffer(const char *host, const char *path, char **buffer, time_t stoptime)
Get an entire file efficiently to memory.
INT64_T chirp_reli_whoareyou(const char *host, const char *rhost, char *subject, INT64_T length, time_t stoptime)
Return the server&#39;s identity against another server.
Describes the properties of a file system, much like the Unix statfs structure.
Definition: chirp_types.h:72
All of the structure and type definitions used by the Chirp API.
Definition: buffer.h:26
void chirp_reli_blocksize_set(INT64_T bs)
Set the buffer block size.
void chirp_reli_disconnect(const char *host)
Closes the link to the host, if active.
INT64_T chirp_reli_md5(const char *host, const char *path, unsigned char digest[16], time_t stoptime)
Checksum a remote file.
#define CHIRP_DIGEST_MAX
Maximum digest size for a supported hash function.
Definition: chirp_types.h:222
INT64_T chirp_reli_putfile_buffer(const char *host, const char *path, const void *buffer, INT64_T mode, size_t length, time_t stoptime)
Put an entire file efficiently from memory.
INT64_T chirp_reli_blocksize_get()
Return the current buffer block size.
INT64_T chirp_reli_close(struct chirp_file *file, time_t stoptime)
Closes an open file.
INT64_T chirp_reli_rename(const char *host, const char *path, const char *newpath, time_t stoptime)
Rename a file or directory.
Describes a directory entry returned by chirp_reli_readdir.
Definition: chirp_types.h:95
INT64_T chirp_reli_readlink(const char *host, const char *path, char *buf, INT64_T length, time_t stoptime)
Examine a symbolic link.