Call cxx-static-lib in Go

Posted on In Views: Word count in article: 1.5k Reading time ≈ 1 mins.
Here is a quick start for call cxx-static-lib in Go on Windows(MinGW)/Linux.

How to compile and call a CXX-static library in Golang

touch some files first

1
2
3
# create a directory for this project
mkdir -p ./hi/lib; cd ./hi
touch ./main.go ./lib/hi.h ./lib/hi.cpp

Create a header file: hi.h

In comparison with c-static-lib, the header file here has some extra contents

extern "C" { ... }

mainly to be compatible with C++ compilers.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
#ifndef HI_H
#define HI_H

#ifdef __cplusplus
extern "C" {
#endif

void print_hi();

#ifdef __cplusplus
}
#endif

#endif // HI_H

Create a source file: hi.cpp

Different from c-static-lib, the c++ source file must include the header file.

#include "hi.h"

1
2
3
4
5
6
7
#include <iostream>
#include "hi.h"

void print_hi() {
    std::cout << "hi, from C++\n";
}

Create a main file: main.go

Compared to c-static-lib, the LDFLAGS here has an extra -l stdc++ to link the C++
standard library.

1
2
3
4
5
6
7
8
9
10
11
12
13
package main

/*
#cgo CFLAGS: -I ${SRCDIR}/lib
#cgo LDFLAGS: -L ${SRCDIR}/lib -l hi -l stdc++
#include "hi.h"
*/
import "C"

func main() {
    C.print_hi()
}

Compile the source file into a static library

1
2
g++ -c ./lib/hi.cpp -o ./lib/hi.o
ar rcs ./lib/libhi.a ./lib/hi.o

Run

1
2
3
4
5
# go run directly
go run main.go

# or build and run
go build -o bin/hi main.go && ./bin/hi

Summary

The key points are different from call c-static-lib:

  • use extern "C" { ... } in header file to be compatible with C++ compilers
  • source file must include the header file
  • add -l stdc++ to LDFLAGS
  • use g++ to compile the source file into a static library

If you are not sure the static lib is c or c++,
your golang code can always use the c++ way to call it, which is more compatible.

Always add -l stdc++ to LDFLAGS

FYI

Source Code