1 /* $NetBSD: asm.h,v 1.48 2014/09/17 16:49:20 joerg Exp $ */ 2 3 /* 4 * Copyright (c) 1992, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Ralph Campbell. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)machAsmDefs.h 8.1 (Berkeley) 6/10/93 35 */ 36 37 /* 38 * machAsmDefs.h -- 39 * 40 * Macros used when writing assembler programs. 41 * 42 * Copyright (C) 1989 Digital Equipment Corporation. 43 * Permission to use, copy, modify, and distribute this software and 44 * its documentation for any purpose and without fee is hereby granted, 45 * provided that the above copyright notice appears in all copies. 46 * Digital Equipment Corporation makes no representations about the 47 * suitability of this software for any purpose. It is provided "as is" 48 * without express or implied warranty. 49 * 50 * from: Header: /sprite/src/kernel/mach/ds3100.md/RCS/machAsmDefs.h, 51 * v 1.2 89/08/15 18:28:24 rab Exp SPRITE (DECWRL) 52 */ 53 54 #ifndef _MIPS_ASM_H 55 #define _MIPS_ASM_H 56 57 #include <sys/cdefs.h> /* for API selection */ 58 #include <mips/regdef.h> 59 60 /* 61 * Define -pg profile entry code. 62 * Must always be noreorder, must never use a macro instruction 63 * Final addiu to t9 must always equal the size of this _KERN_MCOUNT 64 */ 65 #define _KERN_MCOUNT \ 66 .set push; \ 67 .set noreorder; \ 68 .set noat; \ 69 subu sp,sp,16; \ 70 sw t9,12(sp); \ 71 move AT,ra; \ 72 lui t9,%hi(_mcount); \ 73 addiu t9,t9,%lo(_mcount); \ 74 jalr t9; \ 75 nop; \ 76 lw t9,4(sp); \ 77 addiu sp,sp,8; \ 78 addiu t9,t9,40; \ 79 .set pop; 80 81 #ifdef GPROF 82 #define MCOUNT _KERN_MCOUNT 83 #else 84 #define MCOUNT 85 #endif 86 87 #ifdef USE_AENT 88 #define AENT(x) \ 89 .aent x, 0 90 #else 91 #define AENT(x) 92 #endif 93 94 /* 95 * WEAK_ALIAS: create a weak alias. 96 */ 97 #define WEAK_ALIAS(alias,sym) \ 98 .weak alias; \ 99 alias = sym 100 /* 101 * STRONG_ALIAS: create a strong alias. 102 */ 103 #define STRONG_ALIAS(alias,sym) \ 104 .globl alias; \ 105 alias = sym 106 107 /* 108 * WARN_REFERENCES: create a warning if the specified symbol is referenced. 109 */ 110 #define WARN_REFERENCES(sym,msg) \ 111 .pushsection __CONCAT(.gnu.warning.,sym); \ 112 .ascii msg; \ 113 .popsection 114 115 /* 116 * STATIC_LEAF_NOPROFILE 117 * No profilable local leaf routine. 118 */ 119 #define STATIC_LEAF_NOPROFILE(x) \ 120 .ent _C_LABEL(x); \ 121 _C_LABEL(x): ; \ 122 .frame sp, 0, ra 123 124 /* 125 * LEAF_NOPROFILE 126 * No profilable leaf routine. 127 */ 128 #define LEAF_NOPROFILE(x) \ 129 .globl _C_LABEL(x); \ 130 STATIC_LEAF_NOPROFILE(x) 131 132 /* 133 * STATIC_LEAF 134 * Declare a local leaf function. 135 */ 136 #define STATIC_LEAF(x) \ 137 STATIC_LEAF_NOPROFILE(x); \ 138 MCOUNT 139 140 /* 141 * LEAF 142 * A leaf routine does 143 * - call no other function, 144 * - never use any register that callee-saved (S0-S8), and 145 * - not use any local stack storage. 146 */ 147 #define LEAF(x) \ 148 LEAF_NOPROFILE(x); \ 149 MCOUNT 150 151 /* 152 * STATIC_XLEAF 153 * declare alternate entry to a static leaf routine 154 */ 155 #define STATIC_XLEAF(x) \ 156 AENT (_C_LABEL(x)); \ 157 _C_LABEL(x): 158 159 /* 160 * XLEAF 161 * declare alternate entry to leaf routine 162 */ 163 #define XLEAF(x) \ 164 .globl _C_LABEL(x); \ 165 STATIC_XLEAF(x) 166 167 /* 168 * STATIC_NESTED_NOPROFILE 169 * No profilable local nested routine. 170 */ 171 #define STATIC_NESTED_NOPROFILE(x, fsize, retpc) \ 172 .ent _C_LABEL(x); \ 173 _C_LABEL(x): ; \ 174 .frame sp, fsize, retpc 175 176 /* 177 * NESTED_NOPROFILE 178 * No profilable nested routine. 179 */ 180 #define NESTED_NOPROFILE(x, fsize, retpc) \ 181 .globl _C_LABEL(x); \ 182 STATIC_NESTED_NOPROFILE(x, fsize, retpc) 183 184 /* 185 * NESTED 186 * A function calls other functions and needs 187 * therefore stack space to save/restore registers. 188 */ 189 #define NESTED(x, fsize, retpc) \ 190 NESTED_NOPROFILE(x, fsize, retpc); \ 191 MCOUNT 192 193 /* 194 * STATIC_NESTED 195 * No profilable local nested routine. 196 */ 197 #define STATIC_NESTED(x, fsize, retpc) \ 198 STATIC_NESTED_NOPROFILE(x, fsize, retpc); \ 199 MCOUNT 200 201 /* 202 * XNESTED 203 * declare alternate entry point to nested routine. 204 */ 205 #define XNESTED(x) \ 206 .globl _C_LABEL(x); \ 207 AENT (_C_LABEL(x)); \ 208 _C_LABEL(x): 209 210 /* 211 * END 212 * Mark end of a procedure. 213 */ 214 #define END(x) \ 215 .end _C_LABEL(x); \ 216 .size _C_LABEL(x), . - _C_LABEL(x) 217 218 /* 219 * IMPORT -- import external symbol 220 */ 221 #define IMPORT(sym, size) \ 222 .extern _C_LABEL(sym),size 223 224 /* 225 * EXPORT -- export definition of symbol 226 */ 227 #define EXPORT(x) \ 228 .globl _C_LABEL(x); \ 229 _C_LABEL(x): 230 231 /* 232 * VECTOR 233 * exception vector entrypoint 234 * XXX: regmask should be used to generate .mask 235 */ 236 #define VECTOR(x, regmask) \ 237 .ent _C_LABEL(x); \ 238 EXPORT(x); \ 239 240 #define VECTOR_END(x) \ 241 EXPORT(__CONCAT(x,_end)); \ 242 END(x); \ 243 .org _C_LABEL(x) + 0x80 244 245 /* 246 * Macros to panic and printf from assembly language. 247 */ 248 #define PANIC(msg) \ 249 PTR_LA a0, 9f; \ 250 jal _C_LABEL(panic); \ 251 nop; \ 252 MSG(msg) 253 254 #define PRINTF(msg) \ 255 PTR_LA a0, 9f; \ 256 jal _C_LABEL(printf); \ 257 nop; \ 258 MSG(msg) 259 260 #define MSG(msg) \ 261 .rdata; \ 262 9: .asciz msg; \ 263 .text 264 265 #define ASMSTR(str) \ 266 .asciz str; \ 267 .align 3 268 269 #define RCSID(name) .pushsection ".ident"; .asciz name; .popsection 270 271 /* 272 * XXX retain dialects XXX 273 */ 274 #define ALEAF(x) XLEAF(x) 275 #define NLEAF(x) LEAF_NOPROFILE(x) 276 #define NON_LEAF(x, fsize, retpc) NESTED(x, fsize, retpc) 277 #define NNON_LEAF(x, fsize, retpc) NESTED_NOPROFILE(x, fsize, retpc) 278 279 #if defined(__mips_o32) 280 #define SZREG 4 281 #else 282 #define SZREG 8 283 #endif 284 285 #if defined(__mips_o32) || defined(__mips_o64) 286 #define ALSK 7 /* stack alignment */ 287 #define ALMASK -7 /* stack alignment */ 288 #define SZFPREG 4 289 #define FP_L lwc1 290 #define FP_S swc1 291 #else 292 #define ALSK 15 /* stack alignment */ 293 #define ALMASK -15 /* stack alignment */ 294 #define SZFPREG 8 295 #define FP_L ldc1 296 #define FP_S sdc1 297 #endif 298 299 /* 300 * standard callframe { 301 * register_t cf_args[4]; arg0 - arg3 (only on o32 and o64) 302 * register_t cf_pad[N]; o32/64 (N=0), n32 (N=1) n64 (N=1) 303 * register_t cf_gp; global pointer (only on n32 and n64) 304 * register_t cf_sp; frame pointer 305 * register_t cf_ra; return address 306 * }; 307 */ 308 #if defined(__mips_o32) || defined(__mips_o64) 309 #define CALLFRAME_SIZ (SZREG * (4 + 2)) 310 #define CALLFRAME_S0 0 311 #elif defined(__mips_n32) || defined(__mips_n64) 312 #define CALLFRAME_SIZ (SZREG * 4) 313 #define CALLFRAME_S0 (CALLFRAME_SIZ - 4 * SZREG) 314 #endif 315 #ifndef _KERNEL 316 #define CALLFRAME_GP (CALLFRAME_SIZ - 3 * SZREG) 317 #endif 318 #define CALLFRAME_SP (CALLFRAME_SIZ - 2 * SZREG) 319 #define CALLFRAME_RA (CALLFRAME_SIZ - 1 * SZREG) 320 321 /* 322 * While it would be nice to be compatible with the SGI 323 * REG_L and REG_S macros, because they do not take parameters, it 324 * is impossible to use them with the _MIPS_SIM_ABIX32 model. 325 * 326 * These macros hide the use of mips3 instructions from the 327 * assembler to prevent the assembler from generating 64-bit style 328 * ABI calls. 329 */ 330 #if _MIPS_SZPTR == 32 331 #define PTR_ADD add 332 #define PTR_ADDI addi 333 #define PTR_ADDU addu 334 #define PTR_ADDIU addiu 335 #define PTR_SUB subu 336 #define PTR_SUBI subi 337 #define PTR_SUBU subu 338 #define PTR_SUBIU subu 339 #define PTR_L lw 340 #define PTR_LA la 341 #define PTR_S sw 342 #define PTR_SLL sll 343 #define PTR_SLLV sllv 344 #define PTR_SRL srl 345 #define PTR_SRLV srlv 346 #define PTR_SRA sra 347 #define PTR_SRAV srav 348 #define PTR_LL ll 349 #define PTR_SC sc 350 #define PTR_WORD .word 351 #define PTR_SCALESHIFT 2 352 #else /* _MIPS_SZPTR == 64 */ 353 #define PTR_ADD dadd 354 #define PTR_ADDI daddi 355 #define PTR_ADDU daddu 356 #define PTR_ADDIU daddiu 357 #define PTR_SUB dsubu 358 #define PTR_SUBI dsubi 359 #define PTR_SUBU dsubu 360 #define PTR_SUBIU dsubu 361 #define PTR_L ld 362 #define PTR_LA dla 363 #define PTR_S sd 364 #define PTR_SLL dsll 365 #define PTR_SLLV dsllv 366 #define PTR_SRL dsrl 367 #define PTR_SRLV dsrlv 368 #define PTR_SRA dsra 369 #define PTR_SRAV dsrav 370 #define PTR_LL lld 371 #define PTR_SC scd 372 #define PTR_WORD .dword 373 #define PTR_SCALESHIFT 3 374 #endif /* _MIPS_SZPTR == 64 */ 375 376 #if _MIPS_SZINT == 32 377 #define INT_ADD add 378 #define INT_ADDI addi 379 #define INT_ADDU addu 380 #define INT_ADDIU addiu 381 #define INT_SUB subu 382 #define INT_SUBI subi 383 #define INT_SUBU subu 384 #define INT_SUBIU subu 385 #define INT_L lw 386 #define INT_LA la 387 #define INT_S sw 388 #define INT_SLL sll 389 #define INT_SLLV sllv 390 #define INT_SRL srl 391 #define INT_SRLV srlv 392 #define INT_SRA sra 393 #define INT_SRAV srav 394 #define INT_LL ll 395 #define INT_SC sc 396 #define INT_WORD .word 397 #define INT_SCALESHIFT 2 398 #else 399 #define INT_ADD dadd 400 #define INT_ADDI daddi 401 #define INT_ADDU daddu 402 #define INT_ADDIU daddiu 403 #define INT_SUB dsubu 404 #define INT_SUBI dsubi 405 #define INT_SUBU dsubu 406 #define INT_SUBIU dsubu 407 #define INT_L ld 408 #define INT_LA dla 409 #define INT_S sd 410 #define INT_SLL dsll 411 #define INT_SLLV dsllv 412 #define INT_SRL dsrl 413 #define INT_SRLV dsrlv 414 #define INT_SRA dsra 415 #define INT_SRAV dsrav 416 #define INT_LL lld 417 #define INT_SC scd 418 #define INT_WORD .dword 419 #define INT_SCALESHIFT 3 420 #endif 421 422 #if _MIPS_SZLONG == 32 423 #define LONG_ADD add 424 #define LONG_ADDI addi 425 #define LONG_ADDU addu 426 #define LONG_ADDIU addiu 427 #define LONG_SUB subu 428 #define LONG_SUBI subi 429 #define LONG_SUBU subu 430 #define LONG_SUBIU subu 431 #define LONG_L lw 432 #define LONG_LA la 433 #define LONG_S sw 434 #define LONG_SLL sll 435 #define LONG_SLLV sllv 436 #define LONG_SRL srl 437 #define LONG_SRLV srlv 438 #define LONG_SRA sra 439 #define LONG_SRAV srav 440 #define LONG_LL ll 441 #define LONG_SC sc 442 #define LONG_WORD .word 443 #define LONG_SCALESHIFT 2 444 #else 445 #define LONG_ADD dadd 446 #define LONG_ADDI daddi 447 #define LONG_ADDU daddu 448 #define LONG_ADDIU daddiu 449 #define LONG_SUB dsubu 450 #define LONG_SUBI dsubi 451 #define LONG_SUBU dsubu 452 #define LONG_SUBIU dsubu 453 #define LONG_L ld 454 #define LONG_LA dla 455 #define LONG_S sd 456 #define LONG_SLL dsll 457 #define LONG_SLLV dsllv 458 #define LONG_SRL dsrl 459 #define LONG_SRLV dsrlv 460 #define LONG_SRA dsra 461 #define LONG_SRAV dsrav 462 #define LONG_LL lld 463 #define LONG_SC scd 464 #define LONG_WORD .dword 465 #define LONG_SCALESHIFT 3 466 #endif 467 468 #if SZREG == 4 469 #define REG_L lw 470 #define REG_S sw 471 #define REG_LI li 472 #define REG_ADDU addu 473 #define REG_SLL sll 474 #define REG_SLLV sllv 475 #define REG_SRL srl 476 #define REG_SRLV srlv 477 #define REG_SRA sra 478 #define REG_SRAV srav 479 #define REG_LL ll 480 #define REG_SC sc 481 #define REG_SCALESHIFT 2 482 #else 483 #define REG_L ld 484 #define REG_S sd 485 #define REG_LI dli 486 #define REG_ADDU daddu 487 #define REG_SLL dsll 488 #define REG_SLLV dsllv 489 #define REG_SRL dsrl 490 #define REG_SRLV dsrlv 491 #define REG_SRA dsra 492 #define REG_SRAV dsrav 493 #define REG_LL lld 494 #define REG_SC scd 495 #define REG_SCALESHIFT 3 496 #endif 497 498 #if _MIPS_ISA == _MIPS_ISA_MIPS1 || _MIPS_ISA == _MIPS_ISA_MIPS2 || \ 499 _MIPS_ISA == _MIPS_ISA_MIPS32 500 #define MFC0 mfc0 501 #define MTC0 mtc0 502 #endif 503 #if _MIPS_ISA == _MIPS_ISA_MIPS3 || _MIPS_ISA == _MIPS_ISA_MIPS4 || \ 504 _MIPS_ISA == _MIPS_ISA_MIPS64 505 #define MFC0 dmfc0 506 #define MTC0 dmtc0 507 #endif 508 509 #if defined(__mips_o32) || defined(__mips_o64) 510 511 #ifdef __ABICALLS__ 512 #define CPRESTORE(r) .cprestore r 513 #define CPLOAD(r) .cpload r 514 #else 515 #define CPRESTORE(r) /* not needed */ 516 #define CPLOAD(r) /* not needed */ 517 #endif 518 519 #define SETUP_GP \ 520 .set push; \ 521 .set noreorder; \ 522 .cpload t9; \ 523 .set pop 524 #define SETUP_GPX(r) \ 525 .set push; \ 526 .set noreorder; \ 527 move r,ra; /* save old ra */ \ 528 bal 7f; \ 529 nop; \ 530 7: .cpload ra; \ 531 move ra,r; \ 532 .set pop 533 #define SETUP_GPX_L(r,lbl) \ 534 .set push; \ 535 .set noreorder; \ 536 move r,ra; /* save old ra */ \ 537 bal lbl; \ 538 nop; \ 539 lbl: .cpload ra; \ 540 move ra,r; \ 541 .set pop 542 #define SAVE_GP(x) .cprestore x 543 544 #define SETUP_GP64(a,b) /* n32/n64 specific */ 545 #define SETUP_GP64_R(a,b) /* n32/n64 specific */ 546 #define SETUP_GPX64(a,b) /* n32/n64 specific */ 547 #define SETUP_GPX64_L(a,b,c) /* n32/n64 specific */ 548 #define RESTORE_GP64 /* n32/n64 specific */ 549 #define USE_ALT_CP(a) /* n32/n64 specific */ 550 #endif /* __mips_o32 || __mips_o64 */ 551 552 #if defined(__mips_o32) || defined(__mips_o64) 553 #define REG_PROLOGUE .set push 554 #define REG_EPILOGUE .set pop 555 #endif 556 #if defined(__mips_n32) || defined(__mips_n64) 557 #define REG_PROLOGUE .set push ; .set mips3 558 #define REG_EPILOGUE .set pop 559 #endif 560 561 #if defined(__mips_n32) || defined(__mips_n64) 562 #define SETUP_GP /* o32 specific */ 563 #define SETUP_GPX(r) /* o32 specific */ 564 #define SETUP_GPX_L(r,lbl) /* o32 specific */ 565 #define SAVE_GP(x) /* o32 specific */ 566 #define SETUP_GP64(a,b) .cpsetup $25, a, b 567 #define SETUP_GPX64(a,b) \ 568 .set push; \ 569 move b,ra; \ 570 .set noreorder; \ 571 bal 7f; \ 572 nop; \ 573 7: .set pop; \ 574 .cpsetup ra, a, 7b; \ 575 move ra,b 576 #define SETUP_GPX64_L(a,b,c) \ 577 .set push; \ 578 move b,ra; \ 579 .set noreorder; \ 580 bal c; \ 581 nop; \ 582 c: .set pop; \ 583 .cpsetup ra, a, c; \ 584 move ra,b 585 #define RESTORE_GP64 .cpreturn 586 #define USE_ALT_CP(a) .cplocal a 587 #endif /* __mips_n32 || __mips_n64 */ 588 589 /* 590 * The DYNAMIC_STATUS_MASK option adds an additional masking operation 591 * when updating the hardware interrupt mask in the status register. 592 * 593 * This is useful for platforms that need to at run-time mask 594 * interrupts based on motherboard configuration or to handle 595 * slowly clearing interrupts. 596 * 597 * XXX this is only currently implemented for mips3. 598 */ 599 #ifdef MIPS_DYNAMIC_STATUS_MASK 600 #define DYNAMIC_STATUS_MASK(sr,scratch) \ 601 lw scratch, mips_dynamic_status_mask; \ 602 and sr, sr, scratch 603 604 #define DYNAMIC_STATUS_MASK_TOUSER(sr,scratch1) \ 605 ori sr, (MIPS_INT_MASK | MIPS_SR_INT_IE); \ 606 DYNAMIC_STATUS_MASK(sr,scratch1) 607 #else 608 #define DYNAMIC_STATUS_MASK(sr,scratch) 609 #define DYNAMIC_STATUS_MASK_TOUSER(sr,scratch1) 610 #endif 611 612 /* See lock_stubs.S. */ 613 #define LOG2_MIPS_LOCK_RAS_SIZE 8 614 #define MIPS_LOCK_RAS_SIZE 256 /* 16 bytes left over */ 615 616 #define CPUVAR(off) _C_LABEL(cpu_info_store)+__CONCAT(CPU_INFO_,off) 617 618 #endif /* _MIPS_ASM_H */ 619