blob: 7a0b212c813cbe89a1aa381beee08933be6d143d [file] [log] [blame]
William Juul52c07962007-10-31 13:53:06 +01001#ifndef _LINUX_ERR_H
2#define _LINUX_ERR_H
3
William Juul52c07962007-10-31 13:53:06 +01004#include <linux/compiler.h>
Mike Frysinger11d1a092012-04-09 13:39:55 +00005#include <linux/compat.h>
William Juul52c07962007-10-31 13:53:06 +01006
Masahiro Yamada56a931c2016-09-21 11:28:55 +09007#include <linux/errno.h>
William Juul52c07962007-10-31 13:53:06 +01008
William Juul52c07962007-10-31 13:53:06 +01009/*
10 * Kernel pointers have redundant information, so we can use a
11 * scheme where we can return either an error code or a dentry
12 * pointer with the same return value.
13 *
14 * This should be a per-architecture thing, to allow different
15 * error and pointer decisions.
16 */
17#define MAX_ERRNO 4095
18
19#ifndef __ASSEMBLY__
20
21#define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO)
22
23static inline void *ERR_PTR(long error)
24{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020025 return (void *)(CONFIG_ERR_PTR_OFFSET + error);
William Juul52c07962007-10-31 13:53:06 +010026}
27
28static inline long PTR_ERR(const void *ptr)
29{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020030 return ((long)ptr - CONFIG_ERR_PTR_OFFSET);
William Juul52c07962007-10-31 13:53:06 +010031}
32
33static inline long IS_ERR(const void *ptr)
34{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020035 return IS_ERR_VALUE((unsigned long)PTR_ERR(ptr));
William Juul52c07962007-10-31 13:53:06 +010036}
37
Jagan Teki77ae47b2016-10-30 23:16:10 +053038static inline bool IS_ERR_OR_NULL(const void *ptr)
39{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020040 return !ptr || IS_ERR_VALUE((unsigned long)PTR_ERR(ptr));
Jagan Teki77ae47b2016-10-30 23:16:10 +053041}
42
Heiko Schocher5ede9122014-06-24 10:10:02 +020043/**
44 * ERR_CAST - Explicitly cast an error-valued pointer to another pointer type
45 * @ptr: The pointer to cast.
46 *
47 * Explicitly cast an error-valued pointer to another pointer type in such a
48 * way as to make it clear that's what's going on.
49 */
50static inline void * __must_check ERR_CAST(__force const void *ptr)
51{
52 /* cast away the const */
53 return (void *) ptr;
54}
55
William Juul52c07962007-10-31 13:53:06 +010056#endif
57
58#endif /* _LINUX_ERR_H */