arch/powerpc/kernel/tm.S

   1 /*
   2  * Transactional memory support routines to reclaim and recheckpoint
   3  * transactional process state.
   4  *
   5  * Copyright 2012 Matt Evans & Michael Neuling, IBM Corporation.
   6  */
   7
   8 #include <asm/asm-offsets.h>
   9 #include <asm/ppc_asm.h>
  10 #include <asm/ppc-opcode.h>
  11 #include <asm/ptrace.h>
  12 #include <asm/reg.h>
  13 #include <asm/bug.h>
  14
  15 #ifdef CONFIG_VSX
  16 /* See fpu.S, this is borrowed from there */
  17 #define __SAVE_32FPRS_VSRS(n,c,base)            \
  18 BEGIN_FTR_SECTION                               \
  19         b       2f;                             \
  20 END_FTR_SECTION_IFSET(CPU_FTR_VSX);             \
  21         SAVE_32FPRS(n,base);                    \
  22         b       3f;                             \
  23 2:      SAVE_32VSRS(n,c,base);                  \
  24 3:
  25 #define __REST_32FPRS_VSRS(n,c,base)            \
  26 BEGIN_FTR_SECTION                               \
  27         b       2f;                             \
  28 END_FTR_SECTION_IFSET(CPU_FTR_VSX);             \
  29         REST_32FPRS(n,base);                    \
  30         b       3f;                             \
  31 2:      REST_32VSRS(n,c,base);                  \
  32 3:
  33 #else
  34 #define __SAVE_32FPRS_VSRS(n,c,base)    SAVE_32FPRS(n, base)
  35 #define __REST_32FPRS_VSRS(n,c,base)    REST_32FPRS(n, base)
  36 #endif
  37 #define SAVE_32FPRS_VSRS(n,c,base) \
  38         __SAVE_32FPRS_VSRS(n,__REG_##c,__REG_##base)
  39 #define REST_32FPRS_VSRS(n,c,base) \
  40         __REST_32FPRS_VSRS(n,__REG_##c,__REG_##base)
  41
  42 /* Stack frame offsets for local variables. */
  43 #define TM_FRAME_L0     TM_FRAME_SIZE-16
  44 #define TM_FRAME_L1     TM_FRAME_SIZE-8
  45
  46
  47 /* In order to access the TM SPRs, TM must be enabled.  So, do so: */
  48 _GLOBAL(tm_enable)
  49         mfmsr   r4
  50         li      r3, MSR_TM >> 32
  51         sldi    r3, r3, 32
  52         and.    r0, r4, r3
  53         bne     1f
  54         or      r4, r4, r3
  55         mtmsrd  r4
  56 1:      blr
  57
  58 _GLOBAL(tm_save_sprs)
  59         mfspr   r0, SPRN_TFHAR
  60         std     r0, THREAD_TM_TFHAR(r3)
  61         mfspr   r0, SPRN_TEXASR
  62         std     r0, THREAD_TM_TEXASR(r3)
  63         mfspr   r0, SPRN_TFIAR
  64         std     r0, THREAD_TM_TFIAR(r3)
  65         blr
  66
  67 _GLOBAL(tm_restore_sprs)
  68         ld      r0, THREAD_TM_TFHAR(r3)
  69         mtspr   SPRN_TFHAR, r0
  70         ld      r0, THREAD_TM_TEXASR(r3)
  71         mtspr   SPRN_TEXASR, r0
  72         ld      r0, THREAD_TM_TFIAR(r3)
  73         mtspr   SPRN_TFIAR, r0
  74         blr
  75
  76         /* Passed an 8-bit failure cause as first argument. */
  77 _GLOBAL(tm_abort)
  78         TABORT(R3)
  79         blr
  80
  81         .section        ".toc","aw"
  82 DSCR_DEFAULT:
  83         .tc dscr_default[TC],dscr_default
  84
  85         .section        ".text"
  86
  87 /* void tm_reclaim(struct thread_struct *thread,
  88  *                 unsigned long orig_msr,
  89  *                 uint8_t cause)
  90  *
  91  *      - Performs a full reclaim.  This destroys outstanding
  92  *        transactions and updates thread->regs.tm_ckpt_* with the
  93  *        original checkpointed state.  Note that thread->regs is
  94  *        unchanged.
  95  *      - FP regs are written back to thread->transact_fpr before
  96  *        reclaiming.  These are the transactional (current) versions.
  97  *
  98  * Purpose is to both abort transactions of, and preserve the state of,
  99  * a transactions at a context switch. We preserve/restore both sets of process
 100  * state to restore them when the thread's scheduled again.  We continue in
 101  * userland as though nothing happened, but when the transaction is resumed
 102  * they will abort back to the checkpointed state we save out here.
 103  *
 104  * Call with IRQs off, stacks get all out of sync for some periods in here!
 105  */
 106 _GLOBAL(tm_reclaim)
 107         mfcr    r6
 108         mflr    r0
 109         stw     r6, 8(r1)
 110         std     r0, 16(r1)
 111         std     r2, STK_GOT(r1)
 112         stdu    r1, -TM_FRAME_SIZE(r1)
 113
 114         /* We've a struct pt_regs at [r1+STACK_FRAME_OVERHEAD]. */
 115
 116         std     r3, STK_PARAM(R3)(r1)
 117         SAVE_NVGPRS(r1)
 118
 119         /* We need to setup MSR for VSX register save instructions.  Here we
 120          * also clear the MSR RI since when we do the treclaim, we won't have a
 121          * valid kernel pointer for a while.  We clear RI here as it avoids
 122          * adding another mtmsr closer to the treclaim.  This makes the region
 123          * maked as non-recoverable wider than it needs to be but it saves on
 124          * inserting another mtmsrd later.
 125          */
 126         mfmsr   r14
 127         mr      r15, r14
 128         ori     r15, r15, MSR_FP
 129         li      r16, MSR_RI
 130         ori     r16, r16, MSR_EE /* IRQs hard off */
 131         andc    r15, r15, r16
 132         oris    r15, r15, MSR_VEC@h
 133 #ifdef CONFIG_VSX
 134         BEGIN_FTR_SECTION
 135         oris    r15,r15, MSR_VSX@h
 136         END_FTR_SECTION_IFSET(CPU_FTR_VSX)
 137 #endif
 138         mtmsrd  r15
 139         std     r14, TM_FRAME_L0(r1)
 140
 141         /* Stash the stack pointer away for use after reclaim */
 142         std     r1, PACAR1(r13)
 143
 144         /* ******************** FPR/VR/VSRs ************
 145          * Before reclaiming, capture the current/transactional FPR/VR
 146         * versions /if used/.
 147          *
 148          * (If VSX used, FP and VMX are implied.  Or, we don't need to look
 149          * at MSR.VSX as copying FP regs if .FP, vector regs if .VMX covers it.)
 150          *
 151          * We're passed the thread's MSR as parameter 2.
 152          *
 153          * We enabled VEC/FP/VSX in the msr above, so we can execute these
 154          * instructions!
 155          */
 156         andis.          r0, r4, MSR_VEC@h
 157         beq     dont_backup_vec
 158
 159         addi    r7, r3, THREAD_TRANSACT_VRSTATE
 160         SAVE_32VRS(0, r6, r7)   /* r6 scratch, r7 transact vr state */
 161         mfvscr  vr0
 162         li      r6, VRSTATE_VSCR
 163         stvx    vr0, r7, r6
 164 dont_backup_vec:
 165         mfspr   r0, SPRN_VRSAVE
 166         std     r0, THREAD_TRANSACT_VRSAVE(r3)
 167
 168         andi.   r0, r4, MSR_FP
 169         beq     dont_backup_fp
 170
 171         addi    r7, r3, THREAD_TRANSACT_FPSTATE
 172         SAVE_32FPRS_VSRS(0, R6, R7)     /* r6 scratch, r7 transact fp state */
 173
 174         mffs    fr0
 175         stfd    fr0,FPSTATE_FPSCR(r7)
 176
 177 dont_backup_fp:
 178         /* Do sanity check on MSR to make sure we are suspended */
 179         li      r7, (MSR_TS_S)@higher
 180         srdi    r6, r14, 32
 181         and     r6, r6, r7
 182 1:      tdeqi   r6, 0
 183         EMIT_BUG_ENTRY 1b,__FILE__,__LINE__,0
 184
 185         /* The moment we treclaim, ALL of our GPRs will switch
 186          * to user register state.  (FPRs, CCR etc. also!)
 187          * Use an sprg and a tm_scratch in the PACA to shuffle.
 188          */
 189         TRECLAIM(R5)                            /* Cause in r5 */
 190
 191         /* ******************** GPRs ******************** */
 192         /* Stash the checkpointed r13 away in the scratch SPR and get the real
 193          *  paca
 194          */
 195         SET_SCRATCH0(r13)
 196         GET_PACA(r13)
 197
 198         /* Stash the checkpointed r1 away in paca tm_scratch and get the real
 199          * stack pointer back
 200          */
 201         std     r1, PACATMSCRATCH(r13)
 202         ld      r1, PACAR1(r13)
 203
 204         /* Store the PPR in r11 and reset to decent value */
 205         std     r11, GPR11(r1)                  /* Temporary stash */
 206         mfspr   r11, SPRN_PPR
 207         HMT_MEDIUM
 208
 209         /* Now get some more GPRS free */
 210         std     r7, GPR7(r1)                    /* Temporary stash */
 211         std     r12, GPR12(r1)                  /* ''   ''    ''   */
 212         ld      r12, STK_PARAM(R3)(r1)          /* Param 0, thread_struct * */
 213
 214         std     r11, THREAD_TM_PPR(r12)         /* Store PPR and free r11 */
 215
 216         addi    r7, r12, PT_CKPT_REGS           /* Thread's ckpt_regs */
 217
 218         /* Make r7 look like an exception frame so that we
 219          * can use the neat GPRx(n) macros.  r7 is NOT a pt_regs ptr!
 220          */
 221         subi    r7, r7, STACK_FRAME_OVERHEAD
 222
 223         /* Sync the userland GPRs 2-12, 14-31 to thread->regs: */
 224         SAVE_GPR(0, r7)                         /* user r0 */
 225         SAVE_GPR(2, r7)                 /* user r2 */
 226         SAVE_4GPRS(3, r7)                       /* user r3-r6 */
 227         SAVE_GPR(8, r7)                         /* user r8 */
 228         SAVE_GPR(9, r7)                         /* user r9 */
 229         SAVE_GPR(10, r7)                        /* user r10 */
 230         ld      r3, PACATMSCRATCH(r13)          /* user r1 */
 231         ld      r4, GPR7(r1)                    /* user r7 */
 232         ld      r5, GPR11(r1)                   /* user r11 */
 233         ld      r6, GPR12(r1)                   /* user r12 */
 234         GET_SCRATCH0(8)                         /* user r13 */
 235         std     r3, GPR1(r7)
 236         std     r4, GPR7(r7)
 237         std     r5, GPR11(r7)
 238         std     r6, GPR12(r7)
 239         std     r8, GPR13(r7)
 240
 241         SAVE_NVGPRS(r7)                         /* user r14-r31 */
 242
 243         /* ******************** NIP ******************** */
 244         mfspr   r3, SPRN_TFHAR
 245         std     r3, _NIP(r7)                    /* Returns to failhandler */
 246         /* The checkpointed NIP is ignored when rescheduling/rechkpting,
 247          * but is used in signal return to 'wind back' to the abort handler.
 248          */
 249
 250         /* ******************** CR,LR,CCR,MSR ********** */
 251         mfctr   r3
 252         mflr    r4
 253         mfcr    r5
 254         mfxer   r6
 255
 256         std     r3, _CTR(r7)
 257         std     r4, _LINK(r7)
 258         std     r5, _CCR(r7)
 259         std     r6, _XER(r7)
 260
 261
 262         /* ******************** TAR, DSCR ********** */
 263         mfspr   r3, SPRN_TAR
 264         mfspr   r4, SPRN_DSCR
 265
 266         std     r3, THREAD_TM_TAR(r12)
 267         std     r4, THREAD_TM_DSCR(r12)
 268
 269         /* MSR and flags:  We don't change CRs, and we don't need to alter
 270          * MSR.
 271          */
 272
 273         /* TM regs, incl TEXASR -- these live in thread_struct.  Note they've
 274          * been updated by the treclaim, to explain to userland the failure
 275          * cause (aborted).
 276          */
 277         mfspr   r0, SPRN_TEXASR
 278         mfspr   r3, SPRN_TFHAR
 279         mfspr   r4, SPRN_TFIAR
 280         std     r0, THREAD_TM_TEXASR(r12)
 281         std     r3, THREAD_TM_TFHAR(r12)
 282         std     r4, THREAD_TM_TFIAR(r12)
 283
 284         /* AMR is checkpointed too, but is unsupported by Linux. */
 285
 286         /* Restore original MSR/IRQ state & clear TM mode */
 287         ld      r14, TM_FRAME_L0(r1)            /* Orig MSR */
 288         li      r15, 0
 289         rldimi  r14, r15, MSR_TS_LG, (63-MSR_TS_LG)-1
 290         mtmsrd  r14
 291
 292         REST_NVGPRS(r1)
 293
 294         addi    r1, r1, TM_FRAME_SIZE
 295         lwz     r4, 8(r1)
 296         ld      r0, 16(r1)
 297         mtcr    r4
 298         mtlr    r0
 299         ld      r2, STK_GOT(r1)
 300
 301         /* Load system default DSCR */
 302         ld      r4, DSCR_DEFAULT@toc(r2)
 303         ld      r0, 0(r4)
 304         mtspr   SPRN_DSCR, r0
 305
 306         blr
 307
 308
 309         /* void tm_recheckpoint(struct thread_struct *thread,
 310          *                      unsigned long orig_msr)
 311          *      - Restore the checkpointed register state saved by tm_reclaim
 312          *        when we switch_to a process.
 313          *
 314          *      Call with IRQs off, stacks get all out of sync for
 315          *      some periods in here!
 316          */
 317 _GLOBAL(__tm_recheckpoint)
 318         mfcr    r5
 319         mflr    r0
 320         stw     r5, 8(r1)
 321         std     r0, 16(r1)
 322         std     r2, STK_GOT(r1)
 323         stdu    r1, -TM_FRAME_SIZE(r1)
 324
 325         /* We've a struct pt_regs at [r1+STACK_FRAME_OVERHEAD].
 326          * This is used for backing up the NVGPRs:
 327          */
 328         SAVE_NVGPRS(r1)
 329
 330         /* Load complete register state from ts_ckpt* registers */
 331
 332         addi    r7, r3, PT_CKPT_REGS            /* Thread's ckpt_regs */
 333
 334         /* Make r7 look like an exception frame so that we
 335          * can use the neat GPRx(n) macros.  r7 is now NOT a pt_regs ptr!
 336          */
 337         subi    r7, r7, STACK_FRAME_OVERHEAD
 338
 339         SET_SCRATCH0(r1)
 340
 341         mfmsr   r6
 342         /* R4 = original MSR to indicate whether thread used FP/Vector etc. */
 343
 344         /* Enable FP/vec in MSR if necessary! */
 345         lis     r5, MSR_VEC@h
 346         ori     r5, r5, MSR_FP
 347         and.    r5, r4, r5
 348         beq     restore_gprs                    /* if neither, skip both */
 349
 350 #ifdef CONFIG_VSX
 351         BEGIN_FTR_SECTION
 352         oris    r5, r5, MSR_VSX@h
 353         END_FTR_SECTION_IFSET(CPU_FTR_VSX)
 354 #endif
 355         or      r5, r6, r5                      /* Set MSR.FP+.VSX/.VEC */
 356         mtmsr   r5
 357
 358 #ifdef CONFIG_ALTIVEC
 359         /* FP and VEC registers:  These are recheckpointed from thread.fpr[]
 360          * and thread.vr[] respectively.  The thread.transact_fpr[] version
 361          * is more modern, and will be loaded subsequently by any FPUnavailable
 362          * trap.
 363          */
 364         andis.  r0, r4, MSR_VEC@h
 365         beq     dont_restore_vec
 366
 367         addi    r8, r3, THREAD_VRSTATE
 368         li      r5, VRSTATE_VSCR
 369         lvx     vr0, r8, r5
 370         mtvscr  vr0
 371         REST_32VRS(0, r5, r8)                   /* r5 scratch, r8 ptr */
 372 dont_restore_vec:
 373         ld      r5, THREAD_VRSAVE(r3)
 374         mtspr   SPRN_VRSAVE, r5
 375 #endif
 376
 377         andi.   r0, r4, MSR_FP
 378         beq     dont_restore_fp
 379
 380         addi    r8, r3, THREAD_FPSTATE
 381         lfd     fr0, FPSTATE_FPSCR(r8)
 382         MTFSF_L(fr0)
 383         REST_32FPRS_VSRS(0, R4, R8)
 384
 385 dont_restore_fp:
 386         mtmsr   r6                              /* FP/Vec off again! */
 387
 388 restore_gprs:
 389
 390         /* ******************** CR,LR,CCR,MSR ********** */
 391         ld      r4, _CTR(r7)
 392         ld      r5, _LINK(r7)
 393         ld      r8, _XER(r7)
 394
 395         mtctr   r4
 396         mtlr    r5
 397         mtxer   r8
 398
 399         /* ******************** TAR ******************** */
 400         ld      r4, THREAD_TM_TAR(r3)
 401         mtspr   SPRN_TAR,       r4
 402
 403         /* Load up the PPR and DSCR in GPRs only at this stage */
 404         ld      r5, THREAD_TM_DSCR(r3)
 405         ld      r6, THREAD_TM_PPR(r3)
 406
 407         /* Clear the MSR RI since we are about to change R1.  EE is already off
 408          */
 409         li      r4, 0
 410         mtmsrd  r4, 1
 411
 412         REST_GPR(0, r7)                         /* GPR0 */
 413         REST_2GPRS(2, r7)                       /* GPR2-3 */
 414         REST_GPR(4, r7)                         /* GPR4 */
 415         REST_4GPRS(8, r7)                       /* GPR8-11 */
 416         REST_2GPRS(12, r7)                      /* GPR12-13 */
 417
 418         REST_NVGPRS(r7)                         /* GPR14-31 */
 419
 420         /* Load up PPR and DSCR here so we don't run with user values for long
 421          */
 422         mtspr   SPRN_DSCR, r5
 423         mtspr   SPRN_PPR, r6
 424
 425         /* Do final sanity check on TEXASR to make sure FS is set.  Do this
 426          * here before we load up the userspace r1 so any bugs we hit will get
 427          * a call chain */
 428         mfspr   r5, SPRN_TEXASR
 429         srdi    r5, r5, 16
 430         li      r6, (TEXASR_FS)@h
 431         and     r6, r6, r5
 432 1:      tdeqi   r6, 0
 433         EMIT_BUG_ENTRY 1b,__FILE__,__LINE__,0
 434
 435         /* Do final sanity check on MSR to make sure we are not transactional
 436          * or suspended
 437          */
 438         mfmsr   r6
 439         li      r5, (MSR_TS_MASK)@higher
 440         srdi    r6, r6, 32
 441         and     r6, r6, r5
 442 1:      tdnei   r6, 0
 443         EMIT_BUG_ENTRY 1b,__FILE__,__LINE__,0
 444
 445         /* Restore CR */
 446         ld      r6, _CCR(r7)
 447         mtcr    r6
 448
 449         REST_GPR(1, r7)                         /* GPR1 */
 450         REST_GPR(5, r7)                         /* GPR5-7 */
 451         REST_GPR(6, r7)
 452         ld      r7, GPR7(r7)
 453
 454         /* Commit register state as checkpointed state: */
 455         TRECHKPT
 456
 457         HMT_MEDIUM
 458
 459         /* Our transactional state has now changed.
 460          *
 461          * Now just get out of here.  Transactional (current) state will be
 462          * updated once restore is called on the return path in the _switch-ed
 463          * -to process.
 464          */
 465
 466         GET_PACA(r13)
 467         GET_SCRATCH0(r1)
 468
 469         /* R1 is restored, so we are recoverable again.  EE is still off */
 470         li      r4, MSR_RI
 471         mtmsrd  r4, 1
 472
 473         REST_NVGPRS(r1)
 474
 475         addi    r1, r1, TM_FRAME_SIZE
 476         lwz     r4, 8(r1)
 477         ld      r0, 16(r1)
 478         mtcr    r4
 479         mtlr    r0
 480         ld      r2, STK_GOT(r1)
 481
 482         /* Load system default DSCR */
 483         ld      r4, DSCR_DEFAULT@toc(r2)
 484         ld      r0, 0(r4)
 485         mtspr   SPRN_DSCR, r0
 486
 487         blr
 488
 489         /* ****************************************************************** */