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**  NAME
79**
80**      cs_s.h
81**
82**  FACILITY:
83**
84**      Remote Procedure Call (RPC)
85**
86**  ABSTRACT:
87**
88**  Data types and definitions for Code Set Interoperability extension
89**  (or Internationalization) to RPC runtime.
90**
91**
92*/
93
94#if	!defined(_CS_S_H)
95#define _CS_S_H
96
97/*
98 * ISO 10646:1992, UCS-2, Level 2
99 * Universal Code Set (encoding) for DCE
100 */
101#define UCS2_L2		0x0010101
102
103/*
104 * When rpc_ns_mgmt_*** routines are extended in the future to,
105 * deal with attributes other than code sets, the new attribute
106 * specifier needs to be added here.
107 */
108#define	RPC_EVAL_TYPE_CODESETS		0x0001
109#define	RPC_CUSTOM_EVAL_TYPE_CODESETS	0x0002
110
111/*
112 *  Tagged union identifiers.
113 *  This is used to distinguish tagged union data structure for
114 *  i18n binding handle extension.
115 */
116#define	RPC_CS_EVAL_TAGS		0
117#define RPC_CS_EVAL_METHOD		1
118
119/*
120 * Code sets interoperability connection models
121 */
122#define	RPC_EVAL_NO_CONVERSION		0x0001
123#define	RPC_EVAL_RMIR_MODEL		0x0002
124#define	RPC_EVAL_CMIR_MODEL		0x0003
125#define	RPC_EVAL_SMIR_MODEL		0x0004
126#define	RPC_EVAL_INTERMEDIATE_MODEL	0x0005
127#define	RPC_EVAL_UNIVERSAL_MODEL	0x0006
128
129/*
130 * Extension to an import context handle.  The new field 'eval_routines'
131 * in 'rpc_lkup_rep_t' will be the following data structure.
132 */
133typedef struct {
134	unsigned32		num;
135	rpc_cs_eval_list_p	list;
136} rpc_cs_eval_func_t, *rpc_cs_eval_func_p_t;
137
138/*
139 * R P C _ C S _ C O D E S E T _ I 1 4 Y _ D A T A
140 *
141 * Argument to OSF code set evaluation routine.  This data will be passed
142 * to the evaluation routine, and figure out the compatible client and server
143 * code sets combination.  The evaluation routine will be called from a client
144 * in OSF implementation, and it will not be called from a client stub.
145 *
146 * ns_name	: NSI entry name for a server
147 * cleanup	: boolean flag indicating any clean-up action required.
148 * method_p	: pointer to 'rpc_cs_method_eval_t' data.  See above.
149 * status	: result of the code set evaluation.
150 */
151typedef struct codeset_i14y_data {
152	unsigned_char_p_t	ns_name;
153	void			*args;
154	boolean32		cleanup;
155	rpc_cs_method_eval_p_t	method_p;
156	error_status_t		status;
157} rpc_cs_codeset_i14y_data, *rpc_cs_codeset_i14y_data_p;
158
159/*
160 * Internal routine to attach the code set interoperability
161 * attributes to a binding handle.  This routine is not intended
162 * to be used by application developers.  Only runtime uses it.
163 */
164extern void rpc_cs_binding_set_method (
165    /* [in, out] */ rpc_binding_handle_t *h,
166    /* [in] */ rpc_cs_method_eval_p_t method_p,
167    /* [out] */ error_status_t *status
168);
169
170/*
171 * prototype declarations for locally defined routines
172 */
173extern void stub_conversion
174    (
175	rpc_binding_handle_t	h,
176	boolean32		server_side,
177	unsigned32		from_tag,
178	unsigned32		to_tag,
179	byte_t			*conv_ldata,
180	unsigned32		conv_l_data_len,
181	byte_t			*conv_wdata,
182	unsigned32		*conv_p_w_data_len,
183	error_status_t		*status
184    );
185
186/*
187 * Well-known UUID for code set attribute
188 */
189#define rpc_c_uuid_codesets_string	"a1794860-a955-11cd-8443-08000925d3fe"
190
191extern idl_uuid_t rpc_c_attr_real_codesets;
192extern idl_uuid_t *rpc_c_attr_codesets;
193
194#endif	/* !defined(_CS_S_H) */
195