tools/memory-model/linux-kernel.cat

   1 // SPDX-License-Identifier: GPL-2.0+
   2 (*
   3  * Copyright (C) 2015 Jade Alglave <j.alglave@ucl.ac.uk>,
   4  * Copyright (C) 2016 Luc Maranget <luc.maranget@inria.fr> for Inria
   5  * Copyright (C) 2017 Alan Stern <stern@rowland.harvard.edu>,
   6  *                    Andrea Parri <parri.andrea@gmail.com>
   7  *
   8  * An earlier version of this file appeared in the companion webpage for
   9  * "Frightening small children and disconcerting grown-ups: Concurrency
  10  * in the Linux kernel" by Alglave, Maranget, McKenney, Parri, and Stern,
  11  * which appeared in ASPLOS 2018.
  12  *)
  13
  14 "Linux-kernel memory consistency model"
  15
  16 (*
  17  * File "lock.cat" handles locks and is experimental.
  18  * It can be replaced by include "cos.cat" for tests that do not use locks.
  19  *)
  20
  21 include "lock.cat"
  22
  23 (*******************)
  24 (* Basic relations *)
  25 (*******************)
  26
  27 (* Release Acquire *)
  28 let acq-po = [Acquire] ; po ; [M]
  29 let po-rel = [M] ; po ; [Release]
  30 let po-unlock-rf-lock-po = po ; [UL] ; rf ; [LKR] ; po
  31
  32 (* Fences *)
  33 let R4rmb = R \ Noreturn        (* Reads for which rmb works *)
  34 let rmb = [R4rmb] ; fencerel(Rmb) ; [R4rmb]
  35 let wmb = [W] ; fencerel(Wmb) ; [W]
  36 let mb = ([M] ; fencerel(Mb) ; [M]) |
  37         ([M] ; fencerel(Before-atomic) ; [RMW] ; po? ; [M]) |
  38         ([M] ; po? ; [RMW] ; fencerel(After-atomic) ; [M]) |
  39         ([M] ; po? ; [LKW] ; fencerel(After-spinlock) ; [M]) |
  40         ([M] ; po ; [UL] ; (co | po) ; [LKW] ;
  41                 fencerel(After-unlock-lock) ; [M])
  42 let gp = po ; [Sync-rcu | Sync-srcu] ; po?
  43 let strong-fence = mb | gp
  44
  45 let nonrw-fence = strong-fence | po-rel | acq-po
  46 let fence = nonrw-fence | wmb | rmb
  47
  48 (**********************************)
  49 (* Fundamental coherence ordering *)
  50 (**********************************)
  51
  52 (* Sequential Consistency Per Variable *)
  53 let com = rf | co | fr
  54 acyclic po-loc | com as coherence
  55
  56 (* Atomic Read-Modify-Write *)
  57 empty rmw & (fre ; coe) as atomic
  58
  59 (**********************************)
  60 (* Instruction execution ordering *)
  61 (**********************************)
  62
  63 (* Preserved Program Order *)
  64 let dep = addr | data
  65 let rwdep = (dep | ctrl) ; [W]
  66 let overwrite = co | fr
  67 let to-w = rwdep | (overwrite & int)
  68 let to-r = addr | (dep ; rfi)
  69 let ppo = to-r | to-w | fence | (po-unlock-rf-lock-po & int)
  70
  71 (* Propagation: Ordering from release operations and strong fences. *)
  72 let A-cumul(r) = rfe? ; r
  73 let cumul-fence = A-cumul(strong-fence | po-rel) | wmb | po-unlock-rf-lock-po
  74 let prop = (overwrite & ext)? ; cumul-fence* ; rfe?
  75
  76 (*
  77  * Happens Before: Ordering from the passage of time.
  78  * No fences needed here for prop because relation confined to one process.
  79  *)
  80 let hb = ppo | rfe | ((prop \ id) & int)
  81 acyclic hb as happens-before
  82
  83 (****************************************)
  84 (* Write and fence propagation ordering *)
  85 (****************************************)
  86
  87 (* Propagation: Each non-rf link needs a strong fence. *)
  88 let pb = prop ; strong-fence ; hb*
  89 acyclic pb as propagation
  90
  91 (*******)
  92 (* RCU *)
  93 (*******)
  94
  95 (*
  96  * Effects of read-side critical sections proceed from the rcu_read_unlock()
  97  * or srcu_read_unlock() backwards on the one hand, and from the
  98  * rcu_read_lock() or srcu_read_lock() forwards on the other hand.
  99  *
 100  * In the definition of rcu-fence below, the po term at the left-hand side
 101  * of each disjunct and the po? term at the right-hand end have been factored
 102  * out.  They have been moved into the definitions of rcu-link and rb.
 103  * This was necessary in order to apply the "& loc" tests correctly.
 104  *)
 105 let rcu-gp = [Sync-rcu]         (* Compare with gp *)
 106 let srcu-gp = [Sync-srcu]
 107 let rcu-rscsi = rcu-rscs^-1
 108 let srcu-rscsi = srcu-rscs^-1
 109
 110 (*
 111  * The synchronize_rcu() strong fence is special in that it can order not
 112  * one but two non-rf relations, but only in conjunction with an RCU
 113  * read-side critical section.
 114  *)
 115 let rcu-link = po? ; hb* ; pb* ; prop ; po
 116
 117 (*
 118  * Any sequence containing at least as many grace periods as RCU read-side
 119  * critical sections (joined by rcu-link) acts as a generalized strong fence.
 120  * Likewise for SRCU grace periods and read-side critical sections, provided
 121  * the synchronize_srcu() and srcu_read_[un]lock() calls refer to the same
 122  * struct srcu_struct location.
 123  *)
 124 let rec rcu-fence = rcu-gp | srcu-gp |
 125         (rcu-gp ; rcu-link ; rcu-rscsi) |
 126         ((srcu-gp ; rcu-link ; srcu-rscsi) & loc) |
 127         (rcu-rscsi ; rcu-link ; rcu-gp) |
 128         ((srcu-rscsi ; rcu-link ; srcu-gp) & loc) |
 129         (rcu-gp ; rcu-link ; rcu-fence ; rcu-link ; rcu-rscsi) |
 130         ((srcu-gp ; rcu-link ; rcu-fence ; rcu-link ; srcu-rscsi) & loc) |
 131         (rcu-rscsi ; rcu-link ; rcu-fence ; rcu-link ; rcu-gp) |
 132         ((srcu-rscsi ; rcu-link ; rcu-fence ; rcu-link ; srcu-gp) & loc) |
 133         (rcu-fence ; rcu-link ; rcu-fence)
 134
 135 (* rb orders instructions just as pb does *)
 136 let rb = prop ; po ; rcu-fence ; po? ; hb* ; pb*
 137
 138 irreflexive rb as rcu
 139
 140 (*
 141  * The happens-before, propagation, and rcu constraints are all
 142  * expressions of temporal ordering.  They could be replaced by
 143  * a single constraint on an "executes-before" relation, xb:
 144  *
 145  * let xb = hb | pb | rb
 146  * acyclic xb as executes-before
 147  *)