Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | */ |
Ralf Baechle | fa79837 | 2006-07-01 04:36:25 -0700 | [diff] [blame] | 16 | #define MAX_ERRNO 4095 |
| 17 | |
Randy Dunlap | ebba5f9 | 2006-09-27 01:50:55 -0700 | [diff] [blame] | 18 | #ifndef __ASSEMBLY__ |
| 19 | |
Ralf Baechle | fa79837 | 2006-07-01 04:36:25 -0700 | [diff] [blame] | 20 | #define IS_ERR_VALUE(x) unlikely((x) >= (unsigned long)-MAX_ERRNO) |
Linus Torvalds | 07ab67c | 2005-05-19 22:43:37 -0700 | [diff] [blame] | 21 | |
Jani Nikula | e47103b | 2010-05-24 14:33:00 -0700 | [diff] [blame] | 22 | static inline void * __must_check ERR_PTR(long error) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | { |
| 24 | return (void *) error; |
| 25 | } |
| 26 | |
Dan Carpenter | e7152b9 | 2013-07-03 15:04:54 -0700 | [diff] [blame] | 27 | static inline long __must_check PTR_ERR(__force const void *ptr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | { |
| 29 | return (long) ptr; |
| 30 | } |
| 31 | |
Dan Carpenter | e7152b9 | 2013-07-03 15:04:54 -0700 | [diff] [blame] | 32 | static inline long __must_check IS_ERR(__force const void *ptr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | { |
Linus Torvalds | 07ab67c | 2005-05-19 22:43:37 -0700 | [diff] [blame] | 34 | return IS_ERR_VALUE((unsigned long)ptr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | } |
| 36 | |
Dan Carpenter | e7152b9 | 2013-07-03 15:04:54 -0700 | [diff] [blame] | 37 | static inline long __must_check IS_ERR_OR_NULL(__force const void *ptr) |
Phil Carmody | 603c4ba | 2009-12-14 18:00:29 -0800 | [diff] [blame] | 38 | { |
| 39 | return !ptr || IS_ERR_VALUE((unsigned long)ptr); |
| 40 | } |
| 41 | |
David Howells | d1bc8e9 | 2008-02-07 00:15:26 -0800 | [diff] [blame] | 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 | */ |
Dan Carpenter | e7152b9 | 2013-07-03 15:04:54 -0700 | [diff] [blame] | 49 | static inline void * __must_check ERR_CAST(__force const void *ptr) |
David Howells | d1bc8e9 | 2008-02-07 00:15:26 -0800 | [diff] [blame] | 50 | { |
| 51 | /* cast away the const */ |
| 52 | return (void *) ptr; |
| 53 | } |
| 54 | |
Rusty Russell | 6e8b872 | 2013-07-15 11:19:32 +0930 | [diff] [blame] | 55 | static inline int __must_check PTR_ERR_OR_ZERO(__force const void *ptr) |
Uwe Kleine-König | fa9ee9c | 2011-03-22 16:34:05 -0700 | [diff] [blame] | 56 | { |
| 57 | if (IS_ERR(ptr)) |
| 58 | return PTR_ERR(ptr); |
| 59 | else |
| 60 | return 0; |
| 61 | } |
| 62 | |
Rusty Russell | 6e8b872 | 2013-07-15 11:19:32 +0930 | [diff] [blame] | 63 | /* Deprecated */ |
| 64 | #define PTR_RET(p) PTR_ERR_OR_ZERO(p) |
| 65 | |
Randy Dunlap | ebba5f9 | 2006-09-27 01:50:55 -0700 | [diff] [blame] | 66 | #endif |
| 67 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 68 | #endif /* _LINUX_ERR_H */ |