Skip to content
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.

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

rbd: add feature check to see if GroupSnapGetInfo is available #4898

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 48 additions & 0 deletions internal/rbd/features/dlsym.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
Copyright 2024 The Ceph-CSI Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package features

/*
#cgo LDFLAGS: -ldl
#include <stdlib.h>
#include <dlfcn.h>
*/
import "C"

import (
"fmt"
"unsafe"
)

// dlsym checks if the given symbol is provided by the currently loaded
// libraries. If the symbol is available, no error is returned.
func dlsym(symbol string) error {
c_symbol := C.CString(symbol)
//nolint:nlreturn // linter complains about missing empty line!?
defer C.free(unsafe.Pointer(c_symbol))

// clear dlerror before looking up the symbol
C.dlerror()
_ = C.dlsym(nil, c_symbol)
e := C.dlerror()
err := C.GoString(e)
if err != "" {
return fmt.Errorf("dlsym: %s", err)
}

return nil
}
58 changes: 58 additions & 0 deletions internal/rbd/features/features.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
Copyright 2024 The Ceph-CSI Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package features

/*
#cgo LDFLAGS: -lrbd
#include <rbd/librbd.h>
*/
import "C"

import (
"strings"
"sync"
)

var (
groupGetSnapInfoOnce sync.Once
errGroupGetSnapInfo error
groupGetSnapInfoSupported = false
)

// SupportsGroupSnapGetInfo detects if librbd has the rbd_group_snap_get_info
// function.
func SupportsGroupSnapGetInfo() (bool, error) {
groupGetSnapInfoOnce.Do(func() {
// make sure librbd.so.x is loaded, might not (yet) be the case
// if no rbd functions are called
var opts C.rbd_image_options_t
//nolint:gocritic // ignore result of rbd_image_options functions
C.rbd_image_options_create(&opts)
C.rbd_image_options_destroy(opts)
Comment on lines +42 to +45
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nixpanic do we need to create/destory the image? can you please add a comment about a need for it as well?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is just to call an RBD function that won't cause any harm.

RBD-image-options can be created and destroyed without accessing the Ceph cluster. You can see the options as an in-memory list of features. The options are used when an image is created, and features of the image can be set in the options object and passed to rbd.CreateImage() and similar functions.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the comment is just above it:

		// make sure librbd.so.x is loaded, might not (yet) be the case
		// if no rbd functions are called


// check for rbd_group_snap_get_info() in loaded libs/symbols
errGroupGetSnapInfo = dlsym("rbd_group_snap_get_info")

if errGroupGetSnapInfo == nil {
groupGetSnapInfoSupported = true
} else if strings.Contains(errGroupGetSnapInfo.Error(), "undefined symbol") {
errGroupGetSnapInfo = nil
}
})

return groupGetSnapInfoSupported, errGroupGetSnapInfo
}
32 changes: 32 additions & 0 deletions internal/rbd/features/features_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
Copyright 2024 ceph-csi authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package features

import (
"testing"
)

func TestSupportsGroupSnapGetInfo(t *testing.T) {
t.Parallel()

supported, err := SupportsGroupSnapGetInfo()
if err != nil {
t.Errorf("failed to check support for GroupSnapGetInfo: %v", err)
}

t.Logf("GroupSnapGetInfo supported: %t", supported)
}