1/*
2 * Copyright (c) 2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of its
16 *     contributors may be used to endorse or promote products derived from
17 *     this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * Portions of this software have been released under the following terms:
31 *
32 * (c) Copyright 1989-1993 OPEN SOFTWARE FOUNDATION, INC.
33 * (c) Copyright 1989-1993 HEWLETT-PACKARD COMPANY
34 * (c) Copyright 1989-1993 DIGITAL EQUIPMENT CORPORATION
35 *
36 * To anyone who acknowledges that this file is provided "AS IS"
37 * without any express or implied warranty:
38 * permission to use, copy, modify, and distribute this file for any
39 * purpose is hereby granted without fee, provided that the above
40 * copyright notices and this notice appears in all source code copies,
41 * and that none of the names of Open Software Foundation, Inc., Hewlett-
42 * Packard Company or Digital Equipment Corporation be used
43 * in advertising or publicity pertaining to distribution of the software
44 * without specific, written prior permission.  Neither Open Software
45 * Foundation, Inc., Hewlett-Packard Company nor Digital
46 * Equipment Corporation makes any representations about the suitability
47 * of this software for any purpose.
48 *
49 * Copyright (c) 2007, Novell, Inc. All rights reserved.
50 * Redistribution and use in source and binary forms, with or without
51 * modification, are permitted provided that the following conditions
52 * are met:
53 *
54 * 1.  Redistributions of source code must retain the above copyright
55 *     notice, this list of conditions and the following disclaimer.
56 * 2.  Redistributions in binary form must reproduce the above copyright
57 *     notice, this list of conditions and the following disclaimer in the
58 *     documentation and/or other materials provided with the distribution.
59 * 3.  Neither the name of Novell Inc. nor the names of its contributors
60 *     may be used to endorse or promote products derived from this
61 *     this software without specific prior written permission.
62 *
63 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
64 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
65 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
66 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
69 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
70 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
71 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
72 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73 *
74 * @APPLE_LICENSE_HEADER_END@
75 */
76
77/*
78**
79**  NAME:
80**
81**      dgxq.h
82**
83**  FACILITY:
84**
85**      Remote Procedure Call (RPC)
86**
87**  ABSTRACT:
88**
89**  DG protocol service routines
90**
91**
92*/
93
94#ifndef _DGXQ_H
95#define _DGXQ_H
96
97/*
98 * R P C _ D G _ X M I T Q _ R E I N I T
99 *
100 * Reinitialize a transmit queue.
101 */
102
103#define RPC_DG_XMITQ_REINIT(xq, call) { \
104    if ((xq)->head != NULL) rpc__dg_xmitq_free(xq, call); \
105    rpc__dg_xmitq_reinit(xq); \
106}
107
108/*
109 * R P C _ D G _ X M I T Q _ A W A I T I N G _ A C K _ S E T
110 *
111 * Mark a transmit queue as wanting an acknowledgement event (fack, response,
112 * working, etc.)
113 */
114
115#define RPC_DG_XMITQ_AWAITING_ACK_SET(xq) ( \
116    (xq)->awaiting_ack = true, \
117    xq->awaiting_ack_timestamp = rpc__clock_stamp() \
118)
119
120/*
121 * R P C _ D G _ X M I T Q _ A W A I T I N G _ A C K _ C L R
122 *
123 * Mark a transmit queue as no longer wanting an acknowledgement event.
124 */
125
126#define RPC_DG_XMITQ_AWAITING_ACK_CLR(xq) ( \
127    (xq)->awaiting_ack = false \
128)
129
130PRIVATE void rpc__dg_xmitq_elt_xmit (
131        rpc_dg_xmitq_elt_p_t  /*xqe*/,
132        rpc_dg_call_p_t  /*call*/,
133        boolean32  /*block*/
134    );
135
136PRIVATE void rpc__dg_xmitq_init (
137        rpc_dg_xmitq_p_t  /*xq*/
138    );
139
140PRIVATE void rpc__dg_xmitq_reinit (
141        rpc_dg_xmitq_p_t  /*xq*/
142    );
143
144PRIVATE void rpc__dg_xmitq_free (
145        rpc_dg_xmitq_p_t  /*xq*/,
146        rpc_dg_call_p_t  /*call*/
147    );
148
149PRIVATE void rpc__dg_xmitq_append_pp (
150        rpc_dg_call_p_t  /*call*/,
151        unsigned32 * /*st*/
152    );
153
154PRIVATE boolean rpc__dg_xmitq_awaiting_ack_tmo (
155        rpc_dg_xmitq_p_t  /*xq*/,
156        unsigned32  /*com_timeout_knob*/
157    );
158
159PRIVATE void rpc__dg_xmitq_restart (
160        rpc_dg_call_p_t  /*call*/
161    );
162
163#endif /* _DGXQ_H */
164