freebsd-skq/sys/nlm/sm_inter.h
dfr 79d2dfdaa6 Add the new kernel-mode NFS Lock Manager. To use it instead of the
user-mode lock manager, build a kernel with the NFSLOCKD option and
add '-k' to 'rpc_lockd_flags' in rc.conf.

Highlights include:

* Thread-safe kernel RPC client - many threads can use the same RPC
  client handle safely with replies being de-multiplexed at the socket
  upcall (typically driven directly by the NIC interrupt) and handed
  off to whichever thread matches the reply. For UDP sockets, many RPC
  clients can share the same socket. This allows the use of a single
  privileged UDP port number to talk to an arbitrary number of remote
  hosts.

* Single-threaded kernel RPC server. Adding support for multi-threaded
  server would be relatively straightforward and would follow
  approximately the Solaris KPI. A single thread should be sufficient
  for the NLM since it should rarely block in normal operation.

* Kernel mode NLM server supporting cancel requests and granted
  callbacks. I've tested the NLM server reasonably extensively - it
  passes both my own tests and the NFS Connectathon locking tests
  running on Solaris, Mac OS X and Ubuntu Linux.

* Userland NLM client supported. While the NLM server doesn't have
  support for the local NFS client's locking needs, it does have to
  field async replies and granted callbacks from remote NLMs that the
  local client has contacted. We relay these replies to the userland
  rpc.lockd over a local domain RPC socket.

* Robust deadlock detection for the local lock manager. In particular
  it will detect deadlocks caused by a lock request that covers more
  than one blocking request. As required by the NLM protocol, all
  deadlock detection happens synchronously - a user is guaranteed that
  if a lock request isn't rejected immediately, the lock will
  eventually be granted. The old system allowed for a 'deferred
  deadlock' condition where a blocked lock request could wake up and
  find that some other deadlock-causing lock owner had beaten them to
  the lock.

* Since both local and remote locks are managed by the same kernel
  locking code, local and remote processes can safely use file locks
  for mutual exclusion. Local processes have no fairness advantage
  compared to remote processes when contending to lock a region that
  has just been unlocked - the local lock manager enforces a strict
  first-come first-served model for both local and remote lockers.

Sponsored by:	Isilon Systems
PR:		95247 107555 115524 116679
MFC after:	2 weeks
2008-03-26 15:23:12 +00:00

113 lines
2.7 KiB
C

/*
* Please do not edit this file.
* It was generated using rpcgen.
*/
/* $FreeBSD$ */
#ifndef _SM_INTER_H_RPCGEN
#define _SM_INTER_H_RPCGEN
#include <rpc/rpc.h>
#ifdef __cplusplus
extern "C" {
#endif
#define SM_MAXSTRLEN 1024
struct sm_name {
char *mon_name;
};
typedef struct sm_name sm_name;
struct my_id {
char *my_name;
int my_prog;
int my_vers;
int my_proc;
};
typedef struct my_id my_id;
struct mon_id {
char *mon_name;
struct my_id my_id;
};
typedef struct mon_id mon_id;
struct mon {
struct mon_id mon_id;
char priv[16];
};
typedef struct mon mon;
struct stat_chge {
char *mon_name;
int state;
};
typedef struct stat_chge stat_chge;
struct sm_stat {
int state;
};
typedef struct sm_stat sm_stat;
enum sm_res {
stat_succ = 0,
stat_fail = 1
};
typedef enum sm_res sm_res;
struct sm_stat_res {
sm_res res_stat;
int state;
};
typedef struct sm_stat_res sm_stat_res;
struct sm_status {
char *mon_name;
int state;
char priv[16];
};
typedef struct sm_status sm_status;
#define SM_PROG ((unsigned long)(100024))
#define SM_VERS ((unsigned long)(1))
extern void sm_prog_1(struct svc_req *rqstp, SVCXPRT *transp);
#define SM_STAT ((unsigned long)(1))
extern struct sm_stat_res * sm_stat_1(struct sm_name *, CLIENT *);
extern struct sm_stat_res * sm_stat_1_svc(struct sm_name *, struct svc_req *);
#define SM_MON ((unsigned long)(2))
extern struct sm_stat_res * sm_mon_1(struct mon *, CLIENT *);
extern struct sm_stat_res * sm_mon_1_svc(struct mon *, struct svc_req *);
#define SM_UNMON ((unsigned long)(3))
extern struct sm_stat * sm_unmon_1(struct mon_id *, CLIENT *);
extern struct sm_stat * sm_unmon_1_svc(struct mon_id *, struct svc_req *);
#define SM_UNMON_ALL ((unsigned long)(4))
extern struct sm_stat * sm_unmon_all_1(struct my_id *, CLIENT *);
extern struct sm_stat * sm_unmon_all_1_svc(struct my_id *, struct svc_req *);
#define SM_SIMU_CRASH ((unsigned long)(5))
extern void * sm_simu_crash_1(void *, CLIENT *);
extern void * sm_simu_crash_1_svc(void *, struct svc_req *);
#define SM_NOTIFY ((unsigned long)(6))
extern void * sm_notify_1(struct stat_chge *, CLIENT *);
extern void * sm_notify_1_svc(struct stat_chge *, struct svc_req *);
extern int sm_prog_1_freeresult(SVCXPRT *, xdrproc_t, caddr_t);
/* the xdr functions */
extern bool_t xdr_sm_name(XDR *, sm_name*);
extern bool_t xdr_my_id(XDR *, my_id*);
extern bool_t xdr_mon_id(XDR *, mon_id*);
extern bool_t xdr_mon(XDR *, mon*);
extern bool_t xdr_stat_chge(XDR *, stat_chge*);
extern bool_t xdr_sm_stat(XDR *, sm_stat*);
extern bool_t xdr_sm_res(XDR *, sm_res*);
extern bool_t xdr_sm_stat_res(XDR *, sm_stat_res*);
extern bool_t xdr_sm_status(XDR *, sm_status*);
#ifdef __cplusplus
}
#endif
#endif /* !_SM_INTER_H_RPCGEN */