1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2000-2001 Boris Popov
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28#ifndef _SYS_ICONV_H_
29#define _SYS_ICONV_H_
30
31#define ICONV_CSNMAXLEN 31 /* maximum length of charset name */
32#define ICONV_CNVNMAXLEN 31 /* maximum length of converter name */
33/* maximum size of data associated with cs pair */
34#define ICONV_CSMAXDATALEN (sizeof(caddr_t) * 0x200 + sizeof(uint32_t) * 0x200 * 0x80)
35
36#define XLAT16_ACCEPT_NULL_OUT 0x01000000
37#define XLAT16_ACCEPT_NULL_IN 0x02000000
38#define XLAT16_HAS_LOWER_CASE 0x04000000
39#define XLAT16_HAS_UPPER_CASE 0x08000000
40#define XLAT16_HAS_FROM_LOWER_CASE 0x10000000
41#define XLAT16_HAS_FROM_UPPER_CASE 0x20000000
42#define XLAT16_IS_3BYTE_CHR 0x40000000
43
44#define KICONV_LOWER 1 /* tolower converted character */
45#define KICONV_UPPER 2 /* toupper converted character */
46#define KICONV_FROM_LOWER 4 /* tolower source character, then convert */
47#define KICONV_FROM_UPPER 8 /* toupper source character, then convert */
48#define KICONV_WCTYPE 16 /* towlower/towupper characters */
49
50#define ENCODING_UNICODE "UTF-16BE"
51#define KICONV_WCTYPE_NAME "_wctype"
52
53/*
54 * Entry for cslist sysctl
55 */
56#define ICONV_CSPAIR_INFO_VER 1
57
58struct iconv_cspair_info {
59 int cs_version;
60 int cs_id;
61 int cs_base;
62 int cs_refcount;
63 char cs_to[ICONV_CSNMAXLEN];
64 char cs_from[ICONV_CSNMAXLEN];
65};
66
67/*
68 * Parameters for 'add' sysctl
69 */
70#define ICONV_ADD_VER 1
71
72struct iconv_add_in {
73 int ia_version;
74 char ia_converter[ICONV_CNVNMAXLEN];
75 char ia_to[ICONV_CSNMAXLEN];
76 char ia_from[ICONV_CSNMAXLEN];
77 int ia_datalen;
78 const void *ia_data;
79};
80
81struct iconv_add_out {
82 int ia_csid;
83};
84
85#ifndef _KERNEL
86
87__BEGIN_DECLS
88
89#define KICONV_VENDOR_MICSFT 1 /* Microsoft Vendor Code for quirk */
90
91int kiconv_add_xlat_table(const char *, const char *, const u_char *);
92int kiconv_add_xlat16_cspair(const char *, const char *, int);
93int kiconv_add_xlat16_cspairs(const char *, const char *);
94int kiconv_add_xlat16_table(const char *, const char *, const void *, int);
95int kiconv_lookupconv(const char *drvname);
96int kiconv_lookupcs(const char *tocode, const char *fromcode);
97const char *kiconv_quirkcs(const char *, int);
98
99__END_DECLS
100
101#else /* !_KERNEL */
102
103#include <sys/kobj.h>
104#include <sys/module.h> /* can't avoid that */
105#include <sys/queue.h> /* can't avoid that */
106#include <sys/sysctl.h> /* can't avoid that */
107
108struct iconv_cspair;
109struct iconv_cspairdata;
110
111/*
112 * iconv converter class definition
113 */
114struct iconv_converter_class {
115 KOBJ_CLASS_FIELDS;
116 TAILQ_ENTRY(iconv_converter_class) cc_link;
117};
118
119struct iconv_cspair {
120 int cp_id; /* unique id of charset pair */
121 int cp_refcount; /* number of references from other pairs */
122 const char * cp_from;
123 const char * cp_to;
124 void * cp_data;
125 struct iconv_converter_class * cp_dcp;
126 struct iconv_cspair *cp_base;
127 TAILQ_ENTRY(iconv_cspair) cp_link;
128};
129
130#define KICONV_CONVERTER(name,size) \
131 static struct iconv_converter_class iconv_ ## name ## _class = { \
132 "iconv_"#name, iconv_ ## name ## _methods, size, NULL \
133 }; \
134 static moduledata_t iconv_ ## name ## _mod = { \
135 "iconv_"#name, iconv_converter_handler, \
136 (void*)&iconv_ ## name ## _class \
137 }; \
138 DECLARE_MODULE(iconv_ ## name, iconv_ ## name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
139
140#define KICONV_CES(name,size) \
141 static DEFINE_CLASS(iconv_ces_ ## name, iconv_ces_ ## name ## _methods, (size)); \
142 static moduledata_t iconv_ces_ ## name ## _mod = { \
143 "iconv_ces_"#name, iconv_cesmod_handler, \
144 (void*)&iconv_ces_ ## name ## _class \
145 }; \
146 DECLARE_MODULE(iconv_ces_ ## name, iconv_ces_ ## name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
147
148#ifdef MALLOC_DECLARE
149MALLOC_DECLARE(M_ICONV);
150#endif
151
152/*
153 * Basic conversion functions
154 */
155int iconv_open(const char *to, const char *from, void **handle);
156int iconv_close(void *handle);
157int iconv_conv(void *handle, const char **inbuf,
158 size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
159int iconv_conv_case(void *handle, const char **inbuf,
160 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype);
161int iconv_convchr(void *handle, const char **inbuf,
162 size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
163int iconv_convchr_case(void *handle, const char **inbuf,
164 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype);
165int iconv_add(const char *converter, const char *to, const char *from);
166char* iconv_convstr(void *handle, char *dst, const char *src);
167void* iconv_convmem(void *handle, void *dst, const void *src, int size);
168int iconv_vfs_refcount(const char *fsname);
169
170int towlower(int c, void *handle);
171int towupper(int c, void *handle);
172
173/*
174 * Bridge struct of iconv functions
175 */
176struct iconv_functions {
177 int (*open)(const char *to, const char *from, void **handle);
178 int (*close)(void *handle);
179 int (*conv)(void *handle, const char **inbuf, size_t *inbytesleft,
180 char **outbuf, size_t *outbytesleft);
181 int (*conv_case)(void *handle, const char **inbuf, size_t *inbytesleft,
182 char **outbuf, size_t *outbytesleft, int casetype);
183 int (*convchr)(void *handle, const char **inbuf, size_t *inbytesleft,
184 char **outbuf, size_t *outbytesleft);
185 int (*convchr_case)(void *handle, const char **inbuf, size_t *inbytesleft,
186 char **outbuf, size_t *outbytesleft, int casetype);
187};
188
189#define VFS_DECLARE_ICONV(fsname) \
190 static struct iconv_functions fsname ## _iconv_core = { \
191 iconv_open, \
192 iconv_close, \
193 iconv_conv, \
194 iconv_conv_case, \
195 iconv_convchr, \
196 iconv_convchr_case \
197 }; \
198 extern struct iconv_functions *fsname ## _iconv; \
199 static int fsname ## _iconv_mod_handler(module_t mod, \
200 int type, void *d); \
201 static int \
202 fsname ## _iconv_mod_handler(module_t mod, int type, void *d) \
203 { \
204 int error = 0; \
205 switch(type) { \
206 case MOD_LOAD: \
207 fsname ## _iconv = & fsname ## _iconv_core; \
208 break; \
209 case MOD_UNLOAD: \
210 error = iconv_vfs_refcount(#fsname); \
211 if (error) \
212 return (EBUSY); \
213 fsname ## _iconv = NULL; \
214 break; \
215 default: \
216 error = EINVAL; \
217 break; \
218 } \
219 return (error); \
220 } \
221 static moduledata_t fsname ## _iconv_mod = { \
222 #fsname"_iconv", \
223 fsname ## _iconv_mod_handler, \
224 NULL \
225 }; \
226 DECLARE_MODULE(fsname ## _iconv, fsname ## _iconv_mod, \
227 SI_SUB_DRIVERS, SI_ORDER_ANY); \
228 MODULE_DEPEND(fsname ## _iconv, fsname, 1, 1, 1); \
229 MODULE_DEPEND(fsname ## _iconv, libiconv, 2, 2, 2); \
230 MODULE_VERSION(fsname ## _iconv, 1)
231
232/*
233 * Internal functions
234 */
235int iconv_lookupcp(char **cpp, const char *s);
236
237int iconv_converter_initstub(struct iconv_converter_class *dp);
238int iconv_converter_donestub(struct iconv_converter_class *dp);
239int iconv_converter_tolowerstub(int c, void *handle);
240int iconv_converter_handler(module_t mod, int type, void *data);
241
242#ifdef ICONV_DEBUG
243#define ICDEBUG(format, ...) printf("%s: "format, __func__ , ## __VA_ARGS__)
244#else
245#define ICDEBUG(format, ...)
246#endif
247
248#endif /* !_KERNEL */
249
250#endif /* !_SYS_ICONV_H_ */