1/*-
  2 * Copyright (c) 2010, Oracle America, Inc.
  3 *
  4 * Redistribution and use in source and binary forms, with or without
  5 * modification, are permitted provided that the following conditions are
  6 * met:
  7 *
  8 *     * Redistributions of source code must retain the above copyright
  9 *       notice, this list of conditions and the following disclaimer.
 10 *     * Redistributions in binary form must reproduce the above
 11 *       copyright notice, this list of conditions and the following
 12 *       disclaimer in the documentation and/or other materials
 13 *       provided with the distribution.
 14 *     * Neither the name of the "Oracle America, Inc." nor the names of its
 15 *       contributors may be used to endorse or promote products derived
 16 *       from this software without specific prior written permission.
 17 *
 18 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 19 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 20 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 21 *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 22 *   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 23 *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 24 *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 25 *   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 26 *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 27 *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 28 *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 29 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 30 */
 31
 32/*
 33 * Kernel/lock manager protocol definition
 34 * Copyright (C) 1986 Sun Microsystems, Inc.
 35 *
 36 * protocol used between the UNIX kernel (the "client") and the
 37 * local lock manager.  The local lock manager is a daemon running
 38 * above the kernel.
 39 */
 40
 41#ifndef RPC_HDR
 42%#ifndef lint
 43%/*static char sccsid[] = "from: @(#)klm_prot.x 1.7 87/07/08 Copyr 1987 Sun Micro";*/
 44%/*static char sccsid[] = "from: @(#)klm_prot.x	2.1 88/08/01 4.0 RPCSRC";*/
 45%#endif /* not lint */
 46%#include <sys/cdefs.h>
 47#endif
 48
 49const	LM_MAXSTRLEN = 1024;
 50
 51/*
 52 * lock manager status returns
 53 */
 54enum klm_stats {
 55	klm_granted = 0,	/* lock is granted */
 56	klm_denied = 1,		/* lock is denied */
 57	klm_denied_nolocks = 2, /* no lock entry available */
 58	klm_working = 3 	/* lock is being processed */
 59};
 60
 61/*
 62 * lock manager lock identifier
 63 */
 64struct klm_lock {
 65	string server_name<LM_MAXSTRLEN>;
 66	netobj fh;		/* a counted file handle */
 67	int pid;		/* holder of the lock */
 68	unsigned l_offset;	/* beginning offset of the lock */
 69	unsigned l_len;		/* byte length of the lock;
 70				 * zero means through end of file */
 71};
 72
 73/*
 74 * lock holder identifier
 75 */
 76struct klm_holder {
 77	bool exclusive;		/* FALSE if shared lock */
 78	int svid;		/* holder of the lock (pid) */
 79	unsigned l_offset;	/* beginning offset of the lock */
 80	unsigned l_len;		/* byte length of the lock;
 81				 * zero means through end of file */
 82};
 83
 84/*
 85 * reply to KLM_LOCK / KLM_UNLOCK / KLM_CANCEL
 86 */
 87struct klm_stat {
 88	klm_stats stat;
 89};
 90
 91/*
 92 * reply to a KLM_TEST call
 93 */
 94union klm_testrply switch (klm_stats stat) {
 95	case klm_denied:
 96		struct klm_holder holder;
 97	default: /* All other cases return no arguments */
 98		void;
 99};
100
101
102/*
103 * arguments to KLM_LOCK
104 */
105struct klm_lockargs {
106	bool block;
107	bool exclusive;
108	struct klm_lock alock;
109};
110
111/*
112 * arguments to KLM_TEST
113 */
114struct klm_testargs {
115	bool exclusive;
116	struct klm_lock alock;
117};
118
119/*
120 * arguments to KLM_UNLOCK
121 */
122struct klm_unlockargs {
123	struct klm_lock alock;
124};
125
126program KLM_PROG {
127	version KLM_VERS {
128
129		klm_testrply	KLM_TEST (struct klm_testargs) =	1;
130
131		klm_stat	KLM_LOCK (struct klm_lockargs) =	2;
132
133		klm_stat	KLM_CANCEL (struct klm_lockargs) =	3;
134		/* klm_granted=> the cancel request fails due to lock is already granted */
135		/* klm_denied=> the cancel request successfully aborts
136lock request  */
137
138		klm_stat	KLM_UNLOCK (struct klm_unlockargs) =	4;
139	} = 1;
140} = 100020;