include/linux/sched/mm.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_SCHED_MM_H
   3 #define _LINUX_SCHED_MM_H
   4
   5 #include <linux/kernel.h>
   6 #include <linux/atomic.h>
   7 #include <linux/sched.h>
   8 #include <linux/mm_types.h>
   9 #include <linux/gfp.h>
  10 #include <linux/sync_core.h>
  11
  12 /*
  13  * Routines for handling mm_structs
  14  */
  15 extern struct mm_struct *mm_alloc(void);
  16
  17 /**
  18  * mmgrab() - Pin a &struct mm_struct.
  19  * @mm: The &struct mm_struct to pin.
  20  *
  21  * Make sure that @mm will not get freed even after the owning task
  22  * exits. This doesn't guarantee that the associated address space
  23  * will still exist later on and mmget_not_zero() has to be used before
  24  * accessing it.
  25  *
  26  * This is a preferred way to pin @mm for a longer/unbounded amount
  27  * of time.
  28  *
  29  * Use mmdrop() to release the reference acquired by mmgrab().
  30  *
  31  * See also <Documentation/vm/active_mm.rst> for an in-depth explanation
  32  * of &mm_struct.mm_count vs &mm_struct.mm_users.
  33  */
  34 static inline void mmgrab(struct mm_struct *mm)
  35 {
  36         atomic_inc(&mm->mm_count);
  37 }
  38
  39 extern void __mmdrop(struct mm_struct *mm);
  40
  41 static inline void mmdrop(struct mm_struct *mm)
  42 {
  43         /*
  44          * The implicit full barrier implied by atomic_dec_and_test() is
  45          * required by the membarrier system call before returning to
  46          * user-space, after storing to rq->curr.
  47          */
  48         if (unlikely(atomic_dec_and_test(&mm->mm_count)))
  49                 __mmdrop(mm);
  50 }
  51
  52 /**
  53  * mmget() - Pin the address space associated with a &struct mm_struct.
  54  * @mm: The address space to pin.
  55  *
  56  * Make sure that the address space of the given &struct mm_struct doesn't
  57  * go away. This does not protect against parts of the address space being
  58  * modified or freed, however.
  59  *
  60  * Never use this function to pin this address space for an
  61  * unbounded/indefinite amount of time.
  62  *
  63  * Use mmput() to release the reference acquired by mmget().
  64  *
  65  * See also <Documentation/vm/active_mm.rst> for an in-depth explanation
  66  * of &mm_struct.mm_count vs &mm_struct.mm_users.
  67  */
  68 static inline void mmget(struct mm_struct *mm)
  69 {
  70         atomic_inc(&mm->mm_users);
  71 }
  72
  73 static inline bool mmget_not_zero(struct mm_struct *mm)
  74 {
  75         return atomic_inc_not_zero(&mm->mm_users);
  76 }
  77
  78 /* mmput gets rid of the mappings and all user-space */
  79 extern void mmput(struct mm_struct *);
  80 #ifdef CONFIG_MMU
  81 /* same as above but performs the slow path from the async context. Can
  82  * be called from the atomic context as well
  83  */
  84 void mmput_async(struct mm_struct *);
  85 #endif
  86
  87 /* Grab a reference to a task's mm, if it is not already going away */
  88 extern struct mm_struct *get_task_mm(struct task_struct *task);
  89 /*
  90  * Grab a reference to a task's mm, if it is not already going away
  91  * and ptrace_may_access with the mode parameter passed to it
  92  * succeeds.
  93  */
  94 extern struct mm_struct *mm_access(struct task_struct *task, unsigned int mode);
  95 /* Remove the current tasks stale references to the old mm_struct on exit() */
  96 extern void exit_mm_release(struct task_struct *, struct mm_struct *);
  97 /* Remove the current tasks stale references to the old mm_struct on exec() */
  98 extern void exec_mm_release(struct task_struct *, struct mm_struct *);
  99
 100 #ifdef CONFIG_MEMCG
 101 extern void mm_update_next_owner(struct mm_struct *mm);
 102 #else
 103 static inline void mm_update_next_owner(struct mm_struct *mm)
 104 {
 105 }
 106 #endif /* CONFIG_MEMCG */
 107
 108 #ifdef CONFIG_MMU
 109 #ifndef arch_get_mmap_end
 110 #define arch_get_mmap_end(addr) (TASK_SIZE)
 111 #endif
 112
 113 #ifndef arch_get_mmap_base
 114 #define arch_get_mmap_base(addr, base) (base)
 115 #endif
 116
 117 extern void arch_pick_mmap_layout(struct mm_struct *mm,
 118                                   struct rlimit *rlim_stack);
 119 extern unsigned long
 120 arch_get_unmapped_area(struct file *, unsigned long, unsigned long,
 121                        unsigned long, unsigned long);
 122 extern unsigned long
 123 arch_get_unmapped_area_topdown(struct file *filp, unsigned long addr,
 124                           unsigned long len, unsigned long pgoff,
 125                           unsigned long flags);
 126 #else
 127 static inline void arch_pick_mmap_layout(struct mm_struct *mm,
 128                                          struct rlimit *rlim_stack) {}
 129 #endif
 130
 131 static inline bool in_vfork(struct task_struct *tsk)
 132 {
 133         bool ret;
 134
 135         /*
 136          * need RCU to access ->real_parent if CLONE_VM was used along with
 137          * CLONE_PARENT.
 138          *
 139          * We check real_parent->mm == tsk->mm because CLONE_VFORK does not
 140          * imply CLONE_VM
 141          *
 142          * CLONE_VFORK can be used with CLONE_PARENT/CLONE_THREAD and thus
 143          * ->real_parent is not necessarily the task doing vfork(), so in
 144          * theory we can't rely on task_lock() if we want to dereference it.
 145          *
 146          * And in this case we can't trust the real_parent->mm == tsk->mm
 147          * check, it can be false negative. But we do not care, if init or
 148          * another oom-unkillable task does this it should blame itself.
 149          */
 150         rcu_read_lock();
 151         ret = tsk->vfork_done &&
 152                         rcu_dereference(tsk->real_parent)->mm == tsk->mm;
 153         rcu_read_unlock();
 154
 155         return ret;
 156 }
 157
 158 /*
 159  * Applies per-task gfp context to the given allocation flags.
 160  * PF_MEMALLOC_NOIO implies GFP_NOIO
 161  * PF_MEMALLOC_NOFS implies GFP_NOFS
 162  */
 163 static inline gfp_t current_gfp_context(gfp_t flags)
 164 {
 165         unsigned int pflags = READ_ONCE(current->flags);
 166
 167         if (unlikely(pflags & (PF_MEMALLOC_NOIO | PF_MEMALLOC_NOFS))) {
 168                 /*
 169                  * NOIO implies both NOIO and NOFS and it is a weaker context
 170                  * so always make sure it makes precedence
 171                  */
 172                 if (pflags & PF_MEMALLOC_NOIO)
 173                         flags &= ~(__GFP_IO | __GFP_FS);
 174                 else if (pflags & PF_MEMALLOC_NOFS)
 175                         flags &= ~__GFP_FS;
 176         }
 177         return flags;
 178 }
 179
 180 #ifdef CONFIG_LOCKDEP
 181 extern void __fs_reclaim_acquire(void);
 182 extern void __fs_reclaim_release(void);
 183 extern void fs_reclaim_acquire(gfp_t gfp_mask);
 184 extern void fs_reclaim_release(gfp_t gfp_mask);
 185 #else
 186 static inline void __fs_reclaim_acquire(void) { }
 187 static inline void __fs_reclaim_release(void) { }
 188 static inline void fs_reclaim_acquire(gfp_t gfp_mask) { }
 189 static inline void fs_reclaim_release(gfp_t gfp_mask) { }
 190 #endif
 191
 192 /**
 193  * memalloc_noio_save - Marks implicit GFP_NOIO allocation scope.
 194  *
 195  * This functions marks the beginning of the GFP_NOIO allocation scope.
 196  * All further allocations will implicitly drop __GFP_IO flag and so
 197  * they are safe for the IO critical section from the allocation recursion
 198  * point of view. Use memalloc_noio_restore to end the scope with flags
 199  * returned by this function.
 200  *
 201  * This function is safe to be used from any context.
 202  */
 203 static inline unsigned int memalloc_noio_save(void)
 204 {
 205         unsigned int flags = current->flags & PF_MEMALLOC_NOIO;
 206         current->flags |= PF_MEMALLOC_NOIO;
 207         return flags;
 208 }
 209
 210 /**
 211  * memalloc_noio_restore - Ends the implicit GFP_NOIO scope.
 212  * @flags: Flags to restore.
 213  *
 214  * Ends the implicit GFP_NOIO scope started by memalloc_noio_save function.
 215  * Always make sure that the given flags is the return value from the
 216  * pairing memalloc_noio_save call.
 217  */
 218 static inline void memalloc_noio_restore(unsigned int flags)
 219 {
 220         current->flags = (current->flags & ~PF_MEMALLOC_NOIO) | flags;
 221 }
 222
 223 /**
 224  * memalloc_nofs_save - Marks implicit GFP_NOFS allocation scope.
 225  *
 226  * This functions marks the beginning of the GFP_NOFS allocation scope.
 227  * All further allocations will implicitly drop __GFP_FS flag and so
 228  * they are safe for the FS critical section from the allocation recursion
 229  * point of view. Use memalloc_nofs_restore to end the scope with flags
 230  * returned by this function.
 231  *
 232  * This function is safe to be used from any context.
 233  */
 234 static inline unsigned int memalloc_nofs_save(void)
 235 {
 236         unsigned int flags = current->flags & PF_MEMALLOC_NOFS;
 237         current->flags |= PF_MEMALLOC_NOFS;
 238         return flags;
 239 }
 240
 241 /**
 242  * memalloc_nofs_restore - Ends the implicit GFP_NOFS scope.
 243  * @flags: Flags to restore.
 244  *
 245  * Ends the implicit GFP_NOFS scope started by memalloc_nofs_save function.
 246  * Always make sure that the given flags is the return value from the
 247  * pairing memalloc_nofs_save call.
 248  */
 249 static inline void memalloc_nofs_restore(unsigned int flags)
 250 {
 251         current->flags = (current->flags & ~PF_MEMALLOC_NOFS) | flags;
 252 }
 253
 254 static inline unsigned int memalloc_noreclaim_save(void)
 255 {
 256         unsigned int flags = current->flags & PF_MEMALLOC;
 257         current->flags |= PF_MEMALLOC;
 258         return flags;
 259 }
 260
 261 static inline void memalloc_noreclaim_restore(unsigned int flags)
 262 {
 263         current->flags = (current->flags & ~PF_MEMALLOC) | flags;
 264 }
 265
 266 #ifdef CONFIG_CMA
 267 static inline unsigned int memalloc_nocma_save(void)
 268 {
 269         unsigned int flags = current->flags & PF_MEMALLOC_NOCMA;
 270
 271         current->flags |= PF_MEMALLOC_NOCMA;
 272         return flags;
 273 }
 274
 275 static inline void memalloc_nocma_restore(unsigned int flags)
 276 {
 277         current->flags = (current->flags & ~PF_MEMALLOC_NOCMA) | flags;
 278 }
 279 #else
 280 static inline unsigned int memalloc_nocma_save(void)
 281 {
 282         return 0;
 283 }
 284
 285 static inline void memalloc_nocma_restore(unsigned int flags)
 286 {
 287 }
 288 #endif
 289
 290 #ifdef CONFIG_MEMCG
 291 DECLARE_PER_CPU(struct mem_cgroup *, int_active_memcg);
 292 /**
 293  * set_active_memcg - Starts the remote memcg charging scope.
 294  * @memcg: memcg to charge.
 295  *
 296  * This function marks the beginning of the remote memcg charging scope. All the
 297  * __GFP_ACCOUNT allocations till the end of the scope will be charged to the
 298  * given memcg.
 299  *
 300  * NOTE: This function can nest. Users must save the return value and
 301  * reset the previous value after their own charging scope is over.
 302  */
 303 static inline struct mem_cgroup *
 304 set_active_memcg(struct mem_cgroup *memcg)
 305 {
 306         struct mem_cgroup *old;
 307
 308         if (in_interrupt()) {
 309                 old = this_cpu_read(int_active_memcg);
 310                 this_cpu_write(int_active_memcg, memcg);
 311         } else {
 312                 old = current->active_memcg;
 313                 current->active_memcg = memcg;
 314         }
 315
 316         return old;
 317 }
 318 #else
 319 static inline struct mem_cgroup *
 320 set_active_memcg(struct mem_cgroup *memcg)
 321 {
 322         return NULL;
 323 }
 324 #endif
 325
 326 #ifdef CONFIG_MEMBARRIER
 327 enum {
 328         MEMBARRIER_STATE_PRIVATE_EXPEDITED_READY                = (1U << 0),
 329         MEMBARRIER_STATE_PRIVATE_EXPEDITED                      = (1U << 1),
 330         MEMBARRIER_STATE_GLOBAL_EXPEDITED_READY                 = (1U << 2),
 331         MEMBARRIER_STATE_GLOBAL_EXPEDITED                       = (1U << 3),
 332         MEMBARRIER_STATE_PRIVATE_EXPEDITED_SYNC_CORE_READY      = (1U << 4),
 333         MEMBARRIER_STATE_PRIVATE_EXPEDITED_SYNC_CORE            = (1U << 5),
 334         MEMBARRIER_STATE_PRIVATE_EXPEDITED_RSEQ_READY           = (1U << 6),
 335         MEMBARRIER_STATE_PRIVATE_EXPEDITED_RSEQ                 = (1U << 7),
 336 };
 337
 338 enum {
 339         MEMBARRIER_FLAG_SYNC_CORE       = (1U << 0),
 340         MEMBARRIER_FLAG_RSEQ            = (1U << 1),
 341 };
 342
 343 #ifdef CONFIG_ARCH_HAS_MEMBARRIER_CALLBACKS
 344 #include <asm/membarrier.h>
 345 #endif
 346
 347 static inline void membarrier_mm_sync_core_before_usermode(struct mm_struct *mm)
 348 {
 349         if (current->mm != mm)
 350                 return;
 351         if (likely(!(atomic_read(&mm->membarrier_state) &
 352                      MEMBARRIER_STATE_PRIVATE_EXPEDITED_SYNC_CORE)))
 353                 return;
 354         sync_core_before_usermode();
 355 }
 356
 357 extern void membarrier_exec_mmap(struct mm_struct *mm);
 358
 359 #else
 360 #ifdef CONFIG_ARCH_HAS_MEMBARRIER_CALLBACKS
 361 static inline void membarrier_arch_switch_mm(struct mm_struct *prev,
 362                                              struct mm_struct *next,
 363                                              struct task_struct *tsk)
 364 {
 365 }
 366 #endif
 367 static inline void membarrier_exec_mmap(struct mm_struct *mm)
 368 {
 369 }
 370 static inline void membarrier_mm_sync_core_before_usermode(struct mm_struct *mm)
 371 {
 372 }
 373 #endif
 374
 375 #endif /* _LINUX_SCHED_MM_H */