]> git.proxmox.com Git - mirror_spl.git/blob - module/spl/spl-generic.c
Add missing 64-bit divide for 32-bit ARM
[mirror_spl.git] / module / spl / spl-generic.c
1 /*****************************************************************************\
2 * Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
3 * Copyright (C) 2007 The Regents of the University of California.
4 * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
5 * Written by Brian Behlendorf <behlendorf1@llnl.gov>.
6 * UCRL-CODE-235197
7 *
8 * This file is part of the SPL, Solaris Porting Layer.
9 * For details, see <http://github.com/behlendorf/spl/>.
10 *
11 * The SPL is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
15 *
16 * The SPL is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 * for more details.
20 *
21 * You should have received a copy of the GNU General Public License along
22 * with the SPL. If not, see <http://www.gnu.org/licenses/>.
23 *****************************************************************************
24 * Solaris Porting Layer (SPL) Generic Implementation.
25 \*****************************************************************************/
26
27 #include <sys/sysmacros.h>
28 #include <sys/systeminfo.h>
29 #include <sys/vmsystm.h>
30 #include <sys/kobj.h>
31 #include <sys/kmem.h>
32 #include <sys/mutex.h>
33 #include <sys/rwlock.h>
34 #include <sys/taskq.h>
35 #include <sys/tsd.h>
36 #include <sys/zmod.h>
37 #include <sys/debug.h>
38 #include <sys/proc.h>
39 #include <sys/kstat.h>
40 #include <sys/utsname.h>
41 #include <sys/file.h>
42 #include <linux/kmod.h>
43 #include <linux/proc_compat.h>
44 #include <spl-debug.h>
45
46 #ifdef SS_DEBUG_SUBSYS
47 #undef SS_DEBUG_SUBSYS
48 #endif
49
50 #define SS_DEBUG_SUBSYS SS_GENERIC
51
52 char spl_version[32] = "SPL v" SPL_META_VERSION "-" SPL_META_RELEASE;
53 EXPORT_SYMBOL(spl_version);
54
55 unsigned long spl_hostid = HW_INVALID_HOSTID;
56 EXPORT_SYMBOL(spl_hostid);
57 module_param(spl_hostid, ulong, 0644);
58 MODULE_PARM_DESC(spl_hostid, "The system hostid.");
59
60 char hw_serial[HW_HOSTID_LEN] = "<none>";
61 EXPORT_SYMBOL(hw_serial);
62
63 proc_t p0 = { 0 };
64 EXPORT_SYMBOL(p0);
65
66 #ifndef HAVE_KALLSYMS_LOOKUP_NAME
67 kallsyms_lookup_name_t spl_kallsyms_lookup_name_fn = SYMBOL_POISON;
68 #endif
69
70 int
71 highbit(unsigned long i)
72 {
73 register int h = 1;
74 SENTRY;
75
76 if (i == 0)
77 SRETURN(0);
78 #if BITS_PER_LONG == 64
79 if (i & 0xffffffff00000000ul) {
80 h += 32; i >>= 32;
81 }
82 #endif
83 if (i & 0xffff0000) {
84 h += 16; i >>= 16;
85 }
86 if (i & 0xff00) {
87 h += 8; i >>= 8;
88 }
89 if (i & 0xf0) {
90 h += 4; i >>= 4;
91 }
92 if (i & 0xc) {
93 h += 2; i >>= 2;
94 }
95 if (i & 0x2) {
96 h += 1;
97 }
98 SRETURN(h);
99 }
100 EXPORT_SYMBOL(highbit);
101
102 #if BITS_PER_LONG == 32
103 /*
104 * Support 64/64 => 64 division on a 32-bit platform. While the kernel
105 * provides a div64_u64() function for this we do not use it because the
106 * implementation is flawed. There are cases which return incorrect
107 * results as late as linux-2.6.35. Until this is fixed upstream the
108 * spl must provide its own implementation.
109 *
110 * This implementation is a slightly modified version of the algorithm
111 * proposed by the book 'Hacker's Delight'. The original source can be
112 * found here and is available for use without restriction.
113 *
114 * http://www.hackersdelight.org/HDcode/newCode/divDouble.c
115 */
116
117 /*
118 * Calculate number of leading of zeros for a 64-bit value.
119 */
120 static int
121 nlz64(uint64_t x) {
122 register int n = 0;
123
124 if (x == 0)
125 return 64;
126
127 if (x <= 0x00000000FFFFFFFFULL) {n = n + 32; x = x << 32;}
128 if (x <= 0x0000FFFFFFFFFFFFULL) {n = n + 16; x = x << 16;}
129 if (x <= 0x00FFFFFFFFFFFFFFULL) {n = n + 8; x = x << 8;}
130 if (x <= 0x0FFFFFFFFFFFFFFFULL) {n = n + 4; x = x << 4;}
131 if (x <= 0x3FFFFFFFFFFFFFFFULL) {n = n + 2; x = x << 2;}
132 if (x <= 0x7FFFFFFFFFFFFFFFULL) {n = n + 1;}
133
134 return n;
135 }
136
137 /*
138 * Newer kernels have a div_u64() function but we define our own
139 * to simplify portibility between kernel versions.
140 */
141 static inline uint64_t
142 __div_u64(uint64_t u, uint32_t v)
143 {
144 (void) do_div(u, v);
145 return u;
146 }
147
148 /*
149 * Implementation of 64-bit unsigned division for 32-bit machines.
150 *
151 * First the procedure takes care of the case in which the divisor is a
152 * 32-bit quantity. There are two subcases: (1) If the left half of the
153 * dividend is less than the divisor, one execution of do_div() is all that
154 * is required (overflow is not possible). (2) Otherwise it does two
155 * divisions, using the grade school method.
156 */
157 uint64_t
158 __udivdi3(uint64_t u, uint64_t v)
159 {
160 uint64_t u0, u1, v1, q0, q1, k;
161 int n;
162
163 if (v >> 32 == 0) { // If v < 2**32:
164 if (u >> 32 < v) { // If u/v cannot overflow,
165 return __div_u64(u, v); // just do one division.
166 } else { // If u/v would overflow:
167 u1 = u >> 32; // Break u into two halves.
168 u0 = u & 0xFFFFFFFF;
169 q1 = __div_u64(u1, v); // First quotient digit.
170 k = u1 - q1 * v; // First remainder, < v.
171 u0 += (k << 32);
172 q0 = __div_u64(u0, v); // Seconds quotient digit.
173 return (q1 << 32) + q0;
174 }
175 } else { // If v >= 2**32:
176 n = nlz64(v); // 0 <= n <= 31.
177 v1 = (v << n) >> 32; // Normalize divisor, MSB is 1.
178 u1 = u >> 1; // To ensure no overflow.
179 q1 = __div_u64(u1, v1); // Get quotient from
180 q0 = (q1 << n) >> 31; // Undo normalization and
181 // division of u by 2.
182 if (q0 != 0) // Make q0 correct or
183 q0 = q0 - 1; // too small by 1.
184 if ((u - q0 * v) >= v)
185 q0 = q0 + 1; // Now q0 is correct.
186
187 return q0;
188 }
189 }
190 EXPORT_SYMBOL(__udivdi3);
191
192 /*
193 * Implementation of 64-bit signed division for 32-bit machines.
194 */
195 int64_t
196 __divdi3(int64_t u, int64_t v)
197 {
198 int64_t q, t;
199 q = __udivdi3(abs64(u), abs64(v));
200 t = (u ^ v) >> 63; // If u, v have different
201 return (q ^ t) - t; // signs, negate q.
202 }
203 EXPORT_SYMBOL(__divdi3);
204
205 /*
206 * Implementation of 64-bit unsigned modulo for 32-bit machines.
207 */
208 uint64_t
209 __umoddi3(uint64_t dividend, uint64_t divisor)
210 {
211 return (dividend - (divisor * __udivdi3(dividend, divisor)));
212 }
213 EXPORT_SYMBOL(__umoddi3);
214
215 #if defined(__arm) || defined(__arm__)
216 /*
217 * Implementation of 64-bit unsigned division for 32-bit arm machines.
218 */
219 uint64_t
220 __aeabi_uldivmod(uint64_t u, uint64_t v)
221 {
222 return __udivdi3(u, v);
223 }
224 EXPORT_SYMBOL(__aeabi_uldivmod);
225
226 /*
227 * Implementation of 64-bit signed division for 32-bit arm machines.
228 */
229 int64_t
230 __aeabi_ldivmod(int64_t u, int64_t v)
231 {
232 return __divdi3(u, v);
233 }
234 EXPORT_SYMBOL(__aeabi_ldivmod);
235 #endif /* __arm || __arm__ */
236 #endif /* BITS_PER_LONG */
237
238 /* NOTE: The strtoxx behavior is solely based on my reading of the Solaris
239 * ddi_strtol(9F) man page. I have not verified the behavior of these
240 * functions against their Solaris counterparts. It is possible that I
241 * may have misinterpreted the man page or the man page is incorrect.
242 */
243 int ddi_strtoul(const char *, char **, int, unsigned long *);
244 int ddi_strtol(const char *, char **, int, long *);
245 int ddi_strtoull(const char *, char **, int, unsigned long long *);
246 int ddi_strtoll(const char *, char **, int, long long *);
247
248 #define define_ddi_strtoux(type, valtype) \
249 int ddi_strtou##type(const char *str, char **endptr, \
250 int base, valtype *result) \
251 { \
252 valtype last_value, value = 0; \
253 char *ptr = (char *)str; \
254 int flag = 1, digit; \
255 \
256 if (strlen(ptr) == 0) \
257 return EINVAL; \
258 \
259 /* Auto-detect base based on prefix */ \
260 if (!base) { \
261 if (str[0] == '0') { \
262 if (tolower(str[1])=='x' && isxdigit(str[2])) { \
263 base = 16; /* hex */ \
264 ptr += 2; \
265 } else if (str[1] >= '0' && str[1] < 8) { \
266 base = 8; /* octal */ \
267 ptr += 1; \
268 } else { \
269 return EINVAL; \
270 } \
271 } else { \
272 base = 10; /* decimal */ \
273 } \
274 } \
275 \
276 while (1) { \
277 if (isdigit(*ptr)) \
278 digit = *ptr - '0'; \
279 else if (isalpha(*ptr)) \
280 digit = tolower(*ptr) - 'a' + 10; \
281 else \
282 break; \
283 \
284 if (digit >= base) \
285 break; \
286 \
287 last_value = value; \
288 value = value * base + digit; \
289 if (last_value > value) /* Overflow */ \
290 return ERANGE; \
291 \
292 flag = 1; \
293 ptr++; \
294 } \
295 \
296 if (flag) \
297 *result = value; \
298 \
299 if (endptr) \
300 *endptr = (char *)(flag ? ptr : str); \
301 \
302 return 0; \
303 } \
304
305 #define define_ddi_strtox(type, valtype) \
306 int ddi_strto##type(const char *str, char **endptr, \
307 int base, valtype *result) \
308 { \
309 int rc; \
310 \
311 if (*str == '-') { \
312 rc = ddi_strtou##type(str + 1, endptr, base, result); \
313 if (!rc) { \
314 if (*endptr == str + 1) \
315 *endptr = (char *)str; \
316 else \
317 *result = -*result; \
318 } \
319 } else { \
320 rc = ddi_strtou##type(str, endptr, base, result); \
321 } \
322 \
323 return rc; \
324 }
325
326 define_ddi_strtoux(l, unsigned long)
327 define_ddi_strtox(l, long)
328 define_ddi_strtoux(ll, unsigned long long)
329 define_ddi_strtox(ll, long long)
330
331 EXPORT_SYMBOL(ddi_strtoul);
332 EXPORT_SYMBOL(ddi_strtol);
333 EXPORT_SYMBOL(ddi_strtoll);
334 EXPORT_SYMBOL(ddi_strtoull);
335
336 int
337 ddi_copyin(const void *from, void *to, size_t len, int flags)
338 {
339 /* Fake ioctl() issued by kernel, 'from' is a kernel address */
340 if (flags & FKIOCTL) {
341 memcpy(to, from, len);
342 return 0;
343 }
344
345 return copyin(from, to, len);
346 }
347 EXPORT_SYMBOL(ddi_copyin);
348
349 int
350 ddi_copyout(const void *from, void *to, size_t len, int flags)
351 {
352 /* Fake ioctl() issued by kernel, 'from' is a kernel address */
353 if (flags & FKIOCTL) {
354 memcpy(to, from, len);
355 return 0;
356 }
357
358 return copyout(from, to, len);
359 }
360 EXPORT_SYMBOL(ddi_copyout);
361
362 #ifndef HAVE_PUT_TASK_STRUCT
363 /*
364 * This is only a stub function which should never be used. The SPL should
365 * never be putting away the last reference on a task structure so this will
366 * not be called. However, we still need to define it so the module does not
367 * have undefined symbol at load time. That all said if this impossible
368 * thing does somehow happen PANIC immediately so we know about it.
369 */
370 void
371 __put_task_struct(struct task_struct *t)
372 {
373 PANIC("Unexpectly put last reference on task %d\n", (int)t->pid);
374 }
375 EXPORT_SYMBOL(__put_task_struct);
376 #endif /* HAVE_PUT_TASK_STRUCT */
377
378 struct new_utsname *__utsname(void)
379 {
380 #ifdef HAVE_INIT_UTSNAME
381 return init_utsname();
382 #else
383 return &system_utsname;
384 #endif
385 }
386 EXPORT_SYMBOL(__utsname);
387
388
389 /*
390 * Read the unique system identifier from the /etc/hostid file.
391 *
392 * The behavior of /usr/bin/hostid on Linux systems with the
393 * regular eglibc and coreutils is:
394 *
395 * 1. Generate the value if the /etc/hostid file does not exist
396 * or if the /etc/hostid file is less than four bytes in size.
397 *
398 * 2. If the /etc/hostid file is at least 4 bytes, then return
399 * the first four bytes [0..3] in native endian order.
400 *
401 * 3. Always ignore bytes [4..] if they exist in the file.
402 *
403 * Only the first four bytes are significant, even on systems that
404 * have a 64-bit word size.
405 *
406 * See:
407 *
408 * eglibc: sysdeps/unix/sysv/linux/gethostid.c
409 * coreutils: src/hostid.c
410 *
411 * Notes:
412 *
413 * The /etc/hostid file on Solaris is a text file that often reads:
414 *
415 * # DO NOT EDIT
416 * "0123456789"
417 *
418 * Directly copying this file to Linux results in a constant
419 * hostid of 4f442023 because the default comment constitutes
420 * the first four bytes of the file.
421 *
422 */
423
424 char *spl_hostid_path = HW_HOSTID_PATH;
425 module_param(spl_hostid_path, charp, 0444);
426 MODULE_PARM_DESC(spl_hostid_path, "The system hostid file (/etc/hostid)");
427
428 static int
429 hostid_read(void)
430 {
431 int result;
432 uint64_t size;
433 struct _buf *file;
434 unsigned long hostid = 0;
435
436 file = kobj_open_file(spl_hostid_path);
437
438 if (file == (struct _buf *)-1)
439 return -1;
440
441 result = kobj_get_filesize(file, &size);
442
443 if (result != 0) {
444 printk(KERN_WARNING
445 "SPL: kobj_get_filesize returned %i on %s\n",
446 result, spl_hostid_path);
447 kobj_close_file(file);
448 return -2;
449 }
450
451 if (size < sizeof(HW_HOSTID_MASK)) {
452 printk(KERN_WARNING
453 "SPL: Ignoring the %s file because it is %llu bytes; "
454 "expecting %lu bytes instead.\n",
455 spl_hostid_path, size, sizeof(HW_HOSTID_MASK));
456 kobj_close_file(file);
457 return -3;
458 }
459
460 /* Read directly into the variable like eglibc does. */
461 /* Short reads are okay; native behavior is preserved. */
462 result = kobj_read_file(file, (char *)&hostid, sizeof(hostid), 0);
463
464 if (result < 0) {
465 printk(KERN_WARNING
466 "SPL: kobj_read_file returned %i on %s\n",
467 result, spl_hostid_path);
468 kobj_close_file(file);
469 return -4;
470 }
471
472 /* Mask down to 32 bits like coreutils does. */
473 spl_hostid = hostid & HW_HOSTID_MASK;
474 kobj_close_file(file);
475 return 0;
476 }
477
478 #define GET_HOSTID_CMD \
479 "exec 0</dev/null " \
480 " 1>/proc/sys/kernel/spl/hostid " \
481 " 2>/dev/null; " \
482 "hostid"
483
484 static int
485 hostid_exec(void)
486 {
487 char *argv[] = { "/bin/sh",
488 "-c",
489 GET_HOSTID_CMD,
490 NULL };
491 char *envp[] = { "HOME=/",
492 "TERM=linux",
493 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
494 NULL };
495 int rc;
496
497 /* Doing address resolution in the kernel is tricky and just
498 * not a good idea in general. So to set the proper 'hw_serial'
499 * use the usermodehelper support to ask '/bin/sh' to run
500 * '/usr/bin/hostid' and redirect the result to /proc/sys/spl/hostid
501 * for us to use. It's a horrific solution but it will do for now.
502 */
503 rc = call_usermodehelper(argv[0], argv, envp, 1);
504 if (rc)
505 printk("SPL: Failed user helper '%s %s %s', rc = %d\n",
506 argv[0], argv[1], argv[2], rc);
507
508 return rc;
509 }
510
511 uint32_t
512 zone_get_hostid(void *zone)
513 {
514 unsigned long hostid;
515
516 /* Only the global zone is supported */
517 ASSERT(zone == NULL);
518
519 if (ddi_strtoul(hw_serial, NULL, HW_HOSTID_LEN-1, &hostid) != 0)
520 return HW_INVALID_HOSTID;
521
522 return (uint32_t)hostid;
523 }
524 EXPORT_SYMBOL(zone_get_hostid);
525
526 #ifndef HAVE_KALLSYMS_LOOKUP_NAME
527 /*
528 * The kallsyms_lookup_name() kernel function is not an exported symbol in
529 * Linux 2.6.19 through 2.6.32 inclusive.
530 *
531 * This function replaces the functionality by performing an upcall to user
532 * space where /proc/kallsyms is consulted for the requested address.
533 *
534 */
535
536 #define GET_KALLSYMS_ADDR_CMD \
537 "exec 0</dev/null " \
538 " 1>/proc/sys/kernel/spl/kallsyms_lookup_name " \
539 " 2>/dev/null; " \
540 "awk '{ if ( $3 == \"kallsyms_lookup_name\" ) { print $1 } }' " \
541 " /proc/kallsyms "
542
543 static int
544 set_kallsyms_lookup_name(void)
545 {
546 char *argv[] = { "/bin/sh",
547 "-c",
548 GET_KALLSYMS_ADDR_CMD,
549 NULL };
550 char *envp[] = { "HOME=/",
551 "TERM=linux",
552 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
553 NULL };
554 int rc;
555
556 rc = call_usermodehelper(argv[0], argv, envp, 1);
557 if (rc)
558 printk("SPL: Failed user helper '%s %s %s', rc = %d\n",
559 argv[0], argv[1], argv[2], rc);
560
561 return rc;
562 }
563 #endif
564
565 static int
566 __init spl_init(void)
567 {
568 int rc = 0;
569
570 if ((rc = spl_debug_init()))
571 return rc;
572
573 if ((rc = spl_kmem_init()))
574 SGOTO(out1, rc);
575
576 if ((rc = spl_mutex_init()))
577 SGOTO(out2, rc);
578
579 if ((rc = spl_rw_init()))
580 SGOTO(out3, rc);
581
582 if ((rc = spl_taskq_init()))
583 SGOTO(out4, rc);
584
585 if ((rc = spl_vn_init()))
586 SGOTO(out5, rc);
587
588 if ((rc = spl_proc_init()))
589 SGOTO(out6, rc);
590
591 if ((rc = spl_kstat_init()))
592 SGOTO(out7, rc);
593
594 if ((rc = spl_tsd_init()))
595 SGOTO(out8, rc);
596
597 if ((rc = spl_zlib_init()))
598 SGOTO(out9, rc);
599
600 /*
601 * Get the hostid if it was not passed as a module parameter. Try
602 * reading the /etc/hostid file directly, and then fall back to calling
603 * the /usr/bin/hostid utility.
604 */
605
606 if (spl_hostid == HW_INVALID_HOSTID
607 && (rc = hostid_read()) && (rc = hostid_exec()))
608 SGOTO(out10, rc = -EADDRNOTAVAIL);
609
610 #ifndef HAVE_KALLSYMS_LOOKUP_NAME
611 if ((rc = set_kallsyms_lookup_name()))
612 SGOTO(out10, rc = -EADDRNOTAVAIL);
613 #endif /* HAVE_KALLSYMS_LOOKUP_NAME */
614
615 if ((rc = spl_kmem_init_kallsyms_lookup()))
616 SGOTO(out10, rc);
617
618 if ((rc = spl_vn_init_kallsyms_lookup()))
619 SGOTO(out10, rc);
620
621 printk(KERN_NOTICE "SPL: Loaded module v%s-%s%s, using hostid "
622 "0x%08x\n", SPL_META_VERSION, SPL_META_RELEASE, SPL_DEBUG_STR,
623 (unsigned int) spl_hostid);
624 SRETURN(rc);
625 out10:
626 spl_zlib_fini();
627 out9:
628 spl_tsd_fini();
629 out8:
630 spl_kstat_fini();
631 out7:
632 spl_proc_fini();
633 out6:
634 spl_vn_fini();
635 out5:
636 spl_taskq_fini();
637 out4:
638 spl_rw_fini();
639 out3:
640 spl_mutex_fini();
641 out2:
642 spl_kmem_fini();
643 out1:
644 spl_debug_fini();
645
646 printk(KERN_NOTICE "SPL: Failed to Load Solaris Porting Layer "
647 "v%s-%s%s, rc = %d\n", SPL_META_VERSION, SPL_META_RELEASE,
648 SPL_DEBUG_STR, rc);
649 return rc;
650 }
651
652 static void
653 spl_fini(void)
654 {
655 SENTRY;
656
657 printk(KERN_NOTICE "SPL: Unloaded module v%s-%s%s\n",
658 SPL_META_VERSION, SPL_META_RELEASE, SPL_DEBUG_STR);
659 spl_zlib_fini();
660 spl_tsd_fini();
661 spl_kstat_fini();
662 spl_proc_fini();
663 spl_vn_fini();
664 spl_taskq_fini();
665 spl_rw_fini();
666 spl_mutex_fini();
667 spl_kmem_fini();
668 spl_debug_fini();
669 }
670
671 /* Called when a dependent module is loaded */
672 void
673 spl_setup(void)
674 {
675 int rc;
676
677 /*
678 * At module load time the pwd is set to '/' on a Solaris system.
679 * On a Linux system will be set to whatever directory the caller
680 * was in when executing insmod/modprobe.
681 */
682 rc = vn_set_pwd("/");
683 if (rc)
684 printk("SPL: Warning unable to set pwd to '/': %d\n", rc);
685 }
686 EXPORT_SYMBOL(spl_setup);
687
688 /* Called when a dependent module is unloaded */
689 void
690 spl_cleanup(void)
691 {
692 }
693 EXPORT_SYMBOL(spl_cleanup);
694
695 module_init(spl_init);
696 module_exit(spl_fini);
697
698 MODULE_AUTHOR("Lawrence Livermore National Labs");
699 MODULE_DESCRIPTION("Solaris Porting Layer");
700 MODULE_LICENSE("GPL");