2 * Copyright (c) 2000-2001, Boris Popov
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Boris Popov.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/iconv.h>
40 #include <sys/malloc.h>
41 #include <sys/mount.h>
42 #include <sys/syslog.h>
44 #include "iconv_converter_if.h"
46 SYSCTL_DECL(_kern_iconv);
48 SYSCTL_NODE(_kern, OID_AUTO, iconv, CTLFLAG_RW, NULL, "kernel iconv interface");
50 MALLOC_DEFINE(M_ICONV, "ICONV", "ICONV structures");
51 MALLOC_DEFINE(M_ICONVDATA, "ICONV data", "ICONV data");
53 MODULE_VERSION(libiconv, 2);
57 * iconv converter instance
59 struct iconv_converter {
65 struct sysctl_oid *iconv_oid_hook = &sysctl___kern_iconv;
68 * List of loaded converters
70 static TAILQ_HEAD(iconv_converter_list, iconv_converter_class)
71 iconv_converters = TAILQ_HEAD_INITIALIZER(iconv_converters);
74 * List of supported/loaded charsets pairs
76 static TAILQ_HEAD(, iconv_cspair)
77 iconv_cslist = TAILQ_HEAD_INITIALIZER(iconv_cslist);
78 static int iconv_csid = 1;
80 static char iconv_unicode_string[] = "unicode"; /* save eight bytes when possible */
82 static void iconv_unregister_cspair(struct iconv_cspair *csp);
85 iconv_mod_unload(void)
87 struct iconv_cspair *csp;
89 while ((csp = TAILQ_FIRST(&iconv_cslist)) != NULL) {
92 iconv_unregister_cspair(csp);
98 iconv_mod_handler(module_t mod, int type, void *data)
107 error = iconv_mod_unload();
115 static moduledata_t iconv_mod = {
116 "iconv", iconv_mod_handler, NULL
119 DECLARE_MODULE(iconv, iconv_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND);
122 iconv_register_converter(struct iconv_converter_class *dcp)
124 kobj_class_compile((struct kobj_class*)dcp);
126 TAILQ_INSERT_TAIL(&iconv_converters, dcp, cc_link);
131 iconv_unregister_converter(struct iconv_converter_class *dcp)
134 ICDEBUG("converter have %d referenses left\n", dcp->refs);
137 TAILQ_REMOVE(&iconv_converters, dcp, cc_link);
138 kobj_class_free((struct kobj_class*)dcp);
143 iconv_lookupconv(const char *name, struct iconv_converter_class **dcpp)
145 struct iconv_converter_class *dcp;
147 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
150 if (strcmp(name, ICONV_CONVERTER_NAME(dcp)) == 0) {
160 iconv_lookupcs(const char *to, const char *from, struct iconv_cspair **cspp)
162 struct iconv_cspair *csp;
164 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
165 if (strcmp(csp->cp_to, to) == 0 &&
166 strcmp(csp->cp_from, from) == 0) {
176 iconv_register_cspair(const char *to, const char *from,
177 struct iconv_converter_class *dcp, void *data,
178 struct iconv_cspair **cspp)
180 struct iconv_cspair *csp;
182 int csize, ucsto, ucsfrom;
184 if (iconv_lookupcs(to, from, NULL) == 0)
186 csize = sizeof(*csp);
187 ucsto = strcmp(to, iconv_unicode_string) == 0;
189 csize += strlen(to) + 1;
190 ucsfrom = strcmp(from, iconv_unicode_string) == 0;
192 csize += strlen(from) + 1;
193 csp = malloc(csize, M_ICONV, M_WAITOK);
195 csp->cp_id = iconv_csid++;
197 cp = (char*)(csp + 1);
201 cp += strlen(cp) + 1;
203 csp->cp_to = iconv_unicode_string;
208 csp->cp_from = iconv_unicode_string;
211 TAILQ_INSERT_TAIL(&iconv_cslist, csp, cp_link);
217 iconv_unregister_cspair(struct iconv_cspair *csp)
219 TAILQ_REMOVE(&iconv_cslist, csp, cp_link);
221 free(csp->cp_data, M_ICONVDATA);
226 * Lookup and create an instance of converter.
227 * Currently this layer didn't have associated 'instance' structure
228 * to avoid unnesessary memory allocation.
231 iconv_open(const char *to, const char *from, void **handle)
233 struct iconv_cspair *csp, *cspfrom, *cspto;
234 struct iconv_converter_class *dcp;
239 * First, lookup fully qualified cspairs
241 error = iconv_lookupcs(to, from, &csp);
243 return ICONV_CONVERTER_OPEN(csp->cp_dcp, csp, NULL, handle);
246 * Well, nothing found. Now try to construct a composite conversion
247 * ToDo: add a 'capability' field to converter
249 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
250 cnvname = ICONV_CONVERTER_NAME(dcp);
253 error = iconv_lookupcs(cnvname, from, &cspfrom);
256 error = iconv_lookupcs(to, cnvname, &cspto);
260 * Fine, we're found a pair which can be combined together
262 return ICONV_CONVERTER_OPEN(dcp, cspto, cspfrom, handle);
268 iconv_close(void *handle)
270 return ICONV_CONVERTER_CLOSE(handle);
274 iconv_conv(void *handle, const char **inbuf,
275 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
277 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, 0);
281 iconv_conv_case(void *handle, const char **inbuf,
282 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
284 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, casetype);
288 iconv_convchr(void *handle, const char **inbuf,
289 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
291 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, 0);
295 iconv_convchr_case(void *handle, const char **inbuf,
296 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
298 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, casetype);
302 * Give a list of loaded converters. Each name terminated with 0.
303 * An empty string terminates the list.
306 iconv_sysctl_drvlist(SYSCTL_HANDLER_ARGS)
308 struct iconv_converter_class *dcp;
315 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
316 name = ICONV_CONVERTER_NAME(dcp);
319 error = SYSCTL_OUT(req, name, strlen(name) + 1);
326 error = SYSCTL_OUT(req, &spc, sizeof(spc));
330 SYSCTL_PROC(_kern_iconv, OID_AUTO, drvlist, CTLFLAG_RD | CTLTYPE_OPAQUE,
331 NULL, 0, iconv_sysctl_drvlist, "S,xlat", "registered converters");
334 * List all available charset pairs.
337 iconv_sysctl_cslist(SYSCTL_HANDLER_ARGS)
339 struct iconv_cspair *csp;
340 struct iconv_cspair_info csi;
344 bzero(&csi, sizeof(csi));
345 csi.cs_version = ICONV_CSPAIR_INFO_VER;
347 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
348 csi.cs_id = csp->cp_id;
349 csi.cs_refcount = csp->cp_refcount;
350 csi.cs_base = csp->cp_base ? csp->cp_base->cp_id : 0;
351 strcpy(csi.cs_to, csp->cp_to);
352 strcpy(csi.cs_from, csp->cp_from);
353 error = SYSCTL_OUT(req, &csi, sizeof(csi));
360 SYSCTL_PROC(_kern_iconv, OID_AUTO, cslist, CTLFLAG_RD | CTLTYPE_OPAQUE,
361 NULL, 0, iconv_sysctl_cslist, "S,xlat", "registered charset pairs");
364 * Add new charset pair
367 iconv_sysctl_add(SYSCTL_HANDLER_ARGS)
369 struct iconv_converter_class *dcp;
370 struct iconv_cspair *csp;
371 struct iconv_add_in din;
372 struct iconv_add_out dout;
375 error = SYSCTL_IN(req, &din, sizeof(din));
378 if (din.ia_version != ICONV_ADD_VER)
380 if (din.ia_datalen > ICONV_CSMAXDATALEN)
382 if (iconv_lookupconv(din.ia_converter, &dcp) != 0)
384 error = iconv_register_cspair(din.ia_to, din.ia_from, dcp, NULL, &csp);
387 if (din.ia_datalen) {
388 csp->cp_data = malloc(din.ia_datalen, M_ICONVDATA, M_WAITOK);
389 error = copyin(din.ia_data, csp->cp_data, din.ia_datalen);
393 dout.ia_csid = csp->cp_id;
394 error = SYSCTL_OUT(req, &dout, sizeof(dout));
397 ICDEBUG("%s => %s, %d bytes\n",din.ia_from, din.ia_to, din.ia_datalen);
400 iconv_unregister_cspair(csp);
404 SYSCTL_PROC(_kern_iconv, OID_AUTO, add, CTLFLAG_RW | CTLTYPE_OPAQUE,
405 NULL, 0, iconv_sysctl_add, "S,xlat", "register charset pair");
408 * Default stubs for converters
411 iconv_converter_initstub(struct iconv_converter_class *dp)
417 iconv_converter_donestub(struct iconv_converter_class *dp)
423 iconv_converter_handler(module_t mod, int type, void *data)
425 struct iconv_converter_class *dcp = data;
430 error = iconv_register_converter(dcp);
433 error = ICONV_CONVERTER_INIT(dcp);
435 iconv_unregister_converter(dcp);
438 ICONV_CONVERTER_DONE(dcp);
439 error = iconv_unregister_converter(dcp);
448 * Common used functions (don't use with unicode)
451 iconv_convstr(void *handle, char *dst, const char *src)
454 size_t inlen, outlen;
457 if (handle == NULL) {
463 error = iconv_conv(handle, NULL, NULL, &p, &outlen);
466 error = iconv_conv(handle, &src, &inlen, &p, &outlen);
474 iconv_convmem(void *handle, void *dst, const void *src, int size)
478 size_t inlen, outlen;
483 if (handle == NULL) {
484 memcpy(dst, src, size);
489 error = iconv_conv(handle, NULL, NULL, &d, &outlen);
492 error = iconv_conv(handle, &s, &inlen, &d, &outlen);
499 iconv_lookupcp(char **cpp, const char *s)
502 ICDEBUG("warning a NULL list passed\n", ""); /* XXX ISO variadic macros cannot
508 if (strcmp(*cpp, s) == 0)
514 * Return if fsname is in use of not
517 iconv_vfs_refcount(const char *fsname)
519 struct vfsconf *vfsp;
521 for (vfsp = vfsconf; vfsp; vfsp = vfsp->vfc_next) {
522 if (!strcmp(vfsp->vfc_name, fsname)) {
523 if (vfsp->vfc_refcount > 0)