2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2000-2001 Boris Popov
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/iconv.h>
36 #include <sys/malloc.h>
37 #include <sys/mount.h>
39 #include <sys/syslog.h>
41 #include "iconv_converter_if.h"
43 SYSCTL_DECL(_kern_iconv);
45 SYSCTL_NODE(_kern, OID_AUTO, iconv, CTLFLAG_RW, NULL, "kernel iconv interface");
47 MALLOC_DEFINE(M_ICONV, "iconv", "ICONV structures");
48 static MALLOC_DEFINE(M_ICONVDATA, "iconv_data", "ICONV data");
50 MODULE_VERSION(libiconv, 2);
52 static struct sx iconv_lock;
56 * iconv converter instance
58 struct iconv_converter {
64 struct sysctl_oid *iconv_oid_hook = &sysctl___kern_iconv;
67 * List of loaded converters
69 static TAILQ_HEAD(iconv_converter_list, iconv_converter_class)
70 iconv_converters = TAILQ_HEAD_INITIALIZER(iconv_converters);
73 * List of supported/loaded charsets pairs
75 static TAILQ_HEAD(, iconv_cspair)
76 iconv_cslist = TAILQ_HEAD_INITIALIZER(iconv_cslist);
77 static int iconv_csid = 1;
79 static char iconv_unicode_string[] = "unicode"; /* save eight bytes when possible */
81 static void iconv_unregister_cspair(struct iconv_cspair *csp);
84 iconv_mod_unload(void)
86 struct iconv_cspair *csp;
88 sx_xlock(&iconv_lock);
89 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
90 if (csp->cp_refcount) {
91 sx_xunlock(&iconv_lock);
96 while ((csp = TAILQ_FIRST(&iconv_cslist)) != NULL)
97 iconv_unregister_cspair(csp);
98 sx_xunlock(&iconv_lock);
99 sx_destroy(&iconv_lock);
104 iconv_mod_handler(module_t mod, int type, void *data)
111 sx_init(&iconv_lock, "iconv");
114 error = iconv_mod_unload();
122 static moduledata_t iconv_mod = {
123 "iconv", iconv_mod_handler, NULL
126 DECLARE_MODULE(iconv, iconv_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND);
129 iconv_register_converter(struct iconv_converter_class *dcp)
131 kobj_class_compile((struct kobj_class*)dcp);
133 TAILQ_INSERT_TAIL(&iconv_converters, dcp, cc_link);
138 iconv_unregister_converter(struct iconv_converter_class *dcp)
142 ICDEBUG("converter has %d references left\n", dcp->refs);
145 TAILQ_REMOVE(&iconv_converters, dcp, cc_link);
146 kobj_class_free((struct kobj_class*)dcp);
151 iconv_lookupconv(const char *name, struct iconv_converter_class **dcpp)
153 struct iconv_converter_class *dcp;
155 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
158 if (strcmp(name, ICONV_CONVERTER_NAME(dcp)) == 0) {
168 iconv_lookupcs(const char *to, const char *from, struct iconv_cspair **cspp)
170 struct iconv_cspair *csp;
172 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
173 if (strcasecmp(csp->cp_to, to) == 0 &&
174 strcasecmp(csp->cp_from, from) == 0) {
184 iconv_register_cspair(const char *to, const char *from,
185 struct iconv_converter_class *dcp, void *data,
186 struct iconv_cspair **cspp)
188 struct iconv_cspair *csp;
190 int csize, ucsto, ucsfrom;
192 if (iconv_lookupcs(to, from, NULL) == 0)
194 csize = sizeof(*csp);
195 ucsto = strcmp(to, iconv_unicode_string) == 0;
197 csize += strlen(to) + 1;
198 ucsfrom = strcmp(from, iconv_unicode_string) == 0;
200 csize += strlen(from) + 1;
201 csp = malloc(csize, M_ICONV, M_WAITOK);
203 csp->cp_id = iconv_csid++;
205 cp = (char*)(csp + 1);
209 cp += strlen(cp) + 1;
211 csp->cp_to = iconv_unicode_string;
216 csp->cp_from = iconv_unicode_string;
219 TAILQ_INSERT_TAIL(&iconv_cslist, csp, cp_link);
225 iconv_unregister_cspair(struct iconv_cspair *csp)
227 TAILQ_REMOVE(&iconv_cslist, csp, cp_link);
229 free(csp->cp_data, M_ICONVDATA);
234 * Lookup and create an instance of converter.
235 * Currently this layer didn't have associated 'instance' structure
236 * to avoid unnesessary memory allocation.
239 iconv_open(const char *to, const char *from, void **handle)
241 struct iconv_cspair *csp, *cspfrom, *cspto;
242 struct iconv_converter_class *dcp;
247 * First, lookup fully qualified cspairs
249 error = iconv_lookupcs(to, from, &csp);
251 return ICONV_CONVERTER_OPEN(csp->cp_dcp, csp, NULL, handle);
254 * Well, nothing found. Now try to construct a composite conversion
255 * ToDo: add a 'capability' field to converter
257 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
258 cnvname = ICONV_CONVERTER_NAME(dcp);
261 error = iconv_lookupcs(cnvname, from, &cspfrom);
264 error = iconv_lookupcs(to, cnvname, &cspto);
268 * Fine, we're found a pair which can be combined together
270 return ICONV_CONVERTER_OPEN(dcp, cspto, cspfrom, handle);
276 iconv_close(void *handle)
278 return ICONV_CONVERTER_CLOSE(handle);
282 iconv_conv(void *handle, const char **inbuf,
283 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
285 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, 0);
289 iconv_conv_case(void *handle, const char **inbuf,
290 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
292 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 0, casetype);
296 iconv_convchr(void *handle, const char **inbuf,
297 size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
299 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, 0);
303 iconv_convchr_case(void *handle, const char **inbuf,
304 size_t *inbytesleft, char **outbuf, size_t *outbytesleft, int casetype)
306 return ICONV_CONVERTER_CONV(handle, inbuf, inbytesleft, outbuf, outbytesleft, 1, casetype);
310 towlower(int c, void *handle)
312 return ICONV_CONVERTER_TOLOWER(handle, c);
316 towupper(int c, void *handle)
318 return ICONV_CONVERTER_TOUPPER(handle, c);
322 * Give a list of loaded converters. Each name terminated with 0.
323 * An empty string terminates the list.
326 iconv_sysctl_drvlist(SYSCTL_HANDLER_ARGS)
328 struct iconv_converter_class *dcp;
334 sx_slock(&iconv_lock);
335 TAILQ_FOREACH(dcp, &iconv_converters, cc_link) {
336 name = ICONV_CONVERTER_NAME(dcp);
339 error = SYSCTL_OUT(req, name, strlen(name) + 1);
343 sx_sunlock(&iconv_lock);
347 error = SYSCTL_OUT(req, &spc, sizeof(spc));
351 SYSCTL_PROC(_kern_iconv, OID_AUTO, drvlist, CTLFLAG_RD | CTLTYPE_OPAQUE,
352 NULL, 0, iconv_sysctl_drvlist, "S,xlat", "registered converters");
355 * List all available charset pairs.
358 iconv_sysctl_cslist(SYSCTL_HANDLER_ARGS)
360 struct iconv_cspair *csp;
361 struct iconv_cspair_info csi;
365 bzero(&csi, sizeof(csi));
366 csi.cs_version = ICONV_CSPAIR_INFO_VER;
367 sx_slock(&iconv_lock);
368 TAILQ_FOREACH(csp, &iconv_cslist, cp_link) {
369 csi.cs_id = csp->cp_id;
370 csi.cs_refcount = csp->cp_refcount;
371 csi.cs_base = csp->cp_base ? csp->cp_base->cp_id : 0;
372 strcpy(csi.cs_to, csp->cp_to);
373 strcpy(csi.cs_from, csp->cp_from);
374 error = SYSCTL_OUT(req, &csi, sizeof(csi));
378 sx_sunlock(&iconv_lock);
382 SYSCTL_PROC(_kern_iconv, OID_AUTO, cslist, CTLFLAG_RD | CTLTYPE_OPAQUE,
383 NULL, 0, iconv_sysctl_cslist, "S,xlat", "registered charset pairs");
386 iconv_add(const char *converter, const char *to, const char *from)
388 struct iconv_converter_class *dcp;
389 struct iconv_cspair *csp;
391 if (iconv_lookupconv(converter, &dcp) != 0)
394 return iconv_register_cspair(to, from, dcp, NULL, &csp);
398 * Add new charset pair
401 iconv_sysctl_add(SYSCTL_HANDLER_ARGS)
403 struct iconv_converter_class *dcp;
404 struct iconv_cspair *csp;
405 struct iconv_add_in din;
406 struct iconv_add_out dout;
409 error = SYSCTL_IN(req, &din, sizeof(din));
412 if (din.ia_version != ICONV_ADD_VER)
414 if (din.ia_datalen > ICONV_CSMAXDATALEN)
416 if (strnlen(din.ia_from, sizeof(din.ia_from)) >= ICONV_CSNMAXLEN)
418 if (strnlen(din.ia_to, sizeof(din.ia_to)) >= ICONV_CSNMAXLEN)
420 if (strnlen(din.ia_converter, sizeof(din.ia_converter)) >= ICONV_CNVNMAXLEN)
422 if (iconv_lookupconv(din.ia_converter, &dcp) != 0)
424 sx_xlock(&iconv_lock);
425 error = iconv_register_cspair(din.ia_to, din.ia_from, dcp, NULL, &csp);
427 sx_xunlock(&iconv_lock);
430 if (din.ia_datalen) {
431 csp->cp_data = malloc(din.ia_datalen, M_ICONVDATA, M_WAITOK);
432 error = copyin(din.ia_data, csp->cp_data, din.ia_datalen);
436 dout.ia_csid = csp->cp_id;
437 error = SYSCTL_OUT(req, &dout, sizeof(dout));
440 sx_xunlock(&iconv_lock);
441 ICDEBUG("%s => %s, %d bytes\n",din.ia_from, din.ia_to, din.ia_datalen);
444 iconv_unregister_cspair(csp);
445 sx_xunlock(&iconv_lock);
449 SYSCTL_PROC(_kern_iconv, OID_AUTO, add, CTLFLAG_RW | CTLTYPE_OPAQUE,
450 NULL, 0, iconv_sysctl_add, "S,xlat", "register charset pair");
453 * Default stubs for converters
456 iconv_converter_initstub(struct iconv_converter_class *dp)
462 iconv_converter_donestub(struct iconv_converter_class *dp)
468 iconv_converter_tolowerstub(int c, void *handle)
474 iconv_converter_handler(module_t mod, int type, void *data)
476 struct iconv_converter_class *dcp = data;
481 sx_xlock(&iconv_lock);
482 error = iconv_register_converter(dcp);
484 sx_xunlock(&iconv_lock);
487 error = ICONV_CONVERTER_INIT(dcp);
489 iconv_unregister_converter(dcp);
490 sx_xunlock(&iconv_lock);
493 sx_xlock(&iconv_lock);
494 ICONV_CONVERTER_DONE(dcp);
495 error = iconv_unregister_converter(dcp);
496 sx_xunlock(&iconv_lock);
505 * Common used functions (don't use with unicode)
508 iconv_convstr(void *handle, char *dst, const char *src)
511 size_t inlen, outlen;
514 if (handle == NULL) {
518 inlen = outlen = strlen(src);
519 error = iconv_conv(handle, NULL, NULL, &p, &outlen);
522 error = iconv_conv(handle, &src, &inlen, &p, &outlen);
530 iconv_convmem(void *handle, void *dst, const void *src, int size)
534 size_t inlen, outlen;
539 if (handle == NULL) {
540 memcpy(dst, src, size);
543 inlen = outlen = size;
544 error = iconv_conv(handle, NULL, NULL, &d, &outlen);
547 error = iconv_conv(handle, &s, &inlen, &d, &outlen);
554 iconv_lookupcp(char **cpp, const char *s)
557 ICDEBUG("warning a NULL list passed\n", "");
561 if (strcmp(*cpp, s) == 0)
567 * Return if fsname is in use of not
570 iconv_vfs_refcount(const char *fsname)
572 struct vfsconf *vfsp;
574 vfsp = vfs_byname(fsname);
575 if (vfsp != NULL && vfsp->vfc_refcount > 0)