blob: 5ede82432d2d26efeb0d402482f6483202db152d [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
9
10/*
11 * Kernel pointers have redundant information, so we can use a
12 * scheme where we can return either an error code or a dentry
13 * pointer with the same return value.
14 *
15 * This should be a per-architecture thing, to allow different
16 * error and pointer decisions.
17 */
18#define MAX_ERRNO 4095
19
20#ifndef __ASSEMBLY__
21
22#define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO)
23
24static inline void *ERR_PTR(long error)
25{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020026 return (void *)(CONFIG_ERR_PTR_OFFSET + error);
William Juul52c07962007-10-31 13:53:06 +010027}
28
29static inline long PTR_ERR(const void *ptr)
30{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020031 return ((long)ptr - CONFIG_ERR_PTR_OFFSET);
William Juul52c07962007-10-31 13:53:06 +010032}
33
34static inline long IS_ERR(const void *ptr)
35{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020036 return IS_ERR_VALUE((unsigned long)PTR_ERR(ptr));
William Juul52c07962007-10-31 13:53:06 +010037}
38
Jagan Teki77ae47b2016-10-30 23:16:10 +053039static inline bool IS_ERR_OR_NULL(const void *ptr)
40{
Simon Goldschmidtb5a044e2019-10-22 21:29:47 +020041 return !ptr || IS_ERR_VALUE((unsigned long)PTR_ERR(ptr));
Jagan Teki77ae47b2016-10-30 23:16:10 +053042}
43
Heiko Schocher5ede9122014-06-24 10:10:02 +020044/**
45 * ERR_CAST - Explicitly cast an error-valued pointer to another pointer type
46 * @ptr: The pointer to cast.
47 *
48 * Explicitly cast an error-valued pointer to another pointer type in such a
49 * way as to make it clear that's what's going on.
50 */
51static inline void * __must_check ERR_CAST(__force const void *ptr)
52{
53 /* cast away the const */
54 return (void *) ptr;
55}
56
William Juul52c07962007-10-31 13:53:06 +010057#endif
58
59#endif /* _LINUX_ERR_H */