https://github.com/amit-davidson/Chronos

Chronos - A static race detector for the go language
https://github.com/amit-davidson/Chronos

analysis data-race-detection detection detects-races go golang mutex-synchronisation pointer-analysis race-condition race-conditions race-detection ssa static-analysis static-code-analysis synchronization

Last synced: 30 days ago
JSON representation

Chronos - A static race detector for the go language

• Host: GitHub
• URL: https://github.com/amit-davidson/Chronos
• Owner: amit-davidson
• License: mit
• Created: 2020-10-02T13:39:18.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-04-22T08:41:52.000Z (over 2 years ago)
• Last Synced: 2024-08-03T17:20:53.083Z (4 months ago)
• Topics: analysis, data-race-detection, detection, detects-races, go, golang, mutex-synchronisation, pointer-analysis, race-condition, race-conditions, race-detection, ssa, static-analysis, static-code-analysis, synchronization
• Language: Go
• Homepage:
• Size: 13.4 MB
• Stars: 425
• Watchers: 5
• Forks: 11
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• go-awesome - Chronos - static race detector (Open source library / Development Aid Package)

README

        
# Chronos



    



[![made-with-Go](https://github.com/go-critic/go-critic/workflows/Go/badge.svg)](http://golang.org)

[![made-with-Go](https://img.shields.io/badge/Made%20with-Go-1f425f.svg)](http://golang.org)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![amit-davidson](https://circleci.com/gh/amit-davidson/Chronos.svg?style=svg)](https://app.circleci.com/pipelines/github/amit-davidson/Chronos)

Chronos is a static race detector for the Go language written in Go.

## Quick Start:

Download the package

```

go get -v github.com/amit-davidson/Chronos/cmd/chronos

```

Pass the entry point

```

chronos --file  --mod 

```

Help

```

Usage of ./chronos:

  --file string

    	The file containing the entry point of the program

  --mod string

    	Absolute or relative path to the module where the search should be performed. Should end in the format:{VCS}/{organization}/{package}. Packages outside this path are excluded rom the search.

```

## Example:



    

    



## Features:

Support:

- Detects races on pointers passed around the program.

- Analysis of conditional branches, nested functions, interfaces, select, gotos, defers, for loops and recursions.

- Synchronization using mutex and goroutines starts.

Limitations:

- Big programs and external packages. (Due to stack overflow)

- Synchronization using channels, waitgroups, once, cond and atomic.

## Chronos vs go race:

Chronos successfully reports cases where go race fails thanks to it's static nature. Mostly because data races appear in unexpected production workloads, which are hard to produce in dev.

In addition, go race is having trouble with short programs where without contrived synchronization the program may exit too quickly.

In contrast, Chronos managed to report only 244/403 = 60.5% of go race test cases. This can be explained by Chronos partial support with Go's features so this number will increase in the future.

Also, it lacked due to his static nature where context/path sensitivity was required.

Therefore, I suggest using both according the strengths and weaknesses of each of the race detectors.

## Credits:

Jan Wen, J., Jhala, R., & Lerner, S. (n.d.). [RELAY: Static Race Detection on Millions of Lines of Code](https://cseweb.ucsd.edu/~lerner/papers/relay.pdf)  

Colin J. Fidge (February 1988). [Timestamps in Message-Passing Systems That Preserve the Partial Ordering"](http://zoo.cs.yale.edu/classes/cs426/2012/lab/bib/fidge88timestamps.pdf)

## More examples: