一文带大家了解Go语言中的内联优化

// ValidateName 验证给定的用户名是否合法
//
//go:noinline
func ValidateName(name string) bool { // AX: 字符串指针  BX: 字符串长度
    if len(name) < 1 {
        return false
    } else if len(name) > 12 {
        return false
    }
    return true
}
//go:noinline
func (s *Server) CreateUser(name string, password string) error {
    if !ValidateName(name) {
        return errors.New("invalid name")
    }
    // ...
    return nil
}
type Server struct{}

// ...
// ValidateName函数 
// 此时:
// AX寄存器: 指向name字符串数组的指针
// BX寄存器: name字符串的长度
TEXT github.com/bootun/example/user.ValidateName(SB) github.com/bootun/example/user/user.go
    user.go:9   0x4602c0  MOVQ AX, 0x8(SP) // 保存name字符串的指针到栈上（后面没有用到）
    user.go:10  0x4602c5  TESTQ BX, BX     // BX & BX, 用来检测BX是否为0, 等价于:CMPQ 0, BX
    user.go:10  0x4602c8  JE 0x4602d9      // 如果为0则跳转到0x4602d9
    user.go:12  0x4602ca  CMPQ $0xc, BX    // 比较常数12和name的长度
    user.go:12  0x4602ce  JLE 0x4602d3     // 小于等于12则跳转到0x4602d3
    user.go:13  0x4602d0  XORL AX, AX      // return false
    user.go:13  0x4602d2  RET
    user.go:15  0x4602d3  MOVL $0x1, AX    // return true
    user.go:15  0x4602d8  RET
    user.go:11  0x4602d9  XORL AX, AX      // return false
    user.go:11  0x4602db  RET
// CreateUser方法
TEXT github.com/bootun/example/user.(*Server).CreateUser(SB) /github.com/bootun/example/user/user.go
    // 省略了一些函数调用前的准备工作(寄存器赋值等操作)
    user.go:20    0x460300  CALL user.ValidateName(SB)
    user.go:20    0x460305  TESTL AL, AL
    user.go:20    0x460307  JE 0x460317
    user.go:24    0x460309  XORL AX, AX
    user.go:24    0x46030b  XORL BX, BX
    user.go:24    0x46030d  MOVQ 0x10(SP), BP
    user.go:24    0x460312  ADDQ $0x18, SP
    user.go:24    0x460316  RET
    errors.go:62  0x460317  LEAQ 0x9302(IP), AX
    errors.go:62  0x46031e  NOPW
    errors.go:62  0x460320  CALL runtime.newobject(SB)
    // ...

// CreateUser函数
// 此时:
// AX寄存器: 方法Recever,即Server结构体
// BX寄存器: name字符串的指针
// CX寄存器: name字符串的长度
TEXT github.com/bootun/example/user.(*Server).CreateUser(SB) /github.com/bootun/example/user/user.go
    // ...              
    user.go:18    0x4602d4  MOVQ BX, 0x28(SP)    // 保存name字符串的指针到栈上
    user.go:19    0x4602d9  TESTQ CX, CX         // 验证name的长度是否为0
    user.go:9     0x4602dc  JE 0x4602e6          // 为0则跳转到0x4602e6
    user.go:9     0x4602de  NOPW
    user.go:11    0x4602e0  CMPQ $0xc, CX        // 比较常数12和字符串的长度
    user.go:11    0x4602e4  JLE 0x460318         // 小于等于则跳转到0x460318继续执行(name合法)
    errors.go:62  0x4602e6  LEAQ 0x9333(IP), AX  // 构造错误返回                   
    errors.go:62  0x4602ed  CALL runtime.newobject(SB)                  
    errors.go:62  0x4602f2  MOVQ $0xc, 0x8(AX)                    
    // ...
    user.go:23    0x460318  XORL AX, AX      // AX = 0
    user.go:23    0x46031a  XORL BX, BX      // BX = 0				
    user.go:23    0x46031c  MOVQ 0x10(SP), BP  // 恢复BP寄存器
    user.go:23    0x460321  ADDQ $0x18, SP     // 增加栈指针, 减小栈空间
    user.go:23    0x460325  RET                // return
    // ...

func (s *Server) CreateUser(name string, password string) error {
    if len(name) < 1 {
        return errors.New("invalid name")
    } else if len(name) > 12 {
        return errors.New("invalid name")
    }
    return nil
}

// The Debug.l flag controls the aggressiveness. Note that main() swaps level 0 and 1,
// making 1 the default and -l disable. Additional levels (beyond -l) may be buggy and
// are not supported.
//      0: disabled
//      1: 80-nodes leaf functions, oneliners, panic, lazy typechecking (default)
//      2: (unassigned)
//      3: (unassigned)
//      4: allow non-leaf functions
//
// At some point this may get another default and become switch-offable with -N.
//
// The -d typcheckinl flag enables early typechecking of all imported bodies,
// which is useful to flush out bugs.
//
// The Debug.m flag enables diagnostic output.  a single -m is useful for verifying

func (m *Mutex) Lock() {
    // Fast path: grab unlocked mutex.
    if atomic.CompareAndSwapInt32(&m.state, 0, mutexLocked) {
        if race.Enabled {
            race.Acquire(unsafe.Pointer(m))
        }
        return
    }
    // Slow path (outlined so that the fast path can be inlined)
    m.lockSlow()
}

package user
import (
      "errors"
)
func ValidateName(name string) bool {
      if len(name) < 1 {
            return false
      } else if len(name) > 12 {
            return false
      }
      return true
}
//go:noinline
func ValidateNameNoInline(name string) bool {
      if len(name) < 1 {
            return false
      } else if len(name) > 12 {
            return false
      }
      return true
}
func (s *Server) CreateUser(name string, password string) error {
      if !ValidateName(name) {
            return errors.New("invalid name")
      }
      return nil
}
// CreateUserNoInline 使用的是禁止内联版本的 ValidateName
func (s *Server) CreateUserNoInline(name string, password string) error {
      if !ValidateNameNoInline(name) {
            return errors.New("invalid name")
      }
      return nil
}
type Server struct{}

package user
import "testing"
// BenchmarkCreateUser 测试内联过的函数的性能
func BenchmarkCreateUser(b *testing.B) {
      srv := Server{}
      for i := 0; i < b.N; i++ {
            if err := srv.CreateUser("bootun", "123456"); err != nil {
                  b.Logf("err: %v", err)
            }
      }
}
// BenchmarkValidateNameNoInline 测试函数禁止内联后的性能
func BenchmarkValidateNameNoInline(b *testing.B) {
      srv := Server{}
      for i := 0; i < b.N; i++ {
            if err := srv.CreateUserNoInline("bootun", "123456"); err != nil {
                  b.Logf("err: %v", err)
            }
      }
}