forked from mirrors/linux
fad7c90209
Initially, commitfa9ee9c4b9("include/linux/err.h: add a function to cast error-pointers to a return value") from Uwe Kleine-König introduced PTR_RET in 03/2011. Then, in 07/2013, commit6e8b8726ad("PTR_RET is now PTR_ERR_OR_ZERO") from Rusty Russell renamed PTR_RET to PTR_ERR_OR_ZERO, and left PTR_RET as deprecated-marked alias. After six years since the renaming and various repeated cleanups in the meantime, it is time to finally remove the deprecated PTR_RET for good. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Acked-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
67 lines
1.5 KiB
C
67 lines
1.5 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _LINUX_ERR_H
|
|
#define _LINUX_ERR_H
|
|
|
|
#include <linux/compiler.h>
|
|
#include <linux/types.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 normal
|
|
* 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((unsigned long)(void *)(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 bool __must_check IS_ERR(__force const void *ptr)
|
|
{
|
|
return IS_ERR_VALUE((unsigned long)ptr);
|
|
}
|
|
|
|
static inline bool __must_check IS_ERR_OR_NULL(__force const void *ptr)
|
|
{
|
|
return unlikely(!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;
|
|
}
|
|
|
|
#endif
|
|
|
|
#endif /* _LINUX_ERR_H */
|