github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/util/race_on.go (about)

     1  // Copyright 2017 The Cockroach Authors.
     2  //
     3  // Use of this software is governed by the Business Source License
     4  // included in the file licenses/BSL.txt.
     5  //
     6  // As of the Change Date specified in that file, in accordance with
     7  // the Business Source License, use of this software will be governed
     8  // by the Apache License, Version 2.0, included in the file
     9  // licenses/APL.txt.
    10  
    11  // +build race
    12  
    13  package util
    14  
    15  import "runtime"
    16  
    17  // RaceEnabled is true if CockroachDB was built with the race build tag.
    18  const RaceEnabled = true
    19  
    20  // racePreemptionPoints is set in EnableRacePreemptionPoints.
    21  var racePreemptionPoints = false
    22  
    23  // EnableRacePreemptionPoints enables goroutine preemption points declared with
    24  // RacePreempt for builds using the race build tag.
    25  func EnableRacePreemptionPoints() func() {
    26  	racePreemptionPoints = true
    27  	return func() {
    28  		racePreemptionPoints = false
    29  	}
    30  }
    31  
    32  // RacePreempt adds a goroutine preemption point if CockroachDB was built with
    33  // the race build tag and preemption points have been enabled. The function is a
    34  // no-op (and should be optimized out through dead code elimination) if the race
    35  // build tag was not used.
    36  func RacePreempt() {
    37  	if racePreemptionPoints {
    38  		runtime.Gosched()
    39  	}
    40  }