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>
43 #include <sys/syslog.h>
45 #include "iconv_converter_if.h"
47 SYSCTL_DECL(_kern_iconv);
49 SYSCTL_NODE(_kern, OID_AUTO, iconv, CTLFLAG_RW, NULL, "kernel iconv interface");
51 MALLOC_DEFINE(M_ICONV, "iconv", "ICONV structures");
52 MALLOC_DEFINE(M_ICONVDATA, "iconv_data", "ICONV data");
54 MODULE_VERSION(libiconv, 2);
56 static struct sx iconv_lock;
60 * iconv converter instance
62 struct iconv_converter {
68 struct sysctl_oid *iconv_oid_hook = &sysctl___kern_iconv;
71 * List of loaded converters
73 static TAILQ_HEAD(iconv_converter_list, iconv_converter_class)
74 iconv_converters = TAILQ_HEAD_INITIALIZER(iconv_converters);
77 * List of supported/loaded charsets pairs
79 static TAILQ_HEAD(, iconv_cspair)
80 iconv_cslist = TAILQ_HEAD_INITIALIZER(iconv_cslist);
81 static int iconv_csid = 1;
83 static char iconv_unicode_string[] = "unicode"; /* save eight bytes when possible */
85 static void iconv_unregister_cspair(struct iconv_cspair *csp);
88 iconv_mod_unload(void)
90 struct iconv_cspair *csp;
92 sx_xlock(&iconv_lock);
93 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
94 if (csp->cp_refcount) {
95 sx_xunlock(&iconv_lock);
100 while ((csp = TAILQ_FIRST(&iconv_cslist)) != NULL)
101 iconv_unregister_cspair(csp);
102 sx_xunlock(&iconv_lock);
103 sx_destroy(&iconv_lock);
108 iconv_mod_handler(module_t mod, int type, void *data)
115 sx_init(&iconv_lock, "iconv");
118 error = iconv_mod_unload();
126 static moduledata_t iconv_mod = {
127 "iconv", iconv_mod_handler, NULL
130 DECLARE_MODULE(iconv, iconv_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND);
133 iconv_register_converter(struct iconv_converter_class *dcp)
135 kobj_class_compile((struct kobj_class*)dcp);
137 TAILQ_INSERT_TAIL(&iconv_converters, dcp, cc_link);
142 iconv_unregister_converter(struct iconv_converter_class *dcp)
145 ICDEBUG("converter have %d referenses left\n", dcp->refs);
148 TAILQ_REMOVE(&iconv_converters, dcp, cc_link);
149 kobj_class_free((struct kobj_class*)dcp);
154 iconv_lookupconv(const char *name, struct iconv_converter_class **dcpp)
156 struct iconv_converter_class *dcp;
158 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
161 if (strcmp(name, ICONV_CONVERTER_NAME(dcp)) == 0) {
171 iconv_lookupcs(const char *to, const char *from, struct iconv_cspair **cspp)
173 struct iconv_cspair *csp;
175 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
176 if (strcmp(csp->cp_to, to) == 0 &&
177 strcmp(csp->cp_from, from) == 0) {
187 iconv_register_cspair(const char *to, const char *from,
188 struct iconv_converter_class *dcp, void *data,
189 struct iconv_cspair **cspp)
191 struct iconv_cspair *csp;
193 int csize, ucsto, ucsfrom;
195 if (iconv_lookupcs(to, from, NULL) == 0)
197 csize = sizeof(*csp);
198 ucsto = strcmp(to, iconv_unicode_string) == 0;
200 csize += strlen(to) + 1;
201 ucsfrom = strcmp(from, iconv_unicode_string) == 0;
203 csize += strlen(from) + 1;
204 csp = malloc(csize, M_ICONV, M_WAITOK);
206 csp->cp_id = iconv_csid++;
208 cp = (char*)(csp + 1);
212 cp += strlen(cp) + 1;
214 csp->cp_to = iconv_unicode_string;
219 csp->cp_from = iconv_unicode_string;
222 TAILQ_INSERT_TAIL(&iconv_cslist, csp, cp_link);
228 iconv_unregister_cspair(struct iconv_cspair *csp)
230 TAILQ_REMOVE(&iconv_cslist, csp, cp_link);
232 free(csp->cp_data, M_ICONVDATA);
237 * Lookup and create an instance of converter.
238 * Currently this layer didn't have associated 'instance' structure
239 * to avoid unnesessary memory allocation.
242 iconv_open(const char *to, const char *from, void **handle)
244 struct iconv_cspair *csp, *cspfrom, *cspto;
245 struct iconv_converter_class *dcp;
250 * First, lookup fully qualified cspairs
252 error = iconv_lookupcs(to, from, &csp);
254 return ICONV_CONVERTER_OPEN(csp->cp_dcp, csp, NULL, handle);
257 * Well, nothing found. Now try to construct a composite conversion
258 * ToDo: add a 'capability' field to converter
260 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
261 cnvname = ICONV_CONVERTER_NAME(dcp);
264 error = iconv_lookupcs(cnvname, from, &cspfrom);
267 error = iconv_lookupcs(to, cnvname, &cspto);
271 * Fine, we're found a pair which can be combined together
273 return ICONV_CONVERTER_OPEN(dcp, cspto, cspfrom, handle);
279 iconv_close(void *handle)
281 return ICONV_CONVERTER_CLOSE(handle);
285 iconv_conv(void *handle, const char **inbuf,
286 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
288 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, 0);
292 iconv_conv_case(void *handle, const char **inbuf,
293 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
295 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, casetype);
299 iconv_convchr(void *handle, const char **inbuf,
300 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
302 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, 0);
306 iconv_convchr_case(void *handle, const char **inbuf,
307 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
309 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, casetype);
313 towlower(int c, void *handle)
315 return ICONV_CONVERTER_TOLOWER(handle, c);
319 towupper(int c, void *handle)
321 return ICONV_CONVERTER_TOUPPER(handle, c);
325 * Give a list of loaded converters. Each name terminated with 0.
326 * An empty string terminates the list.
329 iconv_sysctl_drvlist(SYSCTL_HANDLER_ARGS)
331 struct iconv_converter_class *dcp;
337 sx_slock(&iconv_lock);
338 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
339 name = ICONV_CONVERTER_NAME(dcp);
342 error = SYSCTL_OUT(req, name, strlen(name) + 1);
346 sx_sunlock(&iconv_lock);
350 error = SYSCTL_OUT(req, &spc, sizeof(spc));
354 SYSCTL_PROC(_kern_iconv, OID_AUTO, drvlist, CTLFLAG_RD | CTLTYPE_OPAQUE,
355 NULL, 0, iconv_sysctl_drvlist, "S,xlat", "registered converters");
358 * List all available charset pairs.
361 iconv_sysctl_cslist(SYSCTL_HANDLER_ARGS)
363 struct iconv_cspair *csp;
364 struct iconv_cspair_info csi;
368 bzero(&csi, sizeof(csi));
369 csi.cs_version = ICONV_CSPAIR_INFO_VER;
370 sx_slock(&iconv_lock);
371 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
372 csi.cs_id = csp->cp_id;
373 csi.cs_refcount = csp->cp_refcount;
374 csi.cs_base = csp->cp_base ? csp->cp_base->cp_id : 0;
375 strcpy(csi.cs_to, csp->cp_to);
376 strcpy(csi.cs_from, csp->cp_from);
377 error = SYSCTL_OUT(req, &csi, sizeof(csi));
381 sx_sunlock(&iconv_lock);
385 SYSCTL_PROC(_kern_iconv, OID_AUTO, cslist, CTLFLAG_RD | CTLTYPE_OPAQUE,
386 NULL, 0, iconv_sysctl_cslist, "S,xlat", "registered charset pairs");
389 iconv_add(const char *converter, const char *to, const char *from)
391 struct iconv_converter_class *dcp;
392 struct iconv_cspair *csp;
394 if (iconv_lookupconv(converter, &dcp) != 0)
397 return iconv_register_cspair(to, from, dcp, NULL, &csp);
401 * Add new charset pair
404 iconv_sysctl_add(SYSCTL_HANDLER_ARGS)
406 struct iconv_converter_class *dcp;
407 struct iconv_cspair *csp;
408 struct iconv_add_in din;
409 struct iconv_add_out dout;
412 error = SYSCTL_IN(req, &din, sizeof(din));
415 if (din.ia_version != ICONV_ADD_VER)
417 if (din.ia_datalen > ICONV_CSMAXDATALEN)
419 if (strlen(din.ia_from) >= ICONV_CSNMAXLEN)
421 if (strlen(din.ia_to) >= ICONV_CSNMAXLEN)
423 if (strlen(din.ia_converter) >= ICONV_CNVNMAXLEN)
425 if (iconv_lookupconv(din.ia_converter, &dcp) != 0)
427 sx_xlock(&iconv_lock);
428 error = iconv_register_cspair(din.ia_to, din.ia_from, dcp, NULL, &csp);
430 sx_xunlock(&iconv_lock);
433 if (din.ia_datalen) {
434 csp->cp_data = malloc(din.ia_datalen, M_ICONVDATA, M_WAITOK);
435 error = copyin(din.ia_data, csp->cp_data, din.ia_datalen);
439 dout.ia_csid = csp->cp_id;
440 error = SYSCTL_OUT(req, &dout, sizeof(dout));
443 sx_xunlock(&iconv_lock);
444 ICDEBUG("%s => %s, %d bytes\n",din.ia_from, din.ia_to, din.ia_datalen);
447 iconv_unregister_cspair(csp);
448 sx_xunlock(&iconv_lock);
452 SYSCTL_PROC(_kern_iconv, OID_AUTO, add, CTLFLAG_RW | CTLTYPE_OPAQUE,
453 NULL, 0, iconv_sysctl_add, "S,xlat", "register charset pair");
456 * Default stubs for converters
459 iconv_converter_initstub(struct iconv_converter_class *dp)
465 iconv_converter_donestub(struct iconv_converter_class *dp)
471 iconv_converter_tolowerstub(int c, void *handle)
477 iconv_converter_handler(module_t mod, int type, void *data)
479 struct iconv_converter_class *dcp = data;
484 sx_xlock(&iconv_lock);
485 error = iconv_register_converter(dcp);
487 sx_xunlock(&iconv_lock);
490 error = ICONV_CONVERTER_INIT(dcp);
492 iconv_unregister_converter(dcp);
493 sx_xunlock(&iconv_lock);
496 sx_xlock(&iconv_lock);
497 ICONV_CONVERTER_DONE(dcp);
498 error = iconv_unregister_converter(dcp);
499 sx_xunlock(&iconv_lock);
508 * Common used functions (don't use with unicode)
511 iconv_convstr(void *handle, char *dst, const char *src)
514 size_t inlen, outlen;
517 if (handle == NULL) {
521 inlen = outlen = strlen(src);
522 error = iconv_conv(handle, NULL, NULL, &p, &outlen);
525 error = iconv_conv(handle, &src, &inlen, &p, &outlen);
533 iconv_convmem(void *handle, void *dst, const void *src, int size)
537 size_t inlen, outlen;
542 if (handle == NULL) {
543 memcpy(dst, src, size);
546 inlen = outlen = size;
547 error = iconv_conv(handle, NULL, NULL, &d, &outlen);
550 error = iconv_conv(handle, &s, &inlen, &d, &outlen);
557 iconv_lookupcp(char **cpp, const char *s)
560 ICDEBUG("warning a NULL list passed\n", ""); /* XXX ISO variadic macros cannot
566 if (strcmp(*cpp, s) == 0)
572 * Return if fsname is in use of not
575 iconv_vfs_refcount(const char *fsname)
577 struct vfsconf *vfsp;
579 vfsp = vfs_byname(fsname);
580 if (vfsp != NULL && vfsp->vfc_refcount > 0)