Skip to content

Fixed an extremely rare race-condition during compile #2512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2024
Merged

Fixed an extremely rare race-condition during compile #2512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions internal/arduino/builder/internal/compilation/database.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"encoding/json"
"fmt"
"os"
"sync"

"github.com/arduino/arduino-cli/internal/i18n"
"github.com/arduino/go-paths-helper"
Expand All @@ -28,8 +29,9 @@ var tr = i18n.Tr

// Database keeps track of all the compile commands run by the builder
type Database struct {
Contents []Command
File *paths.Path
lock sync.Mutex
contents []Command
file *paths.Path
}

// Command keeps track of a single run of a compile command
Expand All @@ -43,8 +45,8 @@ type Command struct {
// NewDatabase creates an empty CompilationDatabase
func NewDatabase(filename *paths.Path) *Database {
return &Database{
File: filename,
Contents: []Command{},
file: filename,
contents: []Command{},
}
}

Expand All @@ -55,16 +57,18 @@ func LoadDatabase(file *paths.Path) (*Database, error) {
return nil, err
}
res := NewDatabase(file)
return res, json.Unmarshal(f, &res.Contents)
return res, json.Unmarshal(f, &res.contents)
}

// SaveToFile save the CompilationDatabase to file as a clangd-compatible compile_commands.json,
// see https://clang.llvm.org/docs/JSONCompilationDatabase.html
func (db *Database) SaveToFile() {
if jsonContents, err := json.MarshalIndent(db.Contents, "", " "); err != nil {
db.lock.Lock()
defer db.lock.Unlock()
if jsonContents, err := json.MarshalIndent(db.contents, "", " "); err != nil {
fmt.Println(tr("Error serializing compilation database: %s", err))
return
} else if err := db.File.WriteFile(jsonContents); err != nil {
} else if err := db.file.WriteFile(jsonContents); err != nil {
fmt.Println(tr("Error writing compilation database: %s", err))
}
}
Expand All @@ -88,5 +92,7 @@ func (db *Database) Add(target *paths.Path, command *paths.Process) {
File: target.String(),
}

db.Contents = append(db.Contents, entry)
db.lock.Lock()
db.contents = append(db.contents, entry)
db.lock.Unlock()
}
10 changes: 5 additions & 5 deletions internal/arduino/builder/internal/compilation/database_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ func TestCompilationDatabase(t *testing.T) {
db2, err := LoadDatabase(tmpfile)
require.NoError(t, err)
require.Equal(t, db, db2)
require.Len(t, db2.Contents, 1)
require.Equal(t, db2.Contents[0].File, "test")
require.Equal(t, db2.Contents[0].Command, "")
require.Equal(t, db2.Contents[0].Arguments, []string{"gcc", "arg1", "arg2"})
require.Len(t, db2.contents, 1)
require.Equal(t, db2.contents[0].File, "test")
require.Equal(t, db2.contents[0].Command, "")
require.Equal(t, db2.contents[0].Arguments, []string{"gcc", "arg1", "arg2"})
cwd, err := paths.Getwd()
require.NoError(t, err)
require.Equal(t, db2.Contents[0].Directory, cwd.String())
require.Equal(t, db2.contents[0].Directory, cwd.String())
}