/*
 * Copyright (c) 2005 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup kernel_generic
 * @{
 */
/** @file
 */

#ifndef KERN_MACROS_H_
#define KERN_MACROS_H_

#ifndef __ASSEMBLER__

#include <stdint.h>
#include <trace.h>

/** Return true if the intervals overlap.
 *
 * @param s1  Start address of the first interval.
 * @param sz1 Size of the first interval.
 * @param s2  Start address of the second interval.
 * @param sz2 Size of the second interval.
 *
 */
_NO_TRACE static inline int overlaps(uint64_t s1, uint64_t sz1, uint64_t s2,
    uint64_t sz2)
{
	uint64_t e1 = s1 + sz1 - 1;
	uint64_t e2 = s2 + sz2 - 1;

	/* both sizes are non-zero */
	if (sz1 && sz2)
		return ((s1 <= e2) && (s2 <= e1));

	/* one size is non-zero */
	if (sz2)
		return ((s1 >= s2) && (s1 <= e2));

	if (sz1)
		return ((s2 >= s1) && (s2 <= e1));

	/* both are zero */
	return (s1 == s2);
}

/** Return true if the second interval is within the first interval.
 *
 * @param s1  Start address of the first interval.
 * @param sz1 Size of the first interval.
 * @param s2  Start address of the second interval.
 * @param sz2 Size of the second interval.
 *
 */
_NO_TRACE static inline int iswithin(uint64_t s1, uint64_t sz1, uint64_t s2,
    uint64_t sz2)
{
	uint64_t e1;
	uint64_t e2;

	/* Handle the two corner cases when either sz1 or sz2 are zero. */
	if (sz1 == 0)
		return (s1 == s2) && (sz2 == 0);

	e1 = s1 + sz1 - 1;
	if (sz2 == 0)
		return (s1 <= s2) && (s2 <= e1);

	e2 = s2 + sz2 - 1;

	/* e1 and e2 are end addresses, the sum is imune to overflow */
	return ((s1 <= s2) && (e1 >= e2));
}

#endif /* __ASSEMBLER__ */

#define ispwr2(x)  (((x) & ((x) - 1)) == 0)

#define isdigit(d)     (((d) >= '0') && ((d) <= '9'))
#define islower(c)     (((c) >= 'a') && ((c) <= 'z'))
#define isupper(c)     (((c) >= 'A') && ((c) <= 'Z'))
#define isalpha(c)     (is_lower((c)) || is_upper((c)))
#define isalphanum(c)  (is_alpha((c)) || is_digit((c)))
#define isspace(c) \
	(((c) == ' ') || ((c) == '\t') || ((c) == '\n') || ((c) == '\r'))

#define min(a, b)  ((a) < (b) ? (a) : (b))
#define max(a, b)  ((a) > (b) ? (a) : (b))

#define min3(a, b, c)  ((a) < (b) ? (min(a, c)) : (min(b, c)))
#define max3(a, b, c)  ((a) > (b) ? (max(a, c)) : (max(b, c)))

/* Compute overlapping of physical addresses */
#define PA_OVERLAPS(x, szx, y, szy) \
	overlaps(KA2PA((x)), (szx), KA2PA((y)), (szy))

#define PFN2ADDR(frame)  ((frame) << FRAME_WIDTH)
#define ADDR2PFN(addr)   ((addr) >> FRAME_WIDTH)

#define FRAMES2SIZE(frames)  ((frames) << FRAME_WIDTH)
#define SIZE2FRAMES(size) \
	(((size) == 0) ? 0 : ((((size) - 1) >> FRAME_WIDTH) + 1))

#define KiB2SIZE(kb)  ((kb) << 10)
#define MiB2SIZE(mb)  ((mb) << 20)

#define STRING(arg)      STRING_ARG(arg)
#define STRING_ARG(arg)  #arg

#define LOWER32(arg)  (((uint64_t) (arg)) & UINT32_C(0xffffffff))
#define UPPER32(arg)  (((((uint64_t) arg)) >> 32) & UINT32_C(0xffffffff))

#define MERGE_LOUP32(lo, up) \
	((((uint64_t) (lo)) & UINT32_C(0xffffffff)) \
	    | ((((uint64_t) (up)) & UINT32_C(0xffffffff)) << 32))

/* Test for sum overflow. */
#define overflows(a, b) \
	((a) + (b) < (a))

/* Test for sum overflow into positive numbers. */
#define overflows_into_positive(a, b) \
	(overflows((a), (b)) && ((a) + (b) > 0))

/** Pseudorandom generator
 *
 * A pretty standard linear congruential pseudorandom
 * number generator (m = 2^32 or 2^64 depending on architecture).
 *
 */
#define RANDI(seed) \
	({ \
		(seed) = 1103515245 * (seed) + 12345; \
		(seed); \
	})

#define member_to_inst(ptr_member, type, member_identif) \
	((type *) (((void *) (ptr_member)) - \
	    ((void *) &(((type *) 0)->member_identif))))

#endif

/** @}
 */
