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**      cnxfer.h
82**
83**  FACILITY:
84**
85**      Remote Procedure Call (RPC)
86**
87**  ABSTRACT:
88**
89**  Definitions of entrypoints to support buffered data transfer
90**  within the Connection-oriented protocol services component of
91**  the RPC runtime.
92**
93**
94*/
95
96#ifndef _CNXFER_H
97#define _CNXFER_H	1
98
99/***********************************************************************/
100/*
101 * rpc_c_cn_bcopy_lim determines the maximum byte count which we
102 * will copy instead of allocating an I/O vector element.  i.e., if
103 * the stub data contains less than or equal to rpc_c_cn_bcopy_lim,
104 * then the data will be copied to an internal buffer.
105 */
106#define RPC_C_CN_BCOPY_LIM 200
107
108/***********************************************************************/
109/*
110 * R P C _ _ C N _ C O P Y _ B U F F E R
111 *
112 */
113
114PRIVATE void rpc__cn_copy_buffer (
115        rpc_cn_call_rep_p_t /* call_rep */,
116        rpc_iovector_elt_p_t /* iov_elt_p */,
117        unsigned32     * /* status */
118    );
119
120/***********************************************************************/
121/*
122 * R P C _ _ C N _ T R A N S M I T _ B U F F E R S
123 *
124 */
125
126PRIVATE void rpc__cn_transmit_buffers (
127        rpc_cn_call_rep_p_t /* call_rep */,
128        unsigned32     */* status */
129    );
130
131#if 0
132/***********************************************************************/
133/*
134 * R P C _ _ C N _ F L U S H _ B U F F E R S
135 *
136 */
137
138PRIVATE void rpc__cn_flush_buffers (
139        rpc_cn_call_rep_p_t /* call_rep */,
140        unsigned32     */* status */
141    );
142#endif /* 0 */
143
144/***********************************************************************/
145/*
146 * R P C _ _ C N _ A D D _ N E W _ I O V E C T O R _ E L M T
147 *
148 */
149
150PRIVATE void rpc__cn_add_new_iovector_elmt (
151        rpc_cn_call_rep_p_t /* call_rep */,
152        rpc_iovector_elt_p_t /* iov_elt_p */,
153        unsigned32     */* status */
154        );
155
156/***********************************************************************/
157/*
158 * R P C _ _ C N _ D E A L L O C _ B U F F E R E D _ D A T A
159 *
160 */
161
162PRIVATE void rpc__cn_dealloc_buffered_data (
163     rpc_cn_call_rep_p_t /*call_rep*/
164    );
165
166/***********************************************************************/
167/*
168 * R P C _ _ C N _ G E T _ A L L O C _ H I N T
169 *
170 */
171
172PRIVATE unsigned32 rpc__cn_get_alloc_hint (
173    rpc_iovector_p_t /* stub_data_p */
174    );
175
176
177/*
178 * Macro to fix up the iovector in the call_rep so that we have
179 * only the cached protocol header (and no stub data).
180 */
181#define RPC_CN_FREE_ALL_EXCEPT_PROT_HDR(call_rep) \
182{\
183    RPC_CN_CREP_IOVLEN (call_rep) = 1; \
184    RPC_CN_CREP_CUR_IOV_INDX (call_rep) = 0; \
185    RPC_CN_CREP_ACC_BYTCNT (call_rep) = RPC_CN_CREP_SIZEOF_HDR (call_rep); \
186    RPC_CN_CREP_FREE_BYTES (call_rep) = \
187        RPC_C_CN_SMALL_FRAG_SIZE - RPC_CN_CREP_SIZEOF_HDR (call_rep); \
188    RPC_CN_CREP_FREE_BYTE_PTR (call_rep) = \
189        (byte_p_t) RPC_CN_CREP_IOV(call_rep)[0].data_addr; \
190    RPC_CN_CREP_FREE_BYTE_PTR (call_rep) += RPC_CN_CREP_SIZEOF_HDR (call_rep); \
191    RPC_CN_CREP_IOV(call_rep)[0].data_len = RPC_CN_CREP_SIZEOF_HDR (call_rep);\
192    if ((call_rep)->sec != NULL)\
193    {\
194        RPC_CN_CREP_FREE_BYTE_PTR (call_rep) -= call_rep->prot_tlr->data_size; \
195        RPC_CN_CREP_IOVLEN (call_rep)++;\
196    }\
197}
198#endif /* _CNXFER_H */
199