test/nosplit.go

   1 // run
   2
   3 // +build !nacl
   4
   5 // Copyright 2014 The Go Authors.  All rights reserved.
   6 // Use of this source code is governed by a BSD-style
   7 // license that can be found in the LICENSE file.
   8
   9 package main
  10
  11 import (
  12         "bytes"
  13         "fmt"
  14         "io/ioutil"
  15         "log"
  16         "os"
  17         "os/exec"
  18         "path/filepath"
  19         "regexp"
  20         "runtime"
  21         "strconv"
  22         "strings"
  23 )
  24
  25 var tests = `
  26 # These are test cases for the linker analysis that detects chains of
  27 # nosplit functions that would cause a stack overflow.
  28 #
  29 # Lines beginning with # are comments.
  30 #
  31 # Each test case describes a sequence of functions, one per line.
  32 # Each function definition is the function name, then the frame size,
  33 # then optionally the keyword 'nosplit', then the body of the function.
  34 # The body is assembly code, with some shorthands.
  35 # The shorthand 'call x' stands for CALL x(SB).
  36 # The shorthand 'callind' stands for 'CALL R0', where R0 is a register.
  37 # Each test case must define a function named main, and it must be first.
  38 # That is, a line beginning "main " indicates the start of a new test case.
  39 # Within a stanza, ; can be used instead of \n to separate lines.
  40 #
  41 # After the function definition, the test case ends with an optional
  42 # REJECT line, specifying the architectures on which the case should
  43 # be rejected. "REJECT" without any architectures means reject on all architectures.
  44 # The linker should accept the test case on systems not explicitly rejected.
  45 #
  46 # 64-bit systems do not attempt to execute test cases with frame sizes
  47 # that are only 32-bit aligned.
  48
  49 # Ordinary function should work
  50 main 0
  51
  52 # Large frame marked nosplit is always wrong.
  53 main 10000 nosplit
  54 REJECT
  55
  56 # Calling a large frame is okay.
  57 main 0 call big
  58 big 10000
  59
  60 # But not if the frame is nosplit.
  61 main 0 call big
  62 big 10000 nosplit
  63 REJECT
  64
  65 # Recursion is okay.
  66 main 0 call main
  67
  68 # Recursive nosplit runs out of space.
  69 main 0 nosplit call main
  70 REJECT
  71
  72 # Chains of ordinary functions okay.
  73 main 0 call f1
  74 f1 80 call f2
  75 f2 80
  76
  77 # Chains of nosplit must fit in the stack limit, 128 bytes.
  78 main 0 call f1
  79 f1 80 nosplit call f2
  80 f2 80 nosplit
  81 REJECT
  82
  83 # Larger chains.
  84 main 0 call f1
  85 f1 16 call f2
  86 f2 16 call f3
  87 f3 16 call f4
  88 f4 16 call f5
  89 f5 16 call f6
  90 f6 16 call f7
  91 f7 16 call f8
  92 f8 16 call end
  93 end 1000
  94
  95 main 0 call f1
  96 f1 16 nosplit call f2
  97 f2 16 nosplit call f3
  98 f3 16 nosplit call f4
  99 f4 16 nosplit call f5
 100 f5 16 nosplit call f6
 101 f6 16 nosplit call f7
 102 f7 16 nosplit call f8
 103 f8 16 nosplit call end
 104 end 1000
 105 REJECT
 106
 107 # Test cases near the 128-byte limit.
 108
 109 # Ordinary stack split frame is always okay.
 110 main 112
 111 main 116
 112 main 120
 113 main 124
 114 main 128
 115 main 132
 116 main 136
 117
 118 # A nosplit leaf can use the whole 128-CallSize bytes available on entry.
 119 main 112 nosplit
 120 main 116 nosplit
 121 main 120 nosplit
 122 main 124 nosplit
 123 main 128 nosplit; REJECT
 124 main 132 nosplit; REJECT
 125 main 136 nosplit; REJECT
 126
 127 # Calling a nosplit function from a nosplit function requires
 128 # having room for the saved caller PC and the called frame.
 129 # Because ARM doesn't save LR in the leaf, it gets an extra 4 bytes.
 130 # Because Power64 doesn't save LR in the leaf, it gets an extra 8 bytes.
 131 main 112 nosplit call f; f 0 nosplit
 132 main 116 nosplit call f; f 0 nosplit
 133 main 120 nosplit call f; f 0 nosplit; REJECT amd64
 134 main 124 nosplit call f; f 0 nosplit; REJECT amd64 386
 135 main 128 nosplit call f; f 0 nosplit; REJECT
 136 main 132 nosplit call f; f 0 nosplit; REJECT
 137 main 136 nosplit call f; f 0 nosplit; REJECT
 138
 139 # Calling a splitting function from a nosplit function requires
 140 # having room for the saved caller PC of the call but also the
 141 # saved caller PC for the call to morestack.
 142 # Again the ARM and Power64 work in less space.
 143 main 104 nosplit call f; f 0 call f
 144 main 108 nosplit call f; f 0 call f
 145 main 112 nosplit call f; f 0 call f; REJECT amd64
 146 main 116 nosplit call f; f 0 call f; REJECT amd64
 147 main 120 nosplit call f; f 0 call f; REJECT amd64 386
 148 main 124 nosplit call f; f 0 call f; REJECT amd64 386
 149 main 128 nosplit call f; f 0 call f; REJECT
 150 main 132 nosplit call f; f 0 call f; REJECT
 151 main 136 nosplit call f; f 0 call f; REJECT
 152
 153 # Indirect calls are assumed to be splitting functions.
 154 main 104 nosplit callind
 155 main 108 nosplit callind
 156 main 112 nosplit callind; REJECT amd64
 157 main 116 nosplit callind; REJECT amd64
 158 main 120 nosplit callind; REJECT amd64 386
 159 main 124 nosplit callind; REJECT amd64 386
 160 main 128 nosplit callind; REJECT
 161 main 132 nosplit callind; REJECT
 162 main 136 nosplit callind; REJECT
 163
 164 # Issue 7623
 165 main 0 call f; f 112
 166 main 0 call f; f 116
 167 main 0 call f; f 120
 168 main 0 call f; f 124
 169 main 0 call f; f 128
 170 main 0 call f; f 132
 171 main 0 call f; f 136
 172 `
 173
 174 var (
 175         commentRE = regexp.MustCompile(`(?m)^#.*`)
 176         rejectRE  = regexp.MustCompile(`(?s)\A(.+?)((\n|; *)REJECT(.*))?\z`)
 177         lineRE    = regexp.MustCompile(`(\w+) (\d+)( nosplit)?(.*)`)
 178         callRE    = regexp.MustCompile(`\bcall (\w+)\b`)
 179         callindRE = regexp.MustCompile(`\bcallind\b`)
 180 )
 181
 182 func main() {
 183         goarch := os.Getenv("GOARCH")
 184         if goarch == "" {
 185                 goarch = runtime.GOARCH
 186         }
 187
 188         dir, err := ioutil.TempDir("", "go-test-nosplit")
 189         if err != nil {
 190                 bug()
 191                 fmt.Printf("creating temp dir: %v\n", err)
 192                 return
 193         }
 194         defer os.RemoveAll(dir)
 195
 196         tests = strings.Replace(tests, "\t", " ", -1)
 197         tests = commentRE.ReplaceAllString(tests, "")
 198
 199         nok := 0
 200         nfail := 0
 201 TestCases:
 202         for len(tests) > 0 {
 203                 var stanza string
 204                 i := strings.Index(tests, "\nmain ")
 205                 if i < 0 {
 206                         stanza, tests = tests, ""
 207                 } else {
 208                         stanza, tests = tests[:i], tests[i+1:]
 209                 }
 210
 211                 m := rejectRE.FindStringSubmatch(stanza)
 212                 if m == nil {
 213                         bug()
 214                         fmt.Printf("invalid stanza:\n\t%s\n", indent(stanza))
 215                         continue
 216                 }
 217                 lines := strings.TrimSpace(m[1])
 218                 reject := false
 219                 if m[2] != "" {
 220                         if strings.TrimSpace(m[4]) == "" {
 221                                 reject = true
 222                         } else {
 223                                 for _, rej := range strings.Fields(m[4]) {
 224                                         if rej == goarch {
 225                                                 reject = true
 226                                         }
 227                                 }
 228                         }
 229                 }
 230                 if lines == "" && !reject {
 231                         continue
 232                 }
 233
 234                 var gobuf bytes.Buffer
 235                 fmt.Fprintf(&gobuf, "package main\n")
 236
 237                 var buf bytes.Buffer
 238                 ptrSize := 4
 239                 switch goarch {
 240                 case "power64", "power64le":
 241                         ptrSize = 8
 242                         fmt.Fprintf(&buf, "#define CALL BL\n#define REGISTER (CTR)\n#define RET RETURN\n")
 243                 case "arm":
 244                         fmt.Fprintf(&buf, "#define CALL BL\n#define REGISTER (R0)\n")
 245                 case "amd64":
 246                         ptrSize = 8
 247                         fmt.Fprintf(&buf, "#define REGISTER AX\n")
 248                 default:
 249                         fmt.Fprintf(&buf, "#define REGISTER AX\n")
 250                 }
 251
 252                 for _, line := range strings.Split(lines, "\n") {
 253                         line = strings.TrimSpace(line)
 254                         if line == "" {
 255                                 continue
 256                         }
 257                         for i, subline := range strings.Split(line, ";") {
 258                                 subline = strings.TrimSpace(subline)
 259                                 if subline == "" {
 260                                         continue
 261                                 }
 262                                 m := lineRE.FindStringSubmatch(subline)
 263                                 if m == nil {
 264                                         bug()
 265                                         fmt.Printf("invalid function line: %s\n", subline)
 266                                         continue TestCases
 267                                 }
 268                                 name := m[1]
 269                                 size, _ := strconv.Atoi(m[2])
 270
 271                                 // The limit was originally 128 but is now 512.
 272                                 // Instead of rewriting the test cases above, adjust
 273                                 // the first stack frame to use up the extra 32 bytes.
 274                                 if i == 0 {
 275                                         size += 512 - 128
 276                                 }
 277
 278                                 if size%ptrSize == 4 {
 279                                         continue TestCases
 280                                 }
 281                                 nosplit := m[3]
 282                                 body := m[4]
 283
 284                                 if nosplit != "" {
 285                                         nosplit = ",7"
 286                                 } else {
 287                                         nosplit = ",0"
 288                                 }
 289                                 body = callRE.ReplaceAllString(body, "CALL ·$1(SB);")
 290                                 body = callindRE.ReplaceAllString(body, "CALL REGISTER;")
 291
 292                                 fmt.Fprintf(&gobuf, "func %s()\n", name)
 293                                 fmt.Fprintf(&buf, "TEXT ·%s(SB)%s,$%d-0\n\t%s\n\tRET\n\n", name, nosplit, size, body)
 294                         }
 295                 }
 296
 297                 if err := ioutil.WriteFile(filepath.Join(dir, "asm.s"), buf.Bytes(), 0666); err != nil {
 298                         log.Fatal(err)
 299                 }
 300                 if err := ioutil.WriteFile(filepath.Join(dir, "main.go"), gobuf.Bytes(), 0666); err != nil {
 301                         log.Fatal(err)
 302                 }
 303
 304                 cmd := exec.Command("go", "build")
 305                 cmd.Dir = dir
 306                 output, err := cmd.CombinedOutput()
 307                 if err == nil {
 308                         nok++
 309                         if reject {
 310                                 bug()
 311                                 fmt.Printf("accepted incorrectly:\n\t%s\n", indent(strings.TrimSpace(stanza)))
 312                         }
 313                 } else {
 314                         nfail++
 315                         if !reject {
 316                                 bug()
 317                                 fmt.Printf("rejected incorrectly:\n\t%s\n", indent(strings.TrimSpace(stanza)))
 318                                 fmt.Printf("\n\tlinker output:\n\t%s\n", indent(string(output)))
 319                         }
 320                 }
 321         }
 322
 323         if !bugged && (nok == 0 || nfail == 0) {
 324                 bug()
 325                 fmt.Printf("not enough test cases run\n")
 326         }
 327 }
 328
 329 func indent(s string) string {
 330         return strings.Replace(s, "\n", "\n\t", -1)
 331 }
 332
 333 var bugged = false
 334
 335 func bug() {
 336         if !bugged {
 337                 bugged = true
 338                 fmt.Printf("BUG\n")
 339         }
 340 }