include/linux/sunrpc/clnt.h

   1 /*
   2  *  linux/include/linux/sunrpc/clnt.h
   3  *
   4  *  Declarations for the high-level RPC client interface
   5  *
   6  *  Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
   7  */
   8
   9 #ifndef _LINUX_SUNRPC_CLNT_H
  10 #define _LINUX_SUNRPC_CLNT_H
  11
  12 #include <linux/sunrpc/msg_prot.h>
  13 #include <linux/sunrpc/sched.h>
  14 #include <linux/sunrpc/xprt.h>
  15 #include <linux/sunrpc/auth.h>
  16 #include <linux/sunrpc/stats.h>
  17 #include <linux/sunrpc/xdr.h>
  18 #include <linux/sunrpc/timer.h>
  19 #include <asm/signal.h>
  20
  21 struct rpc_inode;
  22
  23 /*
  24  * The high-level client handle
  25  */
  26 struct rpc_clnt {
  27         atomic_t                cl_count;       /* Number of clones */
  28         atomic_t                cl_users;       /* number of references */
  29         struct rpc_xprt *       cl_xprt;        /* transport */
  30         struct rpc_procinfo *   cl_procinfo;    /* procedure info */
  31         u32                     cl_prog,        /* RPC program number */
  32                                 cl_vers,        /* RPC version number */
  33                                 cl_maxproc;     /* max procedure number */
  34
  35         char *                  cl_server;      /* server machine name */
  36         char *                  cl_protname;    /* protocol name */
  37         struct rpc_auth *       cl_auth;        /* authenticator */
  38         struct rpc_stat *       cl_stats;       /* per-program statistics */
  39         struct rpc_iostats *    cl_metrics;     /* per-client statistics */
  40
  41         unsigned int            cl_softrtry : 1,/* soft timeouts */
  42                                 cl_intr     : 1,/* interruptible */
  43                                 cl_discrtry : 1,/* disconnect before retry */
  44                                 cl_autobind : 1,/* use getport() */
  45                                 cl_oneshot  : 1,/* dispose after use */
  46                                 cl_dead     : 1;/* abandoned */
  47
  48         struct rpc_rtt *        cl_rtt;         /* RTO estimator data */
  49
  50         int                     cl_nodelen;     /* nodename length */
  51         char                    cl_nodename[UNX_MAXNODENAME];
  52         char                    cl_pathname[30];/* Path in rpc_pipe_fs */
  53         struct vfsmount *       cl_vfsmnt;
  54         struct dentry *         cl_dentry;      /* inode */
  55         struct rpc_clnt *       cl_parent;      /* Points to parent of clones */
  56         struct rpc_rtt          cl_rtt_default;
  57         struct rpc_program *    cl_program;
  58         char                    cl_inline_name[32];
  59 };
  60
  61 /*
  62  * General RPC program info
  63  */
  64 #define RPC_MAXVERSION          4
  65 struct rpc_program {
  66         char *                  name;           /* protocol name */
  67         u32                     number;         /* program number */
  68         unsigned int            nrvers;         /* number of versions */
  69         struct rpc_version **   version;        /* version array */
  70         struct rpc_stat *       stats;          /* statistics */
  71         char *                  pipe_dir_name;  /* path to rpc_pipefs dir */
  72 };
  73
  74 struct rpc_version {
  75         u32                     number;         /* version number */
  76         unsigned int            nrprocs;        /* number of procs */
  77         struct rpc_procinfo *   procs;          /* procedure array */
  78 };
  79
  80 /*
  81  * Procedure information
  82  */
  83 struct rpc_procinfo {
  84         u32                     p_proc;         /* RPC procedure number */
  85         kxdrproc_t              p_encode;       /* XDR encode function */
  86         kxdrproc_t              p_decode;       /* XDR decode function */
  87         unsigned int            p_bufsiz;       /* req. buffer size */
  88         unsigned int            p_count;        /* call count */
  89         unsigned int            p_timer;        /* Which RTT timer to use */
  90         u32                     p_statidx;      /* Which procedure to account */
  91         char *                  p_name;         /* name of procedure */
  92 };
  93
  94 #ifdef __KERNEL__
  95
  96 struct rpc_create_args {
  97         int                     protocol;
  98         struct sockaddr         *address;
  99         size_t                  addrsize;
 100         struct rpc_timeout      *timeout;
 101         char                    *servername;
 102         struct rpc_program      *program;
 103         u32                     version;
 104         rpc_authflavor_t        authflavor;
 105         unsigned long           flags;
 106 };
 107
 108 /* Values for "flags" field */
 109 #define RPC_CLNT_CREATE_HARDRTRY        (1UL << 0)
 110 #define RPC_CLNT_CREATE_INTR            (1UL << 1)
 111 #define RPC_CLNT_CREATE_AUTOBIND        (1UL << 2)
 112 #define RPC_CLNT_CREATE_ONESHOT         (1UL << 3)
 113 #define RPC_CLNT_CREATE_NONPRIVPORT     (1UL << 4)
 114 #define RPC_CLNT_CREATE_NOPING          (1UL << 5)
 115 #define RPC_CLNT_CREATE_DISCRTRY        (1UL << 6)
 116
 117 struct rpc_clnt *rpc_create(struct rpc_create_args *args);
 118 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
 119                                 struct rpc_program *, int);
 120 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
 121 int             rpc_shutdown_client(struct rpc_clnt *);
 122 int             rpc_destroy_client(struct rpc_clnt *);
 123 void            rpc_release_client(struct rpc_clnt *);
 124 void            rpc_getport(struct rpc_task *);
 125 int             rpc_register(u32, u32, int, unsigned short, int *);
 126
 127 void            rpc_call_setup(struct rpc_task *, struct rpc_message *, int);
 128
 129 int             rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg,
 130                                int flags, const struct rpc_call_ops *tk_ops,
 131                                void *calldata);
 132 int             rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg,
 133                               int flags);
 134 void            rpc_restart_call(struct rpc_task *);
 135 void            rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset);
 136 void            rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset);
 137 void            rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
 138 size_t          rpc_max_payload(struct rpc_clnt *);
 139 void            rpc_force_rebind(struct rpc_clnt *);
 140 int             rpc_ping(struct rpc_clnt *clnt, int flags);
 141 size_t          rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
 142 char *          rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
 143
 144 /*
 145  * Helper function for NFSroot support
 146  */
 147 int             rpc_getport_external(struct sockaddr_in *, __u32, __u32, int);
 148
 149 #endif /* __KERNEL__ */
 150 #endif /* _LINUX_SUNRPC_CLNT_H */