1 /* misc.h - prototypes for misc functions */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2002,2003,2005,2006,2007,2008,2009,2010 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef GRUB_MISC_HEADER
21 #define GRUB_MISC_HEADER 1
24 #include <grub/types.h>
25 #include <grub/symbol.h>
27 #include <grub/i18n.h>
28 #include <grub/compiler.h>
30 #define ALIGN_UP(addr, align) \
31 ((addr + (typeof (addr)) align - 1) & ~((typeof (addr)) align - 1))
32 #define ALIGN_UP_OVERHEAD(addr, align) ((-(addr)) & ((typeof (addr)) (align) - 1))
33 #define ALIGN_DOWN(addr, align) \
34 ((addr) & ~((typeof (addr)) align - 1))
35 #define ARRAY_SIZE(array) (sizeof (array) / sizeof (array[0]))
36 #define COMPILE_TIME_ASSERT(cond) switch (0) { case 1: case !(cond): ; }
38 #define grub_dprintf(condition, ...) grub_real_dprintf(GRUB_FILE, __LINE__, condition, __VA_ARGS__)
40 void *EXPORT_FUNC(grub_memmove) (void *dest, const void *src, grub_size_t n);
41 char *EXPORT_FUNC(grub_strcpy) (char *dest, const char *src);
44 grub_strncpy (char *dest, const char *src, int c)
48 while ((*p++ = *src++) != '\0' && --c)
55 grub_stpcpy (char *dest, const char *src)
67 /* XXX: If grub_memmove is too slow, we must implement grub_memcpy. */
69 grub_memcpy (void *dest, const void *src, grub_size_t n)
71 return grub_memmove (dest, src, n);
74 #if defined(__x86_64__) && !defined (GRUB_UTIL)
75 #if defined (__MINGW32__) || defined (__CYGWIN__) || defined (__MINGW64__)
76 #define GRUB_ASM_ATTR __attribute__ ((sysv_abi))
82 int EXPORT_FUNC(grub_memcmp) (const void *s1, const void *s2, grub_size_t n);
83 int EXPORT_FUNC(grub_strcmp) (const char *s1, const char *s2);
84 int EXPORT_FUNC(grub_strncmp) (const char *s1, const char *s2, grub_size_t n);
86 char *EXPORT_FUNC(grub_strchr) (const char *s, int c);
87 char *EXPORT_FUNC(grub_strrchr) (const char *s, int c);
88 int EXPORT_FUNC(grub_strword) (const char *s, const char *w);
90 /* Copied from gnulib.
91 Written by Bruno Haible <bruno@clisp.org>, 2005. */
93 grub_strstr (const char *haystack, const char *needle)
95 /* Be careful not to look at the entire extent of haystack or needle
96 until needed. This is useful because of these two cases:
97 - haystack may be very long, and a match of needle found early,
98 - needle may be very long, and not even a short initial segment of
99 needle may be found in haystack. */
102 /* Speed up the following searches of needle by caching its first
108 if (*haystack == '\0')
112 /* The first character matches. */
114 const char *rhaystack = haystack + 1;
115 const char *rneedle = needle;
117 for (;; rhaystack++, rneedle++)
119 if (*rneedle == '\0')
121 return (char *) haystack;
122 if (*rhaystack == '\0')
125 if (*rhaystack != *rneedle)
126 /* Nothing in this round. */
133 return (char *) haystack;
136 int EXPORT_FUNC(grub_isspace) (int c);
141 return (c >= ' ' && c <= '~');
147 return (c >= 0x00 && c <= 0x1F) || c == 0x7F;
153 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
159 return (c >= 'a' && c <= 'z');
165 return (c >= 'A' && c <= 'Z');
171 return (c >= '!' && c <= '~');
177 return (c >= '0' && c <= '9');
181 grub_isxdigit (int c)
183 return (c >= '0' && c <= '9') || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
189 return grub_isalpha (c) || grub_isdigit (c);
195 if (c >= 'A' && c <= 'Z')
196 return c - 'A' + 'a';
204 if (c >= 'a' && c <= 'z')
205 return c - 'a' + 'A';
211 grub_strcasecmp (const char *s1, const char *s2)
215 if (grub_tolower ((grub_uint8_t) *s1)
216 != grub_tolower ((grub_uint8_t) *s2))
223 return (int) grub_tolower ((grub_uint8_t) *s1)
224 - (int) grub_tolower ((grub_uint8_t) *s2);
228 grub_strncasecmp (const char *s1, const char *s2, grub_size_t n)
233 while (*s1 && *s2 && --n)
235 if (grub_tolower (*s1) != grub_tolower (*s2))
242 return (int) grub_tolower ((grub_uint8_t) *s1)
243 - (int) grub_tolower ((grub_uint8_t) *s2);
246 unsigned long EXPORT_FUNC(grub_strtoul) (const char *str, char **end, int base);
247 unsigned long long EXPORT_FUNC(grub_strtoull) (const char *str, char **end, int base);
250 grub_strtol (const char *str, char **end, int base)
253 unsigned long long magnitude;
255 while (*str && grub_isspace (*str))
264 magnitude = grub_strtoull (str, end, base);
267 if (magnitude > (unsigned long) GRUB_LONG_MAX + 1)
269 grub_error (GRUB_ERR_OUT_OF_RANGE, N_("overflow is detected"));
270 return GRUB_LONG_MIN;
272 return -((long) magnitude);
276 if (magnitude > GRUB_LONG_MAX)
278 grub_error (GRUB_ERR_OUT_OF_RANGE, N_("overflow is detected"));
279 return GRUB_LONG_MAX;
281 return (long) magnitude;
285 char *EXPORT_FUNC(grub_strdup) (const char *s) WARN_UNUSED_RESULT;
286 char *EXPORT_FUNC(grub_strndup) (const char *s, grub_size_t n) WARN_UNUSED_RESULT;
287 void *EXPORT_FUNC(grub_memset) (void *s, int c, grub_size_t n);
288 grub_size_t EXPORT_FUNC(grub_strlen) (const char *s) WARN_UNUSED_RESULT;
289 int EXPORT_FUNC(grub_printf) (const char *fmt, ...) __attribute__ ((format (GNU_PRINTF, 1, 2)));
290 int EXPORT_FUNC(grub_printf_) (const char *fmt, ...) __attribute__ ((format (GNU_PRINTF, 1, 2)));
292 /* Replace all `ch' characters of `input' with `with' and copy the
293 result into `output'; return EOS address of `output'. */
295 grub_strchrsub (char *output, const char *input, char ch, const char *with)
301 grub_strcpy (output, with);
302 output += grub_strlen (with);
306 *output++ = *input++;
312 extern void (*EXPORT_VAR (grub_xputs)) (const char *str);
315 grub_puts (const char *s)
317 const char nl[2] = "\n";
321 return 1; /* Cannot fail. */
324 int EXPORT_FUNC(grub_puts_) (const char *s);
325 void EXPORT_FUNC(grub_real_dprintf) (const char *file,
327 const char *condition,
328 const char *fmt, ...) __attribute__ ((format (GNU_PRINTF, 4, 5)));
329 int EXPORT_FUNC(grub_vprintf) (const char *fmt, va_list args);
330 int EXPORT_FUNC(grub_snprintf) (char *str, grub_size_t n, const char *fmt, ...)
331 __attribute__ ((format (GNU_PRINTF, 3, 4)));
332 int EXPORT_FUNC(grub_vsnprintf) (char *str, grub_size_t n, const char *fmt,
334 char *EXPORT_FUNC(grub_xasprintf) (const char *fmt, ...)
335 __attribute__ ((format (GNU_PRINTF, 1, 2))) WARN_UNUSED_RESULT;
336 char *EXPORT_FUNC(grub_xvasprintf) (const char *fmt, va_list args) WARN_UNUSED_RESULT;
337 void EXPORT_FUNC(grub_exit) (void) __attribute__ ((noreturn));
338 grub_uint64_t EXPORT_FUNC(grub_divmod64) (grub_uint64_t n,
342 /* Must match softdiv group in gentpl.py. */
343 #if !defined(GRUB_MACHINE_EMU) && (defined(__arm__) || defined(__ia64__))
344 #define GRUB_DIVISION_IN_SOFTWARE 1
346 #define GRUB_DIVISION_IN_SOFTWARE 0
349 /* Some division functions need to be in kernel if compiler generates calls
350 to them. Otherwise we still need them for consistent tests but they go
351 into a separate module. */
352 #if GRUB_DIVISION_IN_SOFTWARE
353 #define EXPORT_FUNC_IF_SOFTDIV EXPORT_FUNC
355 #define EXPORT_FUNC_IF_SOFTDIV(x) x
359 EXPORT_FUNC_IF_SOFTDIV(grub_divmod64s) (grub_int64_t n,
364 EXPORT_FUNC_IF_SOFTDIV (grub_divmod32) (grub_uint32_t n,
369 EXPORT_FUNC_IF_SOFTDIV (grub_divmod32s) (grub_int32_t n,
373 /* Inline functions. */
376 grub_memchr (const void *p, int c, grub_size_t len)
378 const char *s = (const char *) p;
379 const char *e = s + len;
389 static inline unsigned int
393 return (unsigned int) (-x);
395 return (unsigned int) x;
398 /* Reboot the machine. */
399 #if defined (GRUB_MACHINE_EMU) || defined (GRUB_MACHINE_QEMU_MIPS) || \
400 defined (GRUB_MACHINE_EFI)
401 void EXPORT_FUNC(grub_reboot) (void) __attribute__ ((noreturn));
403 void grub_reboot (void) __attribute__ ((noreturn));
406 #if defined (__clang__) && !defined (GRUB_UTIL)
407 void __attribute__ ((noreturn)) EXPORT_FUNC (abort) (void);
410 #ifdef GRUB_MACHINE_PCBIOS
411 /* Halt the system, using APM if possible. If NO_APM is true, don't
412 * use APM even if it is available. */
413 void grub_halt (int no_apm) __attribute__ ((noreturn));
414 #elif defined (__mips__) && !defined (GRUB_MACHINE_EMU)
415 void EXPORT_FUNC (grub_halt) (void) __attribute__ ((noreturn));
417 void grub_halt (void) __attribute__ ((noreturn));
420 #ifdef GRUB_MACHINE_EMU
421 /* Flag to check if module loading is available. */
422 extern const int EXPORT_VAR(grub_no_modules);
424 #define grub_no_modules 0
428 grub_error_save (struct grub_error_saved *save)
430 grub_memcpy (save->errmsg, grub_errmsg, sizeof (save->errmsg));
431 save->grub_errno = grub_errno;
432 grub_errno = GRUB_ERR_NONE;
436 grub_error_load (const struct grub_error_saved *save)
438 grub_memcpy (grub_errmsg, save->errmsg, sizeof (grub_errmsg));
439 grub_errno = save->grub_errno;
443 struct grub_boot_time
445 struct grub_boot_time *next;
452 extern struct grub_boot_time *EXPORT_VAR(grub_boot_time_head);
454 void EXPORT_FUNC(grub_real_boot_time) (const char *file,
456 const char *fmt, ...) __attribute__ ((format (GNU_PRINTF, 3, 4)));
457 #define grub_boot_time(...) grub_real_boot_time(GRUB_FILE, __LINE__, __VA_ARGS__)
459 #define grub_boot_time(...)
462 #define grub_max(a, b) (((a) > (b)) ? (a) : (b))
463 #define grub_min(a, b) (((a) < (b)) ? (a) : (b))
465 #endif /* ! GRUB_MISC_HEADER */