include/linux/lockd/bind.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * linux/include/linux/lockd/bind.h
   4  *
   5  * This is the part of lockd visible to nfsd and the nfs client.
   6  *
   7  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
   8  */
   9
  10 #ifndef LINUX_LOCKD_BIND_H
  11 #define LINUX_LOCKD_BIND_H
  12
  13 #include <linux/lockd/nlm.h>
  14 /* need xdr-encoded error codes too, so... */
  15 #include <linux/lockd/xdr.h>
  16 #ifdef CONFIG_LOCKD_V4
  17 #include <linux/lockd/xdr4.h>
  18 #endif
  19
  20 /* Dummy declarations */
  21 struct svc_rqst;
  22 struct rpc_task;
  23
  24 /*
  25  * This is the set of functions for lockd->nfsd communication
  26  */
  27 struct nlmsvc_binding {
  28         __be32                  (*fopen)(struct svc_rqst *,
  29                                                 struct nfs_fh *,
  30                                                 struct file **);
  31         void                    (*fclose)(struct file *);
  32 };
  33
  34 extern const struct nlmsvc_binding *nlmsvc_ops;
  35
  36 /*
  37  * Similar to nfs_client_initdata, but without the NFS-specific
  38  * rpc_ops field.
  39  */
  40 struct nlmclnt_initdata {
  41         const char              *hostname;
  42         const struct sockaddr   *address;
  43         size_t                  addrlen;
  44         unsigned short          protocol;
  45         u32                     nfs_version;
  46         int                     noresvport;
  47         struct net              *net;
  48         const struct nlmclnt_operations *nlmclnt_ops;
  49         const struct cred       *cred;
  50 };
  51
  52 /*
  53  * Functions exported by the lockd module
  54  */
  55
  56 extern struct nlm_host *nlmclnt_init(const struct nlmclnt_initdata *nlm_init);
  57 extern void     nlmclnt_done(struct nlm_host *host);
  58
  59 /*
  60  * NLM client operations provide a means to modify RPC processing of NLM
  61  * requests.  Callbacks receive a pointer to data passed into the call to
  62  * nlmclnt_proc().
  63  */
  64 struct nlmclnt_operations {
  65         /* Called on successful allocation of nlm_rqst, use for allocation or
  66          * reference counting. */
  67         void (*nlmclnt_alloc_call)(void *);
  68
  69         /* Called in rpc_task_prepare for unlock.  A return value of true
  70          * indicates the callback has put the task to sleep on a waitqueue
  71          * and NLM should not call rpc_call_start(). */
  72         bool (*nlmclnt_unlock_prepare)(struct rpc_task*, void *);
  73
  74         /* Called when the nlm_rqst is freed, callbacks should clean up here */
  75         void (*nlmclnt_release_call)(void *);
  76 };
  77
  78 extern int      nlmclnt_proc(struct nlm_host *host, int cmd, struct file_lock *fl, void *data);
  79 extern int      lockd_up(struct net *net, const struct cred *cred);
  80 extern void     lockd_down(struct net *net);
  81
  82 #endif /* LINUX_LOCKD_BIND_H */