Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/dlyongemallo/valgrind.nvim

Last synced: about 1 month ago
JSON representation

A neovim plugin for valgrind integration.

# valgrind.nvim

A neovim plugin for valgrind (memcheck and helgrind) and sanitizers (address and thread) integration.

## Installation

Use your favorite plugin manager. For example, using [vim-plug](https://github.com/junegunn/vim-plug):

```vim
call plug#begin()
Plug 'dlyongemallo/valgrind.nvim'
call plug#end()

require('valgrind').setup()
```

## Usage

```vim
:Valgrind
:ValgrindLoadXml
:SanitizerLoadLog
```
The output will be populated into the quickfix list.

### Examples

```bash
gcc -g -lpthread.c program.c -o ./program
vim program.c
```

```vim
:Valgind --tool=memcheck ./program
:copen

Note that `--tool=memcheck` is optional as it is the default tool for valgrind.

```vim
:Valgind --tool=helgrind ./program
:copen
```

Alternatively, you can save the output to a xml file and load it in neovim.

```bash
valgrind --tool=valgrind --xml=yes --xml-file=valgrind.xml ./program
vim program.c
```

```vim
:ValgindLoadXml valgrind.xml
:copen
```

```bash
valgrind --tool=helgrind --xml=yes --xml-file=helgrind.xml ./program
vim program.c
```

```vim
:ValgindLoadXml helgrind.xml
:copen
```

For sanitizers, you can do the following:

```bash
gcc -g -fsanitize=address program.c -o ./program
./program 2> asan.log
```

```vim
:SanitizerLoadLog asan.log
```

```bash
gcc -g -fsanitize=thread -lpthread.c program.c -o ./program
./program 2> tsan.log
vim program.c
```

```vim
:SanitizerLoadLog tsan.log
```

It is recommended to use the [Trouble](https://github.com/folke/trouble.nvim) plugin to display the quickfix list in a more useful way.