libnfs/include/libnfs-private.h

610 lines
21 KiB
C

/* -*- mode:c; tab-width:8; c-basic-offset:8; indent-tabs-mode:nil; -*- */
/*
Copyright (C) 2010 by Ronnie Sahlberg <ronniesahlberg@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program; if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _LIBNFS_PRIVATE_H_
#define _LIBNFS_PRIVATE_H_
#ifdef HAVE_CONFIG_H
#include "config.h" /* HAVE_SOCKADDR_STORAGE ? */
#endif
#ifdef HAVE_NET_IF_H
#include <net/if.h>
#endif
#if !defined(WIN32) && !defined(PS2_EE)
#include <sys/socket.h> /* struct sockaddr_storage */
#endif
#if defined(WIN32) && !defined(IFNAMSIZ)
#define IFNAMSIZ 255
#endif
#if defined(PS3_PPU) && !defined(IFNAMSIZ)
#define IFNAMSIZ 16
#endif
#if defined(PS2_EE) && !defined(IFNAMSIZ)
#define IFNAMSIZ 16
#endif
#include "libnfs-multithreading.h"
#include "libnfs-zdr.h"
#include "../nfs/libnfs-raw-nfs.h"
#include "../nfs4/libnfs-raw-nfs4.h"
#ifdef __cplusplus
extern "C" {
#endif
#ifndef MIN
#define MIN(a, b) (((a) < (b)) ? (a) : (b))
#endif
#ifndef MAX
#define MAX(a, b) (((a) > (b)) ? (a) : (b))
#endif
#if !defined(HAVE_SOCKADDR_STORAGE) && !defined(WIN32) && !defined(PS2_EE)
/*
* RFC 2553: protocol-independent placeholder for socket addresses
*/
#define _SS_MAXSIZE 128
#define _SS_ALIGNSIZE (sizeof(double))
#define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) * 2)
#define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) * 2 - \
_SS_PAD1SIZE - _SS_ALIGNSIZE)
struct sockaddr_storage {
#ifdef HAVE_SOCKADDR_LEN
unsigned char ss_len; /* address length */
unsigned char ss_family; /* address family */
#else
unsigned short ss_family;
#endif
char __ss_pad1[_SS_PAD1SIZE];
double __ss_align; /* force desired structure storage alignment */
char __ss_pad2[_SS_PAD2SIZE];
};
#endif
struct rpc_fragment {
struct rpc_fragment *next;
uint32_t size;
char *data;
};
#define RPC_CONTEXT_MAGIC 0xc6e46435
#define RPC_PARAM_UNDEFINED -1
/*
* Queue is singly-linked but we hold on to the tail
*/
struct rpc_queue {
struct rpc_pdu *head, *tail;
};
#define HASHES 1024
#define NFS_RA_TIMEOUT 5
#define NFS_MAX_XFER_SIZE (1024 * 1024)
#define ZDR_ENCODE_OVERHEAD 1024
#define ZDR_ENCODEBUF_MINSIZE 4096
struct rpc_endpoint {
struct rpc_endpoint *next;
int program;
int version;
struct service_proc *procs;
int num_procs;
};
struct rpc_context {
uint32_t magic;
int fd;
int old_fd;
int is_connected;
int is_nonblocking;
char *error_string;
rpc_cb connect_cb;
void *connect_data;
struct AUTH *auth;
uint32_t xid;
struct rpc_queue outqueue;
struct sockaddr_storage udp_src;
struct rpc_queue waitpdu[HASHES];
uint32_t waitpdu_len;
#ifdef HAVE_MULTITHREADING
libnfs_mutex_t rpc_mutex;
#endif /* HAVE_MULTITHREADING */
uint32_t inpos;
char rm_buf[4];
char *inbuf;
/* special fields for UDP, which can sometimes be BROADCASTed */
int is_udp;
struct sockaddr_storage udp_dest;
int is_broadcast;
/* track the address we connect to so we can auto-reconnect on session failure */
struct sockaddr_storage s;
int auto_reconnect;
int num_retries;
/* fragment reassembly */
struct rpc_fragment *fragments;
/* parameters passable via URL */
int tcp_syncnt;
int uid;
int gid;
uint32_t readahead;
uint32_t pagecache;
uint32_t pagecache_ttl;
int debug;
int timeout;
char ifname[IFNAMSIZ];
/* Is a server context ? */
int is_server_context;
struct rpc_endpoint *endpoints;
};
struct rpc_pdu {
struct rpc_pdu *next;
uint32_t xid;
ZDR zdr;
uint32_t written;
struct rpc_data outdata;
rpc_cb cb;
void *private_data;
/* function to decode the zdr reply data and buffer to decode into */
zdrproc_t zdr_decode_fn;
caddr_t zdr_decode_buf;
uint32_t zdr_decode_bufsize;
#define PDU_DISCARD_AFTER_SENDING 0x00000001
uint32_t flags;
uint64_t timeout;
};
void rpc_reset_queue(struct rpc_queue *q);
void rpc_enqueue(struct rpc_queue *q, struct rpc_pdu *pdu);
void rpc_return_to_queue(struct rpc_queue *q, struct rpc_pdu *pdu);
unsigned int rpc_hash_xid(uint32_t xid);
struct rpc_pdu *rpc_allocate_pdu(struct rpc_context *rpc, int program, int version, int procedure, rpc_cb cb, void *private_data, zdrproc_t zdr_decode_fn, int zdr_bufsize);
struct rpc_pdu *rpc_allocate_pdu2(struct rpc_context *rpc, int program, int version, int procedure, rpc_cb cb, void *private_data, zdrproc_t zdr_decode_fn, int zdr_bufsize, size_t alloc_hint);
void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
uint32_t rpc_get_pdu_size(char *buf);
int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
void rpc_error_all_pdus(struct rpc_context *rpc, const char *error);
void rpc_set_error(struct rpc_context *rpc, const char *error_string, ...)
#ifdef __GNUC__
__attribute__((format(printf, 2, 3)))
#endif
;
void nfs_set_error(struct nfs_context *nfs, char *error_string, ...)
#ifdef __GNUC__
__attribute__((format(printf, 2, 3)))
#endif
;
#if defined(PS2_EE)
#define RPC_LOG(rpc, level, format, ...) ;
#else
#define RPC_LOG(rpc, level, format, ...) \
do { \
if (level <= rpc->debug) { \
fprintf(stderr, "libnfs:%d " format "\n", level, ## __VA_ARGS__); \
} \
} while (0)
#endif
const char *nfs_get_server(struct nfs_context *nfs);
const char *nfs_get_export(struct nfs_context *nfs);
/* we dont want to expose UDP to normal applications/users this is private to libnfs to use exclusively for broadcast RPC */
int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
struct rpc_context *rpc_init_udp_context(void);
struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);
void rpc_set_autoreconnect(struct rpc_context *rpc, int num_retries);
void rpc_set_interface(struct rpc_context *rpc, const char *ifname);
void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
void rpc_set_pagecache(struct rpc_context *rpc, uint32_t v);
void rpc_set_pagecache_ttl(struct rpc_context *rpc, uint32_t v);
void rpc_set_readahead(struct rpc_context *rpc, uint32_t v);
void rpc_set_debug(struct rpc_context *rpc, int level);
void rpc_set_timeout(struct rpc_context *rpc, int timeout);
int rpc_get_timeout(struct rpc_context *rpc);
int rpc_add_fragment(struct rpc_context *rpc, char *data, uint32_t size);
void rpc_free_all_fragments(struct rpc_context *rpc);
int rpc_is_udp_socket(struct rpc_context *rpc);
uint64_t rpc_current_time(void);
void *zdr_malloc(ZDR *zdrs, uint32_t size);
struct nfs_cb_data;
void free_nfs_cb_data(struct nfs_cb_data *data);
struct nfs_specdata {
uint32_t specdata1;
uint32_t specdata2;
};
struct nfs_time {
uint32_t seconds;
uint32_t nseconds;
};
struct nfs_attr {
uint32_t type;
uint32_t mode;
uint32_t uid;
uint32_t gid;
uint32_t nlink;
uint64_t size;
uint64_t used;
uint64_t fsid;
struct nfs_specdata rdev;
struct nfs_time atime;
struct nfs_time mtime;
struct nfs_time ctime;
};
struct nfs_fh {
int len;
char *val;
};
struct nfs_context_internal {
char *server;
char *export;
char *cwd;
struct nfs_fh rootfh;
uint64_t readmax;
uint64_t writemax;
int auto_reconnect;
int dircache_enabled;
struct nfsdir *dircache;
uint16_t mask;
int auto_traverse_mounts;
struct nested_mounts *nested_mounts;
int version;
int nfsport;
int mountport;
/* NFSv4 specific fields */
verifier4 verifier;
char *client_name;
uint64_t clientid;
verifier4 setclientid_confirm;
uint32_t open_counter;
int has_lock_owner;
#ifdef HAVE_MULTITHREADING
int multithreading_enabled;
libnfs_thread_t service_thread;
libnfs_mutex_t nfs_mutex;
libnfs_mutex_t nfs4_open_mutex;
struct nfs_thread_context *thread_ctx;
#endif /* HAVE_MULTITHREADING */
};
struct nfs_context {
struct rpc_context *rpc;
struct nfs_context_internal *nfsi;
char *error_string;
#ifdef HAVE_MULTITHREADING
struct nfs_context *master_ctx;
#endif /* HAVE_MULTITHREADING */
};
#ifdef HAVE_MULTITHREADING
struct nfs_thread_context {
struct nfs_thread_context *next;
nfs_tid_t tid;
struct nfs_context nfs;
};
#endif /* HAVE_MULTITHREADING */
typedef int (*continue_func)(struct nfs_context *nfs, struct nfs_attr *attr,
struct nfs_cb_data *data);
struct nfs_cb_data {
struct nfs_context *nfs;
struct nfsfh *nfsfh;
char *saved_path, *path;
int link_count, no_follow;
nfs_cb cb;
void *private_data;
continue_func continue_cb;
void *continue_data;
void (*free_continue_data)(void *);
uint64_t continue_int;
struct nfs_fh fh;
/* for multi-read/write calls. */
int error;
int cancel;
int oom;
int num_calls;
size_t count, org_count;
uint64_t offset, max_offset, org_offset;
char *buffer;
int not_my_buffer;
const char *usrbuf;
int update_pos;
};
struct nested_mounts {
struct nested_mounts *next;
char *path;
struct nfs_fh fh;
struct nfs_attr attr;
};
#define MAX_DIR_CACHE 128
#define MAX_LINK_COUNT 40
struct nfsdir {
struct nfs_fh fh;
struct nfs_attr attr;
struct nfsdir *next;
struct nfsdirent *entries;
struct nfsdirent *current;
};
struct nfs_readahead {
uint64_t fh_offset;
uint32_t cur_ra;
};
struct nfs_pagecache_entry {
char buf[NFS_BLKSIZE];
uint64_t offset;
time_t ts;
};
struct nfs_pagecache {
struct nfs_pagecache_entry *entries;
uint32_t num_entries;
time_t ttl;
};
struct stateid {
uint32_t seqid;
char other[12];
};
struct nfsfh {
struct nfs_fh fh;
int is_sync;
int is_append;
int is_dirty;
uint64_t offset;
struct nfs_readahead ra;
struct nfs_pagecache pagecache;
/* NFSv4 */
struct stateid stateid;
uint32_t lock_owner;
/* locking */
uint32_t open_seqid;
uint32_t lock_seqid;
struct stateid lock_stateid;
};
const struct nfs_fh *nfs_get_rootfh(struct nfs_context *nfs);
int nfs_normalize_path(struct nfs_context *nfs, char *path);
void nfs_free_nfsdir(struct nfsdir *nfsdir);
void nfs_free_nfsfh(struct nfsfh *nfsfh);
void nfs_dircache_add(struct nfs_context *nfs, struct nfsdir *nfsdir);
struct nfsdir *nfs_dircache_find(struct nfs_context *nfs, struct nfs_fh *fh);
void nfs_dircache_drop(struct nfs_context *nfs, struct nfs_fh *fh);
char * nfs_pagecache_get(struct nfs_pagecache *pagecache, uint64_t offset);
void nfs_pagecache_put(struct nfs_pagecache *pagecache, uint64_t offset,
const char *buf, size_t len);
int nfs3_access_async(struct nfs_context *nfs, const char *path, int mode,
nfs_cb cb, void *private_data);
int nfs3_access2_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs3_chdir_async(struct nfs_context *nfs, const char *path,
nfs_cb cb, void *private_data);
int nfs3_chmod_async_internal(struct nfs_context *nfs, const char *path,
int no_follow, int mode, nfs_cb cb,
void *private_data);
int nfs3_chown_async_internal(struct nfs_context *nfs, const char *path,
int no_follow, int uid, int gid,
nfs_cb cb, void *private_data);
int nfs3_close_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb,
void *private_data);
int nfs3_create_async(struct nfs_context *nfs, const char *path, int flags,
int mode, nfs_cb cb, void *private_data);
int nfs3_fchmod_async(struct nfs_context *nfs, struct nfsfh *nfsfh, int mode,
nfs_cb cb, void *private_data);
int nfs3_fchown_async(struct nfs_context *nfs, struct nfsfh *nfsfh, int uid,
int gid, nfs_cb cb, void *private_data);
int nfs3_fstat_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb,
void *private_data);
int nfs3_fstat64_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb,
void *private_data);
int nfs3_fsync_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb,
void *private_data);
int nfs3_ftruncate_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t length, nfs_cb cb, void *private_data);
int nfs3_link_async(struct nfs_context *nfs, const char *oldpath,
const char *newpath, nfs_cb cb, void *private_data);
int nfs3_lseek_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
int64_t offset, int whence, nfs_cb cb, void *private_data);
int nfs3_mkdir2_async(struct nfs_context *nfs, const char *path, int mode,
nfs_cb cb, void *private_data);
int nfs3_mknod_async(struct nfs_context *nfs, const char *path, int mode,
int dev, nfs_cb cb, void *private_data);
int nfs3_mount_async(struct nfs_context *nfs, const char *server,
const char *export, nfs_cb cb, void *private_data);
int nfs3_open_async(struct nfs_context *nfs, const char *path, int flags,
int mode, nfs_cb cb, void *private_data);
int nfs3_opendir_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs3_pread_async_internal(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t offset, size_t count, nfs_cb cb,
void *private_data, int update_pos);
int nfs3_pwrite_async_internal(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t offset, size_t count, const char *buf,
nfs_cb cb, void *private_data, int update_pos);
int nfs3_readlink_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs3_rename_async(struct nfs_context *nfs, const char *oldpath,
const char *newpath, nfs_cb cb, void *private_data);
int nfs3_rmdir_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs3_stat_async(struct nfs_context *nfs, const char *path,
nfs_cb cb, void *private_data);
int nfs3_stat64_async(struct nfs_context *nfs, const char *path,
int no_follow, nfs_cb cb, void *private_data);
int nfs3_statvfs_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs3_statvfs64_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs3_symlink_async(struct nfs_context *nfs, const char *oldpath,
const char *newpath, nfs_cb cb, void *private_data);
int nfs3_truncate_async(struct nfs_context *nfs, const char *path,
uint64_t length, nfs_cb cb, void *private_data);
int nfs3_umount_async(struct nfs_context *nfs, nfs_cb cb, void *private_data);
int nfs3_unlink_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs3_utime_async(struct nfs_context *nfs, const char *path,
struct utimbuf *times, nfs_cb cb, void *private_data);
int nfs3_utimes_async_internal(struct nfs_context *nfs, const char *path,
int no_follow, struct timeval *times,
nfs_cb cb, void *private_data);
int nfs3_write_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t count, const void *buf, nfs_cb cb,
void *private_data);
int nfs4_access_async(struct nfs_context *nfs, const char *path, int mode,
nfs_cb cb, void *private_data);
int nfs4_access2_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs4_chdir_async(struct nfs_context *nfs, const char *path,
nfs_cb cb, void *private_data);
int nfs4_chmod_async_internal(struct nfs_context *nfs, const char *path,
int no_follow, int mode, nfs_cb cb,
void *private_data);
int nfs4_chown_async_internal(struct nfs_context *nfs, const char *path,
int no_follow, int uid, int gid,
nfs_cb cb, void *private_data);
int nfs4_close_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb,
void *private_data);
int nfs4_create_async(struct nfs_context *nfs, const char *path, int flags,
int mode, nfs_cb cb, void *private_data);
int nfs4_fchmod_async(struct nfs_context *nfs, struct nfsfh *nfsfh, int mode,
nfs_cb cb, void *private_data);
int nfs4_fchown_async(struct nfs_context *nfs, struct nfsfh *nfsfh, int uid,
int gid, nfs_cb cb, void *private_data);
int nfs4_fcntl_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
enum nfs4_fcntl_op cmd, void *arg,
nfs_cb cb, void *private_data);
int nfs4_fstat64_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb,
void *private_data);
int nfs4_fsync_async(struct nfs_context *nfs, struct nfsfh *nfsfh, nfs_cb cb,
void *private_data);
int nfs4_ftruncate_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t length, nfs_cb cb, void *private_data);
int nfs4_link_async(struct nfs_context *nfs, const char *oldpath,
const char *newpath, nfs_cb cb, void *private_data);
int nfs4_lseek_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
int64_t offset, int whence, nfs_cb cb, void *private_data);
int nfs4_lockf_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
enum nfs4_lock_op op, uint64_t count,
nfs_cb cb, void *private_data);
int nfs4_mkdir2_async(struct nfs_context *nfs, const char *path, int mode,
nfs_cb cb, void *private_data);
int nfs4_mknod_async(struct nfs_context *nfs, const char *path, int mode,
int dev, nfs_cb cb, void *private_data);
int nfs4_mount_async(struct nfs_context *nfs, const char *server,
const char *export, nfs_cb cb, void *private_data);
int nfs4_open_async(struct nfs_context *nfs, const char *path, int flags,
int mode, nfs_cb cb, void *private_data);
int nfs4_opendir_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs4_pread_async_internal(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t offset, size_t count, nfs_cb cb,
void *private_data, int update_pos);
int nfs4_pwrite_async_internal(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t offset, size_t count, const char *buf,
nfs_cb cb, void *private_data, int update_pos);
int nfs4_readlink_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs4_rename_async(struct nfs_context *nfs, const char *oldpath,
const char *newpath, nfs_cb cb, void *private_data);
int nfs4_rmdir_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs4_stat64_async(struct nfs_context *nfs, const char *path,
int no_follow, nfs_cb cb, void *private_data);
int nfs4_statvfs_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs4_statvfs64_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs4_symlink_async(struct nfs_context *nfs, const char *oldpath,
const char *newpath, nfs_cb cb, void *private_data);
int nfs4_truncate_async(struct nfs_context *nfs, const char *path,
uint64_t length, nfs_cb cb, void *private_data);
int nfs4_unlink_async(struct nfs_context *nfs, const char *path, nfs_cb cb,
void *private_data);
int nfs4_utime_async(struct nfs_context *nfs, const char *path,
struct utimbuf *times, nfs_cb cb, void *private_data);
int nfs4_utimes_async_internal(struct nfs_context *nfs, const char *path,
int no_follow, struct timeval *times,
nfs_cb cb, void *private_data);
int nfs4_write_async(struct nfs_context *nfs, struct nfsfh *nfsfh,
uint64_t count, const void *buf, nfs_cb cb,
void *private_data);
int rpc_write_to_socket(struct rpc_context *rpc);
#ifdef __cplusplus
}
#endif
#endif /* !_LIBNFS_PRIVATE_H_ */