klm_prot.x revision 285830
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 deamon 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%__FBSDID("$FreeBSD: releng/10.2/include/rpcsvc/klm_prot.x 272850 2014-10-09 23:05:32Z hrs $"); 48#endif 49 50const LM_MAXSTRLEN = 1024; 51 52/* 53 * lock manager status returns 54 */ 55enum klm_stats { 56 klm_granted = 0, /* lock is granted */ 57 klm_denied = 1, /* lock is denied */ 58 klm_denied_nolocks = 2, /* no lock entry available */ 59 klm_working = 3 /* lock is being processed */ 60}; 61 62/* 63 * lock manager lock identifier 64 */ 65struct klm_lock { 66 string server_name<LM_MAXSTRLEN>; 67 netobj fh; /* a counted file handle */ 68 int pid; /* holder of the lock */ 69 unsigned l_offset; /* beginning offset of the lock */ 70 unsigned l_len; /* byte length of the lock; 71 * zero means through end of file */ 72}; 73 74/* 75 * lock holder identifier 76 */ 77struct klm_holder { 78 bool exclusive; /* FALSE if shared lock */ 79 int svid; /* holder of the lock (pid) */ 80 unsigned l_offset; /* beginning offset of the lock */ 81 unsigned l_len; /* byte length of the lock; 82 * zero means through end of file */ 83}; 84 85/* 86 * reply to KLM_LOCK / KLM_UNLOCK / KLM_CANCEL 87 */ 88struct klm_stat { 89 klm_stats stat; 90}; 91 92/* 93 * reply to a KLM_TEST call 94 */ 95union klm_testrply switch (klm_stats stat) { 96 case klm_denied: 97 struct klm_holder holder; 98 default: /* All other cases return no arguments */ 99 void; 100}; 101 102 103/* 104 * arguments to KLM_LOCK 105 */ 106struct klm_lockargs { 107 bool block; 108 bool exclusive; 109 struct klm_lock alock; 110}; 111 112/* 113 * arguments to KLM_TEST 114 */ 115struct klm_testargs { 116 bool exclusive; 117 struct klm_lock alock; 118}; 119 120/* 121 * arguments to KLM_UNLOCK 122 */ 123struct klm_unlockargs { 124 struct klm_lock alock; 125}; 126 127program KLM_PROG { 128 version KLM_VERS { 129 130 klm_testrply KLM_TEST (struct klm_testargs) = 1; 131 132 klm_stat KLM_LOCK (struct klm_lockargs) = 2; 133 134 klm_stat KLM_CANCEL (struct klm_lockargs) = 3; 135 /* klm_granted=> the cancel request fails due to lock is already granted */ 136 /* klm_denied=> the cancel request successfully aborts 137lock request */ 138 139 klm_stat KLM_UNLOCK (struct klm_unlockargs) = 4; 140 } = 1; 141} = 100020; 142