forked from apache/mxnet
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix PR apache#15489 (Dynamic Library Loading Support) (apache#15760)
* Dynamic Library Loading Support (apache#15489) * Accelerator APIs header file * adding example to test accelerator loading * adding c_api function header * modifying header file path * creating templates for call to lib fns * modifying target to mxnet_static for libdl * rebaseing with master * returning nullptr handle if library not loaded * refactoring code to load libraries dynamically * addressing review comments * using static cast * pylint fix * moving library.h file to src/common/ * adding dynamic loading support for windows * updating header guard * fixing headers * fixing windows casting error * declaring library functions for windows * adding library testing module in examples * adding unit test to test library loading * correcting file names * updating error messages * getting error message from DL library * adding unit test to gpu suite * correcting windows pointer * requiring absolute path to library * changing file description * addressing review comments - adding more docs, windows error msg * addressing PR comments * checking machine type for unit test * “re-trigger” * added map to store loaded libraries * added dlclose calls in naive & threaded engines * removed library map declaration in cc file * added windows free * fixed formatting * added cast to HMODULE for void* for windows * retrigger CI for flaky unix_cpu * build library and stash it in CI * modifying unittest to use CI built binary * Retrigger CI * adding dlclose to initialize destructor * adding sample_lib target to all in Makefile
- Loading branch information
Showing
18 changed files
with
555 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you 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. | ||
|
|
||
| all: | ||
| g++ -shared -fPIC mylib.cc -o mylib.so -I ../../include/mxnet | ||
|
|
||
| test: | ||
| g++ -std=c++11 -O3 -o libtest libtest.cc -ldl -I ../../include/mxnet | ||
|
|
||
| windows: | ||
| cl /LD mylib.cc | ||
|
|
||
| win_test: | ||
| cl libtest.cc | ||
|
|
||
| clean: | ||
| rm -rf mylib.so libtest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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. | ||
| */ | ||
|
|
||
| /*! | ||
| * Copyright (c) 2015 by Contributors | ||
| * \file libtest.cc | ||
| * \brief This test checks if the library is implemented correctly | ||
| * and does not involve dynamic loading of library into MXNet | ||
| * This test is supposed to be run before test.py | ||
| */ | ||
|
|
||
| #if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__) | ||
| #include <windows.h> | ||
| #else | ||
| #include <dlfcn.h> | ||
| #endif | ||
|
|
||
| #include <iostream> | ||
| #include "lib_api.h" | ||
|
|
||
| #define MXNET_VERSION 10500 | ||
|
|
||
| int main(void) { | ||
| // Get a handle to the library. | ||
| #if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__) | ||
| HINSTANCE handle; | ||
| handle = LoadLibrary(TEXT("mylib.dll")); | ||
| #else | ||
| void *handle; | ||
| handle = dlopen("mylib.so", RTLD_LAZY); | ||
| #endif | ||
|
|
||
| if (!handle) { | ||
| std::cerr << "Unable to load library" << std::endl; | ||
| return 1; | ||
| } | ||
|
|
||
| // get initialize function address from the library | ||
| initialize_t init_lib; | ||
| #if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__) | ||
| init_lib = (initialize_t) GetProcAddress(handle, MXLIB_INITIALIZE_STR); | ||
| #else | ||
| init_lib = (initialize_t) dlsym(handle, MXLIB_INITIALIZE_STR); | ||
| #endif | ||
|
|
||
| if (!init_lib) { | ||
| std::cerr << "Unable to get function 'intialize' from library" << std::endl; | ||
| return 1; | ||
| } | ||
|
|
||
| // Call the function. | ||
| (init_lib)(MXNET_VERSION); | ||
|
|
||
| // Deallocate memory. | ||
| #if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__) | ||
| FreeLibrary(handle); | ||
| #else | ||
| dlclose(handle); | ||
| #endif | ||
|
|
||
| return 0; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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. | ||
| */ | ||
|
|
||
| /*! | ||
| * Copyright (c) 2015 by Contributors | ||
| * \file mylib.cc | ||
| * \brief Sample library file | ||
| */ | ||
|
|
||
| #include <iostream> | ||
| #include "lib_api.h" | ||
|
|
||
| int initialize(int version) { | ||
| if (version >= 10400) { | ||
| std::cout << "MXNet version " << version << " supported" << std::endl; | ||
| return 1; | ||
| } else { | ||
| std::cout << "MXNet version " << version << " not supported" << std::endl; | ||
| return 0; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you 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. | ||
|
|
||
| # coding: utf-8 | ||
| # pylint: disable=arguments-differ | ||
|
|
||
| # This test checks if dynamic loading of library into MXNet is successful | ||
|
|
||
| import mxnet as mx | ||
| import os | ||
|
|
||
| if (os.name=='posix'): | ||
| mx.library.load('mylib.so') | ||
| elif (os.name=='nt'): | ||
| mx.library.load('mylib.dll') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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. | ||
| */ | ||
|
|
||
| /*! | ||
| * Copyright (c) 2015 by Contributors | ||
| * \file lib_api.h | ||
| * \brief APIs to interact with libraries | ||
| */ | ||
| #ifndef MXNET_LIB_API_H_ | ||
| #define MXNET_LIB_API_H_ | ||
|
|
||
| /*! | ||
| * \brief Following are the APIs implemented in the external library | ||
| * Each API has a #define string that is used to lookup the function in the library | ||
| * Followed by the function declaration | ||
| */ | ||
| #define MXLIB_INITIALIZE_STR "initialize" | ||
| typedef int (*initialize_t)(int); | ||
|
|
||
| extern "C" { | ||
| /*! | ||
| * \brief Checks if the MXNet version is supported by the library. | ||
| * If supported, initializes the library. | ||
| * \param version MXNet version number passed to library and defined as: | ||
| * MXNET_VERSION = (MXNET_MAJOR*10000 + MXNET_MINOR*100 + MXNET_PATCH) | ||
| * \return Non-zero value on error i.e. library incompatible with passed MXNet version | ||
| */ | ||
| #if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__) | ||
| __declspec(dllexport) int __cdecl initialize(int); | ||
| #else | ||
| int initialize(int); | ||
| #endif | ||
| } | ||
| #endif // MXNET_LIB_API_H_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you 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. | ||
|
|
||
| # coding: utf-8 | ||
| """Library management API of mxnet.""" | ||
| from __future__ import absolute_import | ||
| import ctypes | ||
| import os | ||
| from .base import _LIB, check_call, MXNetError | ||
|
|
||
| def load(path): | ||
| """Loads library dynamically. | ||
| Parameters | ||
| --------- | ||
| path : Path to library .so/.dll file | ||
| Returns | ||
| --------- | ||
| void | ||
| """ | ||
| #check if path exists | ||
| if not os.path.exists(path): | ||
| raise MXNetError("load path %s does NOT exist" % path) | ||
| #check if path is an absolute path | ||
| if not os.path.isabs(path): | ||
| raise MXNetError("load path %s is not an absolute path" % path) | ||
| #check if path is to a library file | ||
| _, file_ext = os.path.splitext(path) | ||
| if not file_ext in ['.so', '.dll']: | ||
| raise MXNetError("load path %s is NOT a library file" % path) | ||
|
|
||
| byt_obj = path.encode('utf-8') | ||
| chararr = ctypes.c_char_p(byt_obj) | ||
| check_call(_LIB.MXLoadLib(chararr)) |
Oops, something went wrong.