William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 1 | #ifndef _LINUX_ERR_H |
| 2 | #define _LINUX_ERR_H |
| 3 | |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 4 | #include <linux/compiler.h> |
Mike Frysinger | 11d1a09 | 2012-04-09 13:39:55 +0000 | [diff] [blame] | 5 | #include <linux/compat.h> |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 6 | |
Masahiro Yamada | 56a931c | 2016-09-21 11:28:55 +0900 | [diff] [blame] | 7 | #include <linux/errno.h> |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 8 | |
| 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 | |
| 24 | static inline void *ERR_PTR(long error) |
| 25 | { |
Simon Goldschmidt | b5a044e | 2019-10-22 21:29:47 +0200 | [diff] [blame] | 26 | return (void *)(CONFIG_ERR_PTR_OFFSET + error); |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 27 | } |
| 28 | |
| 29 | static inline long PTR_ERR(const void *ptr) |
| 30 | { |
Simon Goldschmidt | b5a044e | 2019-10-22 21:29:47 +0200 | [diff] [blame] | 31 | return ((long)ptr - CONFIG_ERR_PTR_OFFSET); |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 32 | } |
| 33 | |
| 34 | static inline long IS_ERR(const void *ptr) |
| 35 | { |
Simon Goldschmidt | b5a044e | 2019-10-22 21:29:47 +0200 | [diff] [blame] | 36 | return IS_ERR_VALUE((unsigned long)PTR_ERR(ptr)); |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 37 | } |
| 38 | |
Jagan Teki | 77ae47b | 2016-10-30 23:16:10 +0530 | [diff] [blame] | 39 | static inline bool IS_ERR_OR_NULL(const void *ptr) |
| 40 | { |
Simon Goldschmidt | b5a044e | 2019-10-22 21:29:47 +0200 | [diff] [blame] | 41 | return !ptr || IS_ERR_VALUE((unsigned long)PTR_ERR(ptr)); |
Jagan Teki | 77ae47b | 2016-10-30 23:16:10 +0530 | [diff] [blame] | 42 | } |
| 43 | |
Heiko Schocher | 5ede912 | 2014-06-24 10:10:02 +0200 | [diff] [blame] | 44 | /** |
| 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 | */ |
| 51 | static inline void * __must_check ERR_CAST(__force const void *ptr) |
| 52 | { |
| 53 | /* cast away the const */ |
| 54 | return (void *) ptr; |
| 55 | } |
| 56 | |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 57 | #endif |
| 58 | |
| 59 | #endif /* _LINUX_ERR_H */ |