[mirror_ubuntu-bionic-kernel.git] / include / linux / err.h

#ifndef _LINUX_ERR_H
#define _LINUX_ERR_H

#include <linux/compiler.h>

#include <asm/errno.h>

/*
 * Kernel pointers have redundant information, so we can use a
 * scheme where we can return either an error code or a dentry
 * pointer with the same return value.
 *
 * This should be a per-architecture thing, to allow different
 * error and pointer decisions.
 */
#define MAX_ERRNO	4095

#ifndef __ASSEMBLY__

#define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO)

static inline void * __must_check ERR_PTR(long error)
{
	return (void *) error;
}

static inline long __must_check PTR_ERR(__force const void *ptr)
{
	return (long) ptr;
}

static inline long __must_check IS_ERR(__force const void *ptr)
{
	return IS_ERR_VALUE((unsigned long)ptr);
}

static inline long __must_check IS_ERR_OR_NULL(__force const void *ptr)
{
	return !ptr || IS_ERR_VALUE((unsigned long)ptr);
}

/**
 * ERR_CAST - Explicitly cast an error-valued pointer to another pointer type
 * @ptr: The pointer to cast.
 *
 * Explicitly cast an error-valued pointer to another pointer type in such a
 * way as to make it clear that's what's going on.
 */
static inline void * __must_check ERR_CAST(__force const void *ptr)
{
	/* cast away the const */
	return (void *) ptr;
}

static inline int __must_check PTR_ERR_OR_ZERO(__force const void *ptr)
{
	if (IS_ERR(ptr))
		return PTR_ERR(ptr);
	else
		return 0;
}

/* Deprecated */
#define PTR_RET(p) PTR_ERR_OR_ZERO(p)

#endif

#endif /* _LINUX_ERR_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_ERR_H
	2	#define _LINUX_ERR_H
	3
	4	#include <linux/compiler.h>
	5
	6	#include <asm/errno.h>
	7
	8	/*
	9	* Kernel pointers have redundant information, so we can use a
	10	* scheme where we can return either an error code or a dentry
	11	* pointer with the same return value.
	12	*
	13	* This should be a per-architecture thing, to allow different
	14	* error and pointer decisions.
	15	*/
fa79837d RB	16	#define MAX_ERRNO 4095
fa79837d RB	17
ebba5f9f RD	18	#ifndef __ASSEMBLY__
ebba5f9f RD	19
fa79837d	20	#define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO)
07ab67c8	21
e47103b1	22	static inline void * __must_check ERR_PTR(long error)
1da177e4 LT	23	{
	24	return (void *) error;
	25	}
	26
e7152b97	27	static inline long __must_check PTR_ERR(__force const void *ptr)
1da177e4 LT	28	{
	29	return (long) ptr;
	30	}
	31
e7152b97	32	static inline long __must_check IS_ERR(__force const void *ptr)
1da177e4	33	{
07ab67c8	34	return IS_ERR_VALUE((unsigned long)ptr);
1da177e4 LT	35	}
1da177e4 LT	36
e7152b97	37	static inline long __must_check IS_ERR_OR_NULL(__force const void *ptr)
603c4ba9 PC	38	{
	39	return !ptr \|\| IS_ERR_VALUE((unsigned long)ptr);
	40	}
	41
d1bc8e95 DH	42	/**
	43	* ERR_CAST - Explicitly cast an error-valued pointer to another pointer type
	44	* @ptr: The pointer to cast.
	45	*
	46	* Explicitly cast an error-valued pointer to another pointer type in such a
	47	* way as to make it clear that's what's going on.
	48	*/
e7152b97	49	static inline void * __must_check ERR_CAST(__force const void *ptr)
d1bc8e95 DH	50	{
	51	/* cast away the const */
	52	return (void *) ptr;
	53	}
	54
6e8b8726	55	static inline int __must_check PTR_ERR_OR_ZERO(__force const void *ptr)
fa9ee9c4 UKK	56	{
	57	if (IS_ERR(ptr))
	58	return PTR_ERR(ptr);
	59	else
	60	return 0;
	61	}
	62
6e8b8726 RR	63	/* Deprecated */
	64	#define PTR_RET(p) PTR_ERR_OR_ZERO(p)
	65
ebba5f9f RD	66	#endif
ebba5f9f RD	67
1da177e4	68	#endif /* _LINUX_ERR_H */