326 lines
8.2 KiB
C
326 lines
8.2 KiB
C
/* misc.h - prototypes for misc functions */
|
|
/*
|
|
* GRUB -- GRand Unified Bootloader
|
|
* Copyright (C) 2002,2003,2005,2006,2007,2008,2009,2010 Free Software Foundation, Inc.
|
|
*
|
|
* GRUB is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* GRUB is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with GRUB. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef GRUB_MISC_HEADER
|
|
#define GRUB_MISC_HEADER 1
|
|
|
|
#include <stdarg.h>
|
|
#include <grub/types.h>
|
|
#include <grub/symbol.h>
|
|
#include <grub/err.h>
|
|
|
|
/* GCC version checking borrowed from glibc. */
|
|
#if defined(__GNUC__) && defined(__GNUC_MINOR__)
|
|
# define GNUC_PREREQ(maj,min) \
|
|
((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
|
|
#else
|
|
# define GNUC_PREREQ(maj,min) 0
|
|
#endif
|
|
|
|
/* Does this compiler support compile-time error attributes? */
|
|
#if GNUC_PREREQ(4,3)
|
|
# define ATTRIBUTE_ERROR(msg) \
|
|
__attribute__ ((__error__ (msg)))
|
|
#else
|
|
# define ATTRIBUTE_ERROR(msg)
|
|
#endif
|
|
|
|
#define ALIGN_UP(addr, align) \
|
|
((addr + (typeof (addr)) align - 1) & ~((typeof (addr)) align - 1))
|
|
#define ARRAY_SIZE(array) (sizeof (array) / sizeof (array[0]))
|
|
#define COMPILE_TIME_ASSERT(cond) switch (0) { case 1: case !(cond): ; }
|
|
|
|
#define grub_dprintf(condition, fmt, args...) grub_real_dprintf(GRUB_FILE, __LINE__, condition, fmt, ## args)
|
|
/* XXX: If grub_memmove is too slow, we must implement grub_memcpy. */
|
|
#define grub_memcpy(d,s,n) grub_memmove ((d), (s), (n))
|
|
|
|
void *EXPORT_FUNC(grub_memmove) (void *dest, const void *src, grub_size_t n);
|
|
char *EXPORT_FUNC(grub_strcpy) (char *dest, const char *src);
|
|
char *EXPORT_FUNC(grub_strncpy) (char *dest, const char *src, int c);
|
|
char *EXPORT_FUNC(grub_stpcpy) (char *dest, const char *src);
|
|
|
|
static inline char *
|
|
grub_strcat (char *dest, const char *src)
|
|
{
|
|
char *p = dest;
|
|
|
|
while (*p)
|
|
p++;
|
|
|
|
while ((*p = *src) != '\0')
|
|
{
|
|
p++;
|
|
src++;
|
|
}
|
|
|
|
return dest;
|
|
}
|
|
|
|
static inline char *
|
|
grub_strncat (char *dest, const char *src, int c)
|
|
{
|
|
char *p = dest;
|
|
|
|
while (*p)
|
|
p++;
|
|
|
|
while ((*p = *src) != '\0' && c--)
|
|
{
|
|
p++;
|
|
src++;
|
|
}
|
|
|
|
*p = '\0';
|
|
|
|
return dest;
|
|
}
|
|
|
|
/* Prototypes for aliases. */
|
|
#ifndef GRUB_UTIL
|
|
int EXPORT_FUNC(memcmp) (const void *s1, const void *s2, grub_size_t n);
|
|
void *EXPORT_FUNC(memmove) (void *dest, const void *src, grub_size_t n);
|
|
void *EXPORT_FUNC(memcpy) (void *dest, const void *src, grub_size_t n);
|
|
void *EXPORT_FUNC(memset) (void *s, int c, grub_size_t n);
|
|
#endif
|
|
|
|
int EXPORT_FUNC(grub_memcmp) (const void *s1, const void *s2, grub_size_t n);
|
|
int EXPORT_FUNC(grub_strcmp) (const char *s1, const char *s2);
|
|
int EXPORT_FUNC(grub_strncmp) (const char *s1, const char *s2, grub_size_t n);
|
|
|
|
char *EXPORT_FUNC(grub_strchr) (const char *s, int c);
|
|
char *EXPORT_FUNC(grub_strrchr) (const char *s, int c);
|
|
int EXPORT_FUNC(grub_strword) (const char *s, const char *w);
|
|
char *EXPORT_FUNC(grub_strstr) (const char *haystack, const char *needle);
|
|
int EXPORT_FUNC(grub_isspace) (int c);
|
|
int EXPORT_FUNC(grub_isprint) (int c);
|
|
|
|
static inline int
|
|
grub_iscntrl (int c)
|
|
{
|
|
return (c >= 0x00 && c <= 0x1F) || c == 0x7F;
|
|
}
|
|
|
|
static inline int
|
|
grub_isalpha (int c)
|
|
{
|
|
return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
|
|
}
|
|
|
|
static inline int
|
|
grub_isgraph (int c)
|
|
{
|
|
return (c >= '!' && c <= '~');
|
|
}
|
|
|
|
static inline int
|
|
grub_isdigit (int c)
|
|
{
|
|
return (c >= '0' && c <= '9');
|
|
}
|
|
|
|
static inline int
|
|
grub_isalnum (int c)
|
|
{
|
|
return grub_isalpha (c) || grub_isdigit (c);
|
|
}
|
|
|
|
static inline int
|
|
grub_tolower (int c)
|
|
{
|
|
if (c >= 'A' && c <= 'Z')
|
|
return c - 'A' + 'a';
|
|
|
|
return c;
|
|
}
|
|
|
|
static inline int
|
|
grub_toupper (int c)
|
|
{
|
|
if (c >= 'a' && c <= 'z')
|
|
return c - 'a' + 'A';
|
|
|
|
return c;
|
|
}
|
|
|
|
static inline int
|
|
grub_strcasecmp (const char *s1, const char *s2)
|
|
{
|
|
while (*s1 && *s2)
|
|
{
|
|
if (grub_tolower (*s1) != grub_tolower (*s2))
|
|
break;
|
|
|
|
s1++;
|
|
s2++;
|
|
}
|
|
|
|
return (int) grub_tolower (*s1) - (int) grub_tolower (*s2);
|
|
}
|
|
|
|
static inline int
|
|
grub_strncasecmp (const char *s1, const char *s2, grub_size_t n)
|
|
{
|
|
if (n == 0)
|
|
return 0;
|
|
|
|
while (*s1 && *s2 && --n)
|
|
{
|
|
if (grub_tolower (*s1) != grub_tolower (*s2))
|
|
break;
|
|
|
|
s1++;
|
|
s2++;
|
|
}
|
|
|
|
return (int) grub_tolower (*s1) - (int) grub_tolower (*s2);
|
|
}
|
|
|
|
|
|
unsigned long EXPORT_FUNC(grub_strtoul) (const char *str, char **end, int base);
|
|
unsigned long long EXPORT_FUNC(grub_strtoull) (const char *str, char **end, int base);
|
|
|
|
static inline long
|
|
grub_strtol (const char *str, char **end, int base)
|
|
{
|
|
int negative = 0;
|
|
unsigned long magnitude;
|
|
|
|
while (*str && grub_isspace (*str))
|
|
str++;
|
|
|
|
if (*str == '-')
|
|
{
|
|
negative = 1;
|
|
str++;
|
|
}
|
|
|
|
magnitude = grub_strtoull (str, end, base);
|
|
if (negative)
|
|
{
|
|
if (magnitude > (unsigned long) GRUB_LONG_MAX + 1)
|
|
{
|
|
grub_error (GRUB_ERR_OUT_OF_RANGE, "negative overflow");
|
|
return GRUB_LONG_MIN;
|
|
}
|
|
return -((long) magnitude);
|
|
}
|
|
else
|
|
{
|
|
if (magnitude > GRUB_LONG_MAX)
|
|
{
|
|
grub_error (GRUB_ERR_OUT_OF_RANGE, "positive overflow");
|
|
return GRUB_LONG_MAX;
|
|
}
|
|
return (long) magnitude;
|
|
}
|
|
}
|
|
|
|
char *EXPORT_FUNC(grub_strdup) (const char *s);
|
|
char *EXPORT_FUNC(grub_strndup) (const char *s, grub_size_t n);
|
|
void *EXPORT_FUNC(grub_memset) (void *s, int c, grub_size_t n);
|
|
grub_size_t EXPORT_FUNC(grub_strlen) (const char *s);
|
|
int EXPORT_FUNC(grub_printf) (const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
|
|
int EXPORT_FUNC(grub_printf_) (const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
|
|
|
|
extern void (*EXPORT_VAR (grub_xputs)) (const char *str);
|
|
|
|
static inline int
|
|
grub_puts (const char *s)
|
|
{
|
|
const char nl[2] = "\n";
|
|
grub_xputs (s);
|
|
grub_xputs (nl);
|
|
|
|
return 1; /* Cannot fail. */
|
|
}
|
|
|
|
int EXPORT_FUNC(grub_puts_) (const char *s);
|
|
void EXPORT_FUNC(grub_real_dprintf) (const char *file,
|
|
const int line,
|
|
const char *condition,
|
|
const char *fmt, ...) __attribute__ ((format (printf, 4, 5)));
|
|
int EXPORT_FUNC(grub_vprintf) (const char *fmt, va_list args);
|
|
int EXPORT_FUNC(grub_snprintf) (char *str, grub_size_t n, const char *fmt, ...)
|
|
__attribute__ ((format (printf, 3, 4)));
|
|
int EXPORT_FUNC(grub_vsnprintf) (char *str, grub_size_t n, const char *fmt,
|
|
va_list args);
|
|
char *EXPORT_FUNC(grub_xasprintf) (const char *fmt, ...)
|
|
__attribute__ ((format (printf, 1, 2)));
|
|
char *EXPORT_FUNC(grub_xvasprintf) (const char *fmt, va_list args);
|
|
void EXPORT_FUNC(grub_exit) (void) __attribute__ ((noreturn));
|
|
void EXPORT_FUNC(grub_abort) (void) __attribute__ ((noreturn));
|
|
grub_uint64_t EXPORT_FUNC(grub_divmod64) (grub_uint64_t n,
|
|
grub_uint32_t d, grub_uint32_t *r);
|
|
|
|
#if defined(NEED_ENABLE_EXECUTE_STACK) && !defined(GRUB_UTIL)
|
|
void EXPORT_FUNC(__enable_execute_stack) (void *addr);
|
|
#endif
|
|
|
|
#if defined (NEED_REGISTER_FRAME_INFO) && !defined(GRUB_UTIL)
|
|
void EXPORT_FUNC (__register_frame_info) (void);
|
|
void EXPORT_FUNC (__deregister_frame_info) (void);
|
|
#endif
|
|
|
|
/* Inline functions. */
|
|
|
|
static inline unsigned int
|
|
grub_abs (int x)
|
|
{
|
|
if (x < 0)
|
|
return (unsigned int) (-x);
|
|
else
|
|
return (unsigned int) x;
|
|
}
|
|
|
|
static inline long
|
|
grub_max (long x, long y)
|
|
{
|
|
if (x > y)
|
|
return x;
|
|
else
|
|
return y;
|
|
}
|
|
|
|
/* Rounded-up division */
|
|
static inline unsigned int
|
|
grub_div_roundup (unsigned int x, unsigned int y)
|
|
{
|
|
return (x + y - 1) / y;
|
|
}
|
|
|
|
/* Reboot the machine. */
|
|
void EXPORT_FUNC (grub_reboot) (void) __attribute__ ((noreturn));
|
|
|
|
#ifdef GRUB_MACHINE_PCBIOS
|
|
/* Halt the system, using APM if possible. If NO_APM is true, don't
|
|
* use APM even if it is available. */
|
|
void EXPORT_FUNC (grub_halt) (int no_apm) __attribute__ ((noreturn));
|
|
#else
|
|
void EXPORT_FUNC (grub_halt) (void) __attribute__ ((noreturn));
|
|
#endif
|
|
|
|
#ifdef GRUB_MACHINE_EMU
|
|
/* Flag to control module autoloading in normal mode. */
|
|
extern int EXPORT_VAR(grub_no_autoload);
|
|
#else
|
|
#define grub_no_autoload 0
|
|
#endif
|
|
|
|
#endif /* ! GRUB_MISC_HEADER */
|