include/grub/misc.h

   1 /* misc.h - prototypes for misc functions */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2002,2003,2005,2006,2007,2008,2009,2008  Free Software Foundation, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #ifndef GRUB_MISC_HEADER
  21 #define GRUB_MISC_HEADER        1
  22
  23 #include <stdarg.h>
  24 #include <grub/types.h>
  25 #include <grub/symbol.h>
  26 #include <grub/err.h>
  27
  28 #define ALIGN_UP(addr, align) (((grub_uint64_t)addr + align - 1) & ~(align - 1))
  29
  30 #define grub_dprintf(condition, fmt, args...) grub_real_dprintf(__FILE__, __LINE__, condition, fmt, ## args);
  31 /* XXX: If grub_memmove is too slow, we must implement grub_memcpy.  */
  32 #define grub_memcpy(d,s,n)      grub_memmove ((d), (s), (n))
  33
  34 void *EXPORT_FUNC(grub_memmove) (void *dest, const void *src, grub_size_t n);
  35 char *EXPORT_FUNC(grub_strcpy) (char *dest, const char *src);
  36 char *EXPORT_FUNC(grub_strncpy) (char *dest, const char *src, int c);
  37 char *EXPORT_FUNC(grub_stpcpy) (char *dest, const char *src);
  38 char *EXPORT_FUNC(grub_strcat) (char *dest, const char *src);
  39 char *EXPORT_FUNC(grub_strncat) (char *dest, const char *src, int c);
  40
  41 /* Prototypes for aliases.  */
  42 void *EXPORT_FUNC(memmove) (void *dest, const void *src, grub_size_t n);
  43 void *EXPORT_FUNC(memcpy) (void *dest, const void *src, grub_size_t n);
  44
  45 int EXPORT_FUNC(grub_memcmp) (const void *s1, const void *s2, grub_size_t n);
  46 int EXPORT_FUNC(grub_strcmp) (const char *s1, const char *s2);
  47 int EXPORT_FUNC(grub_strncmp) (const char *s1, const char *s2, grub_size_t n);
  48 int EXPORT_FUNC(grub_strcasecmp) (const char *s1, const char *s2);
  49 int EXPORT_FUNC(grub_strncasecmp) (const char *s1, const char *s2, grub_size_t n);
  50 char *EXPORT_FUNC(grub_strchr) (const char *s, int c);
  51 char *EXPORT_FUNC(grub_strrchr) (const char *s, int c);
  52 int EXPORT_FUNC(grub_strword) (const char *s, const char *w);
  53 char *EXPORT_FUNC(grub_strstr) (const char *haystack, const char *needle);
  54 int EXPORT_FUNC(grub_iswordseparator) (int c);
  55 int EXPORT_FUNC(grub_isspace) (int c);
  56 int EXPORT_FUNC(grub_isprint) (int c);
  57 int EXPORT_FUNC(grub_isalpha) (int c);
  58 int EXPORT_FUNC(grub_isgraph) (int c);
  59 int EXPORT_FUNC(grub_isdigit) (int c);
  60 int EXPORT_FUNC(grub_tolower) (int c);
  61 unsigned long EXPORT_FUNC(grub_strtoul) (const char *str, char **end, int base);
  62 unsigned long long EXPORT_FUNC(grub_strtoull) (const char *str, char **end, int base);
  63 char *EXPORT_FUNC(grub_strdup) (const char *s);
  64 char *EXPORT_FUNC(grub_strndup) (const char *s, grub_size_t n);
  65 void *EXPORT_FUNC(grub_memset) (void *s, int c, grub_size_t n);
  66 grub_size_t EXPORT_FUNC(grub_strlen) (const char *s);
  67 int EXPORT_FUNC(grub_printf) (const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
  68 void EXPORT_FUNC(grub_real_dprintf) (const char *file,
  69                                      const int line,
  70                                      const char *condition,
  71                                      const char *fmt, ...) __attribute__ ((format (printf, 4, 5)));
  72 int EXPORT_FUNC(grub_vprintf) (const char *fmt, va_list args);
  73 int EXPORT_FUNC(grub_sprintf) (char *str, const char *fmt, ...) __attribute__ ((format (printf, 2, 3)));
  74 int EXPORT_FUNC(grub_vsprintf) (char *str, const char *fmt, va_list args);
  75 void EXPORT_FUNC(grub_exit) (void) __attribute__ ((noreturn));
  76 void EXPORT_FUNC(grub_abort) (void) __attribute__ ((noreturn));
  77 grub_uint8_t *EXPORT_FUNC(grub_utf16_to_utf8) (grub_uint8_t *dest,
  78                                                grub_uint16_t *src,
  79                                                grub_size_t size);
  80 grub_ssize_t EXPORT_FUNC(grub_utf8_to_ucs4) (grub_uint32_t *dest,
  81                                              grub_size_t destsize,
  82                                              const grub_uint8_t *src,
  83                                              grub_size_t srcsize,
  84                                              const grub_uint8_t **srcend);
  85 grub_uint64_t EXPORT_FUNC(grub_divmod64) (grub_uint64_t n,
  86                                           grub_uint32_t d, grub_uint32_t *r);
  87
  88 #ifdef NEED_ENABLE_EXECUTE_STACK
  89 void EXPORT_FUNC(__enable_execute_stack) (void *addr);
  90 #endif
  91
  92 /* Inline functions.  */
  93
  94 static inline unsigned int
  95 grub_abs (int x)
  96 {
  97   if (x < 0)
  98     return (unsigned int) (-x);
  99   else
 100     return (unsigned int) x;
 101 }
 102
 103 static inline long
 104 grub_max (long x, long y)
 105 {
 106   if (x > y)
 107     return x;
 108   else
 109     return y;
 110 }
 111
 112 /* Rounded-up division */
 113 static inline unsigned int
 114 grub_div_roundup (unsigned int x, unsigned int y)
 115 {
 116   return (x + y - 1) / y;
 117 }
 118
 119 #endif /* ! GRUB_MISC_HEADER */