github.com/cockroachdb/cockroachdb-parser@v0.23.3-0.20240213214944-911057d40c9a/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  //go:build race
    12  // +build race
    13  
    14  package util
    15  
    16  import "runtime"
    17  
    18  // RaceEnabled is true if CockroachDB was built with the race build tag.
    19  const RaceEnabled = true
    20  
    21  // racePreemptionPoints is set in EnableRacePreemptionPoints.
    22  var racePreemptionPoints = false
    23  
    24  // EnableRacePreemptionPoints enables goroutine preemption points declared with
    25  // RacePreempt for builds using the race build tag.
    26  func EnableRacePreemptionPoints() func() {
    27  	racePreemptionPoints = true
    28  	return func() {
    29  		racePreemptionPoints = false
    30  	}
    31  }
    32  
    33  // RacePreempt adds a goroutine preemption point if CockroachDB was built with
    34  // the race build tag and preemption points have been enabled. The function is a
    35  // no-op (and should be optimized out through dead code elimination) if the race
    36  // build tag was not used.
    37  func RacePreempt() {
    38  	if racePreemptionPoints {
    39  		runtime.Gosched()
    40  	}
    41  }