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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/iconv.h>
34 #include <sys/malloc.h>
35 #include <sys/mount.h>
37 #include <sys/syslog.h>
39 #include "iconv_converter_if.h"
41 SYSCTL_DECL(_kern_iconv);
43 SYSCTL_NODE(_kern, OID_AUTO, iconv, CTLFLAG_RW, NULL, "kernel iconv interface");
45 MALLOC_DEFINE(M_ICONV, "iconv", "ICONV structures");
46 static MALLOC_DEFINE(M_ICONVDATA, "iconv_data", "ICONV data");
48 MODULE_VERSION(libiconv, 2);
50 static struct sx iconv_lock;
54 * iconv converter instance
56 struct iconv_converter {
62 struct sysctl_oid *iconv_oid_hook = &sysctl___kern_iconv;
65 * List of loaded converters
67 static TAILQ_HEAD(iconv_converter_list, iconv_converter_class)
68 iconv_converters = TAILQ_HEAD_INITIALIZER(iconv_converters);
71 * List of supported/loaded charsets pairs
73 static TAILQ_HEAD(, iconv_cspair)
74 iconv_cslist = TAILQ_HEAD_INITIALIZER(iconv_cslist);
75 static int iconv_csid = 1;
77 static char iconv_unicode_string[] = "unicode"; /* save eight bytes when possible */
79 static void iconv_unregister_cspair(struct iconv_cspair *csp);
82 iconv_mod_unload(void)
84 struct iconv_cspair *csp;
86 sx_xlock(&iconv_lock);
87 while ((csp = TAILQ_FIRST(&iconv_cslist)) != NULL) {
92 while ((csp = TAILQ_FIRST(&iconv_cslist)) != NULL)
93 iconv_unregister_cspair(csp);
94 sx_xunlock(&iconv_lock);
95 sx_destroy(&iconv_lock);
100 iconv_mod_handler(module_t mod, int type, void *data)
107 sx_init(&iconv_lock, "iconv");
110 error = iconv_mod_unload();
118 static moduledata_t iconv_mod = {
119 "iconv", iconv_mod_handler, NULL
122 DECLARE_MODULE(iconv, iconv_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND);
125 iconv_register_converter(struct iconv_converter_class *dcp)
127 kobj_class_compile((struct kobj_class*)dcp);
129 TAILQ_INSERT_TAIL(&iconv_converters, dcp, cc_link);
134 iconv_unregister_converter(struct iconv_converter_class *dcp)
137 ICDEBUG("converter have %d referenses left\n", dcp->refs);
140 TAILQ_REMOVE(&iconv_converters, dcp, cc_link);
141 kobj_class_free((struct kobj_class*)dcp);
146 iconv_lookupconv(const char *name, struct iconv_converter_class **dcpp)
148 struct iconv_converter_class *dcp;
150 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
153 if (strcmp(name, ICONV_CONVERTER_NAME(dcp)) == 0) {
163 iconv_lookupcs(const char *to, const char *from, struct iconv_cspair **cspp)
165 struct iconv_cspair *csp;
167 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
168 if (strcmp(csp->cp_to, to) == 0 &&
169 strcmp(csp->cp_from, from) == 0) {
179 iconv_register_cspair(const char *to, const char *from,
180 struct iconv_converter_class *dcp, void *data,
181 struct iconv_cspair **cspp)
183 struct iconv_cspair *csp;
185 int csize, ucsto, ucsfrom;
187 if (iconv_lookupcs(to, from, NULL) == 0)
189 csize = sizeof(*csp);
190 ucsto = strcmp(to, iconv_unicode_string) == 0;
192 csize += strlen(to) + 1;
193 ucsfrom = strcmp(from, iconv_unicode_string) == 0;
195 csize += strlen(from) + 1;
196 csp = malloc(csize, M_ICONV, M_WAITOK);
198 csp->cp_id = iconv_csid++;
200 cp = (char*)(csp + 1);
204 cp += strlen(cp) + 1;
206 csp->cp_to = iconv_unicode_string;
211 csp->cp_from = iconv_unicode_string;
214 TAILQ_INSERT_TAIL(&iconv_cslist, csp, cp_link);
220 iconv_unregister_cspair(struct iconv_cspair *csp)
222 TAILQ_REMOVE(&iconv_cslist, csp, cp_link);
224 free(csp->cp_data, M_ICONVDATA);
229 * Lookup and create an instance of converter.
230 * Currently this layer didn't have associated 'instance' structure
231 * to avoid unnesessary memory allocation.
234 iconv_open(const char *to, const char *from, void **handle)
236 struct iconv_cspair *csp, *cspfrom, *cspto;
237 struct iconv_converter_class *dcp;
242 * First, lookup fully qualified cspairs
244 error = iconv_lookupcs(to, from, &csp);
246 return ICONV_CONVERTER_OPEN(csp->cp_dcp, csp, NULL, handle);
249 * Well, nothing found. Now try to construct a composite conversion
250 * ToDo: add a 'capability' field to converter
252 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
253 cnvname = ICONV_CONVERTER_NAME(dcp);
256 error = iconv_lookupcs(cnvname, from, &cspfrom);
259 error = iconv_lookupcs(to, cnvname, &cspto);
263 * Fine, we're found a pair which can be combined together
265 return ICONV_CONVERTER_OPEN(dcp, cspto, cspfrom, handle);
271 iconv_close(void *handle)
273 return ICONV_CONVERTER_CLOSE(handle);
277 iconv_conv(void *handle, const char **inbuf,
278 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
280 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, 0);
284 iconv_conv_case(void *handle, const char **inbuf,
285 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
287 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, casetype);
291 iconv_convchr(void *handle, const char **inbuf,
292 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
294 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, 0);
298 iconv_convchr_case(void *handle, const char **inbuf,
299 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
301 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, casetype);
305 towlower(int c, void *handle)
307 return ICONV_CONVERTER_TOLOWER(handle, c);
311 towupper(int c, void *handle)
313 return ICONV_CONVERTER_TOUPPER(handle, c);
317 * Give a list of loaded converters. Each name terminated with 0.
318 * An empty string terminates the list.
321 iconv_sysctl_drvlist(SYSCTL_HANDLER_ARGS)
323 struct iconv_converter_class *dcp;
329 sx_slock(&iconv_lock);
330 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
331 name = ICONV_CONVERTER_NAME(dcp);
334 error = SYSCTL_OUT(req, name, strlen(name) + 1);
338 sx_sunlock(&iconv_lock);
342 error = SYSCTL_OUT(req, &spc, sizeof(spc));
346 SYSCTL_PROC(_kern_iconv, OID_AUTO, drvlist, CTLFLAG_RD | CTLTYPE_OPAQUE,
347 NULL, 0, iconv_sysctl_drvlist, "S,xlat", "registered converters");
350 * List all available charset pairs.
353 iconv_sysctl_cslist(SYSCTL_HANDLER_ARGS)
355 struct iconv_cspair *csp;
356 struct iconv_cspair_info csi;
360 bzero(&csi, sizeof(csi));
361 csi.cs_version = ICONV_CSPAIR_INFO_VER;
362 sx_slock(&iconv_lock);
363 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
364 csi.cs_id = csp->cp_id;
365 csi.cs_refcount = csp->cp_refcount;
366 csi.cs_base = csp->cp_base ? csp->cp_base->cp_id : 0;
367 strcpy(csi.cs_to, csp->cp_to);
368 strcpy(csi.cs_from, csp->cp_from);
369 error = SYSCTL_OUT(req, &csi, sizeof(csi));
373 sx_sunlock(&iconv_lock);
377 SYSCTL_PROC(_kern_iconv, OID_AUTO, cslist, CTLFLAG_RD | CTLTYPE_OPAQUE,
378 NULL, 0, iconv_sysctl_cslist, "S,xlat", "registered charset pairs");
381 iconv_add(const char *converter, const char *to, const char *from)
383 struct iconv_converter_class *dcp;
384 struct iconv_cspair *csp;
386 if (iconv_lookupconv(converter, &dcp) != 0)
389 return iconv_register_cspair(to, from, dcp, NULL, &csp);
393 * Add new charset pair
396 iconv_sysctl_add(SYSCTL_HANDLER_ARGS)
398 struct iconv_converter_class *dcp;
399 struct iconv_cspair *csp;
400 struct iconv_add_in din;
401 struct iconv_add_out dout;
404 error = SYSCTL_IN(req, &din, sizeof(din));
407 if (din.ia_version != ICONV_ADD_VER)
409 if (din.ia_datalen > ICONV_CSMAXDATALEN)
411 if (strlen(din.ia_from) >= ICONV_CSNMAXLEN)
413 if (strlen(din.ia_to) >= ICONV_CSNMAXLEN)
415 if (strlen(din.ia_converter) >= ICONV_CNVNMAXLEN)
417 if (iconv_lookupconv(din.ia_converter, &dcp) != 0)
419 sx_xlock(&iconv_lock);
420 error = iconv_register_cspair(din.ia_to, din.ia_from, dcp, NULL, &csp);
422 sx_xunlock(&iconv_lock);
425 if (din.ia_datalen) {
426 csp->cp_data = malloc(din.ia_datalen, M_ICONVDATA, M_WAITOK);
427 error = copyin(din.ia_data, csp->cp_data, din.ia_datalen);
431 dout.ia_csid = csp->cp_id;
432 error = SYSCTL_OUT(req, &dout, sizeof(dout));
435 sx_xunlock(&iconv_lock);
436 ICDEBUG("%s => %s, %d bytes\n",din.ia_from, din.ia_to, din.ia_datalen);
439 iconv_unregister_cspair(csp);
440 sx_xunlock(&iconv_lock);
444 SYSCTL_PROC(_kern_iconv, OID_AUTO, add, CTLFLAG_RW | CTLTYPE_OPAQUE,
445 NULL, 0, iconv_sysctl_add, "S,xlat", "register charset pair");
448 * Default stubs for converters
451 iconv_converter_initstub(struct iconv_converter_class *dp)
457 iconv_converter_donestub(struct iconv_converter_class *dp)
463 iconv_converter_tolowerstub(int c, void *handle)
469 iconv_converter_handler(module_t mod, int type, void *data)
471 struct iconv_converter_class *dcp = data;
476 sx_xlock(&iconv_lock);
477 error = iconv_register_converter(dcp);
479 sx_xunlock(&iconv_lock);
482 error = ICONV_CONVERTER_INIT(dcp);
484 iconv_unregister_converter(dcp);
485 sx_xunlock(&iconv_lock);
488 sx_xlock(&iconv_lock);
489 ICONV_CONVERTER_DONE(dcp);
490 error = iconv_unregister_converter(dcp);
491 sx_xunlock(&iconv_lock);
500 * Common used functions (don't use with unicode)
503 iconv_convstr(void *handle, char *dst, const char *src)
506 size_t inlen, outlen;
509 if (handle == NULL) {
513 inlen = outlen = strlen(src);
514 error = iconv_conv(handle, NULL, NULL, &p, &outlen);
517 error = iconv_conv(handle, &src, &inlen, &p, &outlen);
525 iconv_convmem(void *handle, void *dst, const void *src, int size)
529 size_t inlen, outlen;
534 if (handle == NULL) {
535 memcpy(dst, src, size);
538 inlen = outlen = size;
539 error = iconv_conv(handle, NULL, NULL, &d, &outlen);
542 error = iconv_conv(handle, &s, &inlen, &d, &outlen);
549 iconv_lookupcp(char **cpp, const char *s)
552 ICDEBUG("warning a NULL list passed\n", ""); /* XXX ISO variadic macros cannot
558 if (strcmp(*cpp, s) == 0)
564 * Return if fsname is in use of not
567 iconv_vfs_refcount(const char *fsname)
569 struct vfsconf *vfsp;
571 vfsp = vfs_byname(fsname);
572 if (vfsp != NULL && vfsp->vfc_refcount > 0)