include/linux/kernel.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * NOTE:
   4  *
   5  * This header has combined a lot of unrelated to each other stuff.
   6  * The process of splitting its content is in progress while keeping
   7  * backward compatibility. That's why it's highly recommended NOT to
   8  * include this header inside another header file, especially under
   9  * generic or architectural include/ directory.
  10  */
  11 #ifndef _LINUX_KERNEL_H
  12 #define _LINUX_KERNEL_H
  13
  14 #include <linux/stdarg.h>
  15 #include <linux/align.h>
  16 #include <linux/limits.h>
  17 #include <linux/linkage.h>
  18 #include <linux/stddef.h>
  19 #include <linux/types.h>
  20 #include <linux/compiler.h>
  21 #include <linux/container_of.h>
  22 #include <linux/bitops.h>
  23 #include <linux/kstrtox.h>
  24 #include <linux/log2.h>
  25 #include <linux/math.h>
  26 #include <linux/minmax.h>
  27 #include <linux/typecheck.h>
  28 #include <linux/panic.h>
  29 #include <linux/printk.h>
  30 #include <linux/build_bug.h>
  31 #include <linux/static_call_types.h>
  32 #include <linux/instruction_pointer.h>
  33 #include <asm/byteorder.h>
  34
  35 #include <uapi/linux/kernel.h>
  36
  37 #define STACK_MAGIC     0xdeadbeef
  38
  39 /**
  40  * REPEAT_BYTE - repeat the value @x multiple times as an unsigned long value
  41  * @x: value to repeat
  42  *
  43  * NOTE: @x is not checked for > 0xff; larger values produce odd results.
  44  */
  45 #define REPEAT_BYTE(x)  ((~0ul / 0xff) * (x))
  46
  47 /* generic data direction definitions */
  48 #define READ                    0
  49 #define WRITE                   1
  50
  51 /**
  52  * ARRAY_SIZE - get the number of elements in array @arr
  53  * @arr: array to be sized
  54  */
  55 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  56
  57 #define PTR_IF(cond, ptr)       ((cond) ? (ptr) : NULL)
  58
  59 #define u64_to_user_ptr(x) (            \
  60 {                                       \
  61         typecheck(u64, (x));            \
  62         (void __user *)(uintptr_t)(x);  \
  63 }                                       \
  64 )
  65
  66 /**
  67  * lower_48_bits() - return bits 0-47 of a number
  68  * @n: the number we're accessing
  69  */
  70 static inline u64 lower_48_bits(u64 n)
  71 {
  72         return n & ((1ull << 48) - 1);
  73 }
  74
  75 /**
  76  * upper_32_bits - return bits 32-63 of a number
  77  * @n: the number we're accessing
  78  *
  79  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
  80  * the "right shift count >= width of type" warning when that quantity is
  81  * 32-bits.
  82  */
  83 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
  84
  85 /**
  86  * lower_32_bits - return bits 0-31 of a number
  87  * @n: the number we're accessing
  88  */
  89 #define lower_32_bits(n) ((u32)((n) & 0xffffffff))
  90
  91 /**
  92  * upper_16_bits - return bits 16-31 of a number
  93  * @n: the number we're accessing
  94  */
  95 #define upper_16_bits(n) ((u16)((n) >> 16))
  96
  97 /**
  98  * lower_16_bits - return bits 0-15 of a number
  99  * @n: the number we're accessing
 100  */
 101 #define lower_16_bits(n) ((u16)((n) & 0xffff))
 102
 103 struct completion;
 104 struct user;
 105
 106 #ifdef CONFIG_PREEMPT_VOLUNTARY_BUILD
 107
 108 extern int __cond_resched(void);
 109 # define might_resched() __cond_resched()
 110
 111 #elif defined(CONFIG_PREEMPT_DYNAMIC) && defined(CONFIG_HAVE_PREEMPT_DYNAMIC_CALL)
 112
 113 extern int __cond_resched(void);
 114
 115 DECLARE_STATIC_CALL(might_resched, __cond_resched);
 116
 117 static __always_inline void might_resched(void)
 118 {
 119         static_call_mod(might_resched)();
 120 }
 121
 122 #elif defined(CONFIG_PREEMPT_DYNAMIC) && defined(CONFIG_HAVE_PREEMPT_DYNAMIC_KEY)
 123
 124 extern int dynamic_might_resched(void);
 125 # define might_resched() dynamic_might_resched()
 126
 127 #else
 128
 129 # define might_resched() do { } while (0)
 130
 131 #endif /* CONFIG_PREEMPT_* */
 132
 133 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
 134 extern void __might_resched(const char *file, int line, unsigned int offsets);
 135 extern void __might_sleep(const char *file, int line);
 136 extern void __cant_sleep(const char *file, int line, int preempt_offset);
 137 extern void __cant_migrate(const char *file, int line);
 138
 139 /**
 140  * might_sleep - annotation for functions that can sleep
 141  *
 142  * this macro will print a stack trace if it is executed in an atomic
 143  * context (spinlock, irq-handler, ...). Additional sections where blocking is
 144  * not allowed can be annotated with non_block_start() and non_block_end()
 145  * pairs.
 146  *
 147  * This is a useful debugging help to be able to catch problems early and not
 148  * be bitten later when the calling function happens to sleep when it is not
 149  * supposed to.
 150  */
 151 # define might_sleep() \
 152         do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
 153 /**
 154  * cant_sleep - annotation for functions that cannot sleep
 155  *
 156  * this macro will print a stack trace if it is executed with preemption enabled
 157  */
 158 # define cant_sleep() \
 159         do { __cant_sleep(__FILE__, __LINE__, 0); } while (0)
 160 # define sched_annotate_sleep() (current->task_state_change = 0)
 161
 162 /**
 163  * cant_migrate - annotation for functions that cannot migrate
 164  *
 165  * Will print a stack trace if executed in code which is migratable
 166  */
 167 # define cant_migrate()                                                 \
 168         do {                                                            \
 169                 if (IS_ENABLED(CONFIG_SMP))                             \
 170                         __cant_migrate(__FILE__, __LINE__);             \
 171         } while (0)
 172
 173 /**
 174  * non_block_start - annotate the start of section where sleeping is prohibited
 175  *
 176  * This is on behalf of the oom reaper, specifically when it is calling the mmu
 177  * notifiers. The problem is that if the notifier were to block on, for example,
 178  * mutex_lock() and if the process which holds that mutex were to perform a
 179  * sleeping memory allocation, the oom reaper is now blocked on completion of
 180  * that memory allocation. Other blocking calls like wait_event() pose similar
 181  * issues.
 182  */
 183 # define non_block_start() (current->non_block_count++)
 184 /**
 185  * non_block_end - annotate the end of section where sleeping is prohibited
 186  *
 187  * Closes a section opened by non_block_start().
 188  */
 189 # define non_block_end() WARN_ON(current->non_block_count-- == 0)
 190 #else
 191   static inline void __might_resched(const char *file, int line,
 192                                      unsigned int offsets) { }
 193 static inline void __might_sleep(const char *file, int line) { }
 194 # define might_sleep() do { might_resched(); } while (0)
 195 # define cant_sleep() do { } while (0)
 196 # define cant_migrate()         do { } while (0)
 197 # define sched_annotate_sleep() do { } while (0)
 198 # define non_block_start() do { } while (0)
 199 # define non_block_end() do { } while (0)
 200 #endif
 201
 202 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
 203
 204 #if defined(CONFIG_MMU) && \
 205         (defined(CONFIG_PROVE_LOCKING) || defined(CONFIG_DEBUG_ATOMIC_SLEEP))
 206 #define might_fault() __might_fault(__FILE__, __LINE__)
 207 void __might_fault(const char *file, int line);
 208 #else
 209 static inline void might_fault(void) { }
 210 #endif
 211
 212 void do_exit(long error_code) __noreturn;
 213
 214 extern int num_to_str(char *buf, int size,
 215                       unsigned long long num, unsigned int width);
 216
 217 /* lib/printf utilities */
 218
 219 extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
 220 extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
 221 extern __printf(3, 4)
 222 int snprintf(char *buf, size_t size, const char *fmt, ...);
 223 extern __printf(3, 0)
 224 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
 225 extern __printf(3, 4)
 226 int scnprintf(char *buf, size_t size, const char *fmt, ...);
 227 extern __printf(3, 0)
 228 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
 229 extern __printf(2, 3) __malloc
 230 char *kasprintf(gfp_t gfp, const char *fmt, ...);
 231 extern __printf(2, 0) __malloc
 232 char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
 233 extern __printf(2, 0)
 234 const char *kvasprintf_const(gfp_t gfp, const char *fmt, va_list args);
 235
 236 extern __scanf(2, 3)
 237 int sscanf(const char *, const char *, ...);
 238 extern __scanf(2, 0)
 239 int vsscanf(const char *, const char *, va_list);
 240
 241 extern int no_hash_pointers_enable(char *str);
 242
 243 extern int get_option(char **str, int *pint);
 244 extern char *get_options(const char *str, int nints, int *ints);
 245 extern unsigned long long memparse(const char *ptr, char **retptr);
 246 extern bool parse_option_str(const char *str, const char *option);
 247 extern char *next_arg(char *args, char **param, char **val);
 248
 249 extern int core_kernel_text(unsigned long addr);
 250 extern int __kernel_text_address(unsigned long addr);
 251 extern int kernel_text_address(unsigned long addr);
 252 extern int func_ptr_is_kernel_text(void *ptr);
 253
 254 extern void bust_spinlocks(int yes);
 255
 256 extern int root_mountflags;
 257
 258 extern bool early_boot_irqs_disabled;
 259
 260 /*
 261  * Values used for system_state. Ordering of the states must not be changed
 262  * as code checks for <, <=, >, >= STATE.
 263  */
 264 extern enum system_states {
 265         SYSTEM_BOOTING,
 266         SYSTEM_SCHEDULING,
 267         SYSTEM_FREEING_INITMEM,
 268         SYSTEM_RUNNING,
 269         SYSTEM_HALT,
 270         SYSTEM_POWER_OFF,
 271         SYSTEM_RESTART,
 272         SYSTEM_SUSPEND,
 273 } system_state;
 274
 275 extern const char hex_asc[];
 276 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
 277 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
 278
 279 static inline char *hex_byte_pack(char *buf, u8 byte)
 280 {
 281         *buf++ = hex_asc_hi(byte);
 282         *buf++ = hex_asc_lo(byte);
 283         return buf;
 284 }
 285
 286 extern const char hex_asc_upper[];
 287 #define hex_asc_upper_lo(x)     hex_asc_upper[((x) & 0x0f)]
 288 #define hex_asc_upper_hi(x)     hex_asc_upper[((x) & 0xf0) >> 4]
 289
 290 static inline char *hex_byte_pack_upper(char *buf, u8 byte)
 291 {
 292         *buf++ = hex_asc_upper_hi(byte);
 293         *buf++ = hex_asc_upper_lo(byte);
 294         return buf;
 295 }
 296
 297 extern int hex_to_bin(char ch);
 298 extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
 299 extern char *bin2hex(char *dst, const void *src, size_t count);
 300
 301 bool mac_pton(const char *s, u8 *mac);
 302
 303 /*
 304  * General tracing related utility functions - trace_printk(),
 305  * tracing_on/tracing_off and tracing_start()/tracing_stop
 306  *
 307  * Use tracing_on/tracing_off when you want to quickly turn on or off
 308  * tracing. It simply enables or disables the recording of the trace events.
 309  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
 310  * file, which gives a means for the kernel and userspace to interact.
 311  * Place a tracing_off() in the kernel where you want tracing to end.
 312  * From user space, examine the trace, and then echo 1 > tracing_on
 313  * to continue tracing.
 314  *
 315  * tracing_stop/tracing_start has slightly more overhead. It is used
 316  * by things like suspend to ram where disabling the recording of the
 317  * trace is not enough, but tracing must actually stop because things
 318  * like calling smp_processor_id() may crash the system.
 319  *
 320  * Most likely, you want to use tracing_on/tracing_off.
 321  */
 322
 323 enum ftrace_dump_mode {
 324         DUMP_NONE,
 325         DUMP_ALL,
 326         DUMP_ORIG,
 327 };
 328
 329 #ifdef CONFIG_TRACING
 330 void tracing_on(void);
 331 void tracing_off(void);
 332 int tracing_is_on(void);
 333 void tracing_snapshot(void);
 334 void tracing_snapshot_alloc(void);
 335
 336 extern void tracing_start(void);
 337 extern void tracing_stop(void);
 338
 339 static inline __printf(1, 2)
 340 void ____trace_printk_check_format(const char *fmt, ...)
 341 {
 342 }
 343 #define __trace_printk_check_format(fmt, args...)                       \
 344 do {                                                                    \
 345         if (0)                                                          \
 346                 ____trace_printk_check_format(fmt, ##args);             \
 347 } while (0)
 348
 349 /**
 350  * trace_printk - printf formatting in the ftrace buffer
 351  * @fmt: the printf format for printing
 352  *
 353  * Note: __trace_printk is an internal function for trace_printk() and
 354  *       the @ip is passed in via the trace_printk() macro.
 355  *
 356  * This function allows a kernel developer to debug fast path sections
 357  * that printk is not appropriate for. By scattering in various
 358  * printk like tracing in the code, a developer can quickly see
 359  * where problems are occurring.
 360  *
 361  * This is intended as a debugging tool for the developer only.
 362  * Please refrain from leaving trace_printks scattered around in
 363  * your code. (Extra memory is used for special buffers that are
 364  * allocated when trace_printk() is used.)
 365  *
 366  * A little optimization trick is done here. If there's only one
 367  * argument, there's no need to scan the string for printf formats.
 368  * The trace_puts() will suffice. But how can we take advantage of
 369  * using trace_puts() when trace_printk() has only one argument?
 370  * By stringifying the args and checking the size we can tell
 371  * whether or not there are args. __stringify((__VA_ARGS__)) will
 372  * turn into "()\0" with a size of 3 when there are no args, anything
 373  * else will be bigger. All we need to do is define a string to this,
 374  * and then take its size and compare to 3. If it's bigger, use
 375  * do_trace_printk() otherwise, optimize it to trace_puts(). Then just
 376  * let gcc optimize the rest.
 377  */
 378
 379 #define trace_printk(fmt, ...)                          \
 380 do {                                                    \
 381         char _______STR[] = __stringify((__VA_ARGS__)); \
 382         if (sizeof(_______STR) > 3)                     \
 383                 do_trace_printk(fmt, ##__VA_ARGS__);    \
 384         else                                            \
 385                 trace_puts(fmt);                        \
 386 } while (0)
 387
 388 #define do_trace_printk(fmt, args...)                                   \
 389 do {                                                                    \
 390         static const char *trace_printk_fmt __used                      \
 391                 __section("__trace_printk_fmt") =                       \
 392                 __builtin_constant_p(fmt) ? fmt : NULL;                 \
 393                                                                         \
 394         __trace_printk_check_format(fmt, ##args);                       \
 395                                                                         \
 396         if (__builtin_constant_p(fmt))                                  \
 397                 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);   \
 398         else                                                            \
 399                 __trace_printk(_THIS_IP_, fmt, ##args);                 \
 400 } while (0)
 401
 402 extern __printf(2, 3)
 403 int __trace_bprintk(unsigned long ip, const char *fmt, ...);
 404
 405 extern __printf(2, 3)
 406 int __trace_printk(unsigned long ip, const char *fmt, ...);
 407
 408 /**
 409  * trace_puts - write a string into the ftrace buffer
 410  * @str: the string to record
 411  *
 412  * Note: __trace_bputs is an internal function for trace_puts and
 413  *       the @ip is passed in via the trace_puts macro.
 414  *
 415  * This is similar to trace_printk() but is made for those really fast
 416  * paths that a developer wants the least amount of "Heisenbug" effects,
 417  * where the processing of the print format is still too much.
 418  *
 419  * This function allows a kernel developer to debug fast path sections
 420  * that printk is not appropriate for. By scattering in various
 421  * printk like tracing in the code, a developer can quickly see
 422  * where problems are occurring.
 423  *
 424  * This is intended as a debugging tool for the developer only.
 425  * Please refrain from leaving trace_puts scattered around in
 426  * your code. (Extra memory is used for special buffers that are
 427  * allocated when trace_puts() is used.)
 428  *
 429  * Returns: 0 if nothing was written, positive # if string was.
 430  *  (1 when __trace_bputs is used, strlen(str) when __trace_puts is used)
 431  */
 432
 433 #define trace_puts(str) ({                                              \
 434         static const char *trace_printk_fmt __used                      \
 435                 __section("__trace_printk_fmt") =                       \
 436                 __builtin_constant_p(str) ? str : NULL;                 \
 437                                                                         \
 438         if (__builtin_constant_p(str))                                  \
 439                 __trace_bputs(_THIS_IP_, trace_printk_fmt);             \
 440         else                                                            \
 441                 __trace_puts(_THIS_IP_, str, strlen(str));              \
 442 })
 443 extern int __trace_bputs(unsigned long ip, const char *str);
 444 extern int __trace_puts(unsigned long ip, const char *str, int size);
 445
 446 extern void trace_dump_stack(int skip);
 447
 448 /*
 449  * The double __builtin_constant_p is because gcc will give us an error
 450  * if we try to allocate the static variable to fmt if it is not a
 451  * constant. Even with the outer if statement.
 452  */
 453 #define ftrace_vprintk(fmt, vargs)                                      \
 454 do {                                                                    \
 455         if (__builtin_constant_p(fmt)) {                                \
 456                 static const char *trace_printk_fmt __used              \
 457                   __section("__trace_printk_fmt") =                     \
 458                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 459                                                                         \
 460                 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);  \
 461         } else                                                          \
 462                 __ftrace_vprintk(_THIS_IP_, fmt, vargs);                \
 463 } while (0)
 464
 465 extern __printf(2, 0) int
 466 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
 467
 468 extern __printf(2, 0) int
 469 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
 470
 471 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
 472 #else
 473 static inline void tracing_start(void) { }
 474 static inline void tracing_stop(void) { }
 475 static inline void trace_dump_stack(int skip) { }
 476
 477 static inline void tracing_on(void) { }
 478 static inline void tracing_off(void) { }
 479 static inline int tracing_is_on(void) { return 0; }
 480 static inline void tracing_snapshot(void) { }
 481 static inline void tracing_snapshot_alloc(void) { }
 482
 483 static inline __printf(1, 2)
 484 int trace_printk(const char *fmt, ...)
 485 {
 486         return 0;
 487 }
 488 static __printf(1, 0) inline int
 489 ftrace_vprintk(const char *fmt, va_list ap)
 490 {
 491         return 0;
 492 }
 493 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
 494 #endif /* CONFIG_TRACING */
 495
 496 /* This counts to 12. Any more, it will return 13th argument. */
 497 #define __COUNT_ARGS(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _n, X...) _n
 498 #define COUNT_ARGS(X...) __COUNT_ARGS(, ##X, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
 499
 500 #define __CONCAT(a, b) a ## b
 501 #define CONCATENATE(a, b) __CONCAT(a, b)
 502
 503 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
 504 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 505 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
 506 #endif
 507
 508 /* Permissions on a sysfs file: you didn't miss the 0 prefix did you? */
 509 #define VERIFY_OCTAL_PERMISSIONS(perms)                                         \
 510         (BUILD_BUG_ON_ZERO((perms) < 0) +                                       \
 511          BUILD_BUG_ON_ZERO((perms) > 0777) +                                    \
 512          /* USER_READABLE >= GROUP_READABLE >= OTHER_READABLE */                \
 513          BUILD_BUG_ON_ZERO((((perms) >> 6) & 4) < (((perms) >> 3) & 4)) +       \
 514          BUILD_BUG_ON_ZERO((((perms) >> 3) & 4) < ((perms) & 4)) +              \
 515          /* USER_WRITABLE >= GROUP_WRITABLE */                                  \
 516          BUILD_BUG_ON_ZERO((((perms) >> 6) & 2) < (((perms) >> 3) & 2)) +       \
 517          /* OTHER_WRITABLE?  Generally considered a bad idea. */                \
 518          BUILD_BUG_ON_ZERO((perms) & 2) +                                       \
 519          (perms))
 520 #endif