ロードするモジュールのパスに環境変数を設定可能にする #1010

Nobu19800 · 2022-01-19T09:04:07Z

Identify the Bug

manager.modules.load_path、manager.preload.modules、manager.modules.<lang>.load_paths、logger.pluginsで設定したモジュールを絶対パスで設定した場合、他の環境に移植する場合にパスが変わるため修正の必要がある。

Description of the Change

manager.modules.load_path、manager.preload.modules、manager.modules.<lang>.load_paths、logger.pluginsに以下のように環境変数を設定できるようにした。

manager.modules.load_path: ${RTM_ROOT}/ext/${RTM_VC_VERSION}/http

この例ではWindowsインストーラーでRTM_ROOTとRTM_VC_VERSIONが設定されるため、他の環境でも同じモジュールをロードできる。

Verification

Did you succeed the build?
No warnings for the build?
Have you passed the unit tests?

n-kawauchi

最新masterへマージしたところコンフリクトしました。

>git merge feature/config_replace_env
Auto-merging src/lib/rtm/ModuleManager.cpp
CONFLICT (content): Merge conflict in src/lib/rtm/ModuleManager.cpp
Automatic merge failed; fix conflicts and then commit the result.

n-kawauchi · 2025-09-12T09:02:53Z

manager.modules.load_path の確認のため、managerのLoadableModulesのパスを表示させたところJavaのRTCのみパスが見えません。

rtc.confは下記にし、

manager.modules.load_path: ${RTM_ROOT}/c++/examples/rtc/,${RTM_ROOT}/python3/SimpleIO/,${RTM_ROOT}/components/java/RTMExamples/SimpleIO/

以下を実行

export RTM_ROOT=/usr/share/openrtm-2.1/components
rtcd2 -d -f rtc.conf

OpenRTP上でmanagerのプロパティのLoadableModulesを確認したところ、C++とPythonのRTCパスは表示されるが、Java RTCのパスのみ表示されない
この時のログは以下の通り

Sep 12 07:35:43.086 DEBUG: manager:     - load_path: ${RTM_ROOT}/c++/examples/rtc/,${RTM_ROOT}/python3/SimpleIO/,${RTM_ROOT}/components/java/RTMExamples/SimpleIO/
Sep 12 07:35:53.919 DEBUG: ModuleManager: Module load path: /usr/share/openrtm-2.1/components/components/java/RTMExamples/SimpleIO/
Sep 12 07:35:53.919 DEBUG: ModuleManager: File list (path:/usr/share/openrtm-2.1/components/components/java/RTMExamples/SimpleIO/, ext:class):
Sep 12 07:35:53.919 DEBUG: ModuleManager: Java:
Sep 12 07:35:53.919 DEBUG: ModuleManager: Modile profile size: 0 (newly founded modules)

manager.modules.load_pathで環境変数を使わない場合はC++, Python, Java の全てのRTCのパスが見える

manager.modules.load_path: /usr/share/openrtm-2.1/components/c++/examples/rtc/,/usr/share/openrtm-2.1/components/python3/SimpleIO/,/usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO/

この時のログは以下だった

Sep 12 08:35:20.272 DEBUG: manager:     - load_path: /usr/share/openrtm-2.1/components/c++/examples/rtc/,/usr/share/openrtm-2.1/components/python3/SimpleIO/,/usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO/
Sep 12 08:35:36.086 DEBUG: ModuleManager: Module load path: /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO/
Sep 12 08:35:36.086 DEBUG: ModuleManager: File list (path:/usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO/, ext:class): /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//is_existing.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//ConsoleInImpl$Listener.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//ConnectorComp.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//ConsoleInImpl.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//ConsoleIn.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//UserManagerAction.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//is_alive_in_default_ec.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//get_component_profile_Comp.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//ConsoleOutImpl.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//ConsoleOutImpl$DataListener.class, /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO//get_act
Sep 12 08:35:36.086 DEBUG: ModuleManager: Module /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO/ConsoleIn.class already exists in cache.
Sep 12 08:35:36.086 DEBUG: ModuleManager: Module /usr/share/openrtm-2.1/components/java/RTMExamples/SimpleIO/ConsoleOut.class already exists in cache.

n-kawauchi · 2025-09-24T06:28:43Z

manager.modules.load_path、manager.preload.modules、manager.modules..load_paths、logger.plugins のそれぞれで環境変数を使用したパスで指定してみたところ、logger.plugins のみがエラーになります。

logger.plugins の確認・・・rtc.fluentbit_stream.confを使用
- 確認はHOME下に /usr/share/openrtm-2.1/components/c++/examples と /usr/etc/logger/rtc.fluentbit_stream.conf をコピーしてログファイルを残せる環境で確認した
- 環境変数を利用してパスを定義
  logger.plugins: ${RTM_LIB}/logger/FluentBit.so
- 下記手順で実行
```
$ export RTM_LIB=/usr/lib/x86_64-linux-gnu/openrtm-2.1
$ export LD_PRELOAD=/usr/lib/fluent-bit/libfluent-bit.so
$ ./ConsoleOutComp -f rtc.fluentbit_stream.conf
```
- ログを確認すると環境変数が展開されずエラーになっている
```
Sep 24 05:30:59.191 ERROR: ModuleManager: Module file not found: ${RTM_LIB}/logger/FluentBit.so
Sep 24 05:30:59.191 WARNING: manager: Logstream plugin module load failed: ${RTM_LIB}/logger/FluentBit.so
Sep 24 05:30:59.191 WARNING: manager: Logstream fluentd creation failed.
```
- この時、printenvで確認したら、RTM_LIB=/usr/lib/x86_64-linux-gnu/openrtm-2.1 となっていました
- 従来の絶対パスで指定した場合は問題なく起動できます
  logger.plugins: /usr/lib/x86_64-linux-gnu/openrtm-2.1/logger/FluentBit.so
- この時のRTCログは以下の通りです。
```
Sep 24 05:09:05.546 DEBUG: ModuleManager: Finding function symbol: FluentBitInit in /usr/lib/x86_64-linux-gnu/openrtm-2.1/logger/FluentBit.so
Sep 24 05:09:05.552 INFO: manager: Logstream fluentd created.
Sep 24 05:09:05.563 INFO: manager: Logstream fluentd added.
```

以下は動作OKだったパスの確認結果です。

manager.modules.load_path
- マスターマネージャーからC++のスレーブマネージャー経由でRTCを起動する動作で確認
- rtc.confを次のように指定
```
manager.modules.load_path: ${RTM_ROOT}/c++/examples/rtc/,${RTM_ROOT}/python3/SimpleIO/,${RTM_ROOT}/java/RTMExamples/SimpleIO/
```
- 以下を実行し、RTSEのManagerのプロパティでのLoadableModulesのコンポーネントリストを確認
```
$ export RTM_ROOT=/usr/share/openrtm-2.1/components
$ rtcd2 -d -f rtc.conf
```

manager.modules. [lang] .load_paths

rtc.confを次のように指定

manager.modules.load_path:
manager.modules.C++.load_paths: ${RTM_ROOT}/c++/examples/rtc/
manager.modules.Python.load_paths: ${RTM_ROOT}/python3/SimpleIO/
manager.modules.Java.load_paths: ${RTM_ROOT}/java/RTMExamples/SimpleIO/

manager.preload.modules
HTTP通信で使用する /usr/etc/http/rtc.http.conf をコピーして次のように修正して確認

manager.modules.load_path:
manager.preload.modules: ${RTM_LIB}/http/HTTPTransport.so

以下を実行

$ /usr/bin/openrtmNames -f /usr/etc/rtc.names.http.conf
$ export RTM_LIB=/usr/lib/x86_64-linux-gnu/openrtm-2.1
$ /usr/share/openrtm-2.1/components/c++/examples/ConsoleOutComp -f rtc.http.conf

Nobu19800 · 2025-09-25T09:55:02Z

修正したのでこれで試してみてください。

n-kawauchi · 2025-09-29T05:57:42Z

修正して頂いたソースで動作確認しましたが、これまでOKだった動作がNGとなりました。

logger.plugins　・・・今回の修正で動作OK
manager.modules.load_path、manager.modules. [lang] .load_paths　・・・今回の修正でも動作OK

manager.preload.modules　・・・今回の修正で動作NGとなってしまった

rtc.http.conf で環境変数使用

manager.modules.load_path:
manager.preload.modules: ${RTM_LIB}/http/HTTPTransport.so

環境変数定義はRTC実行前に確認

$ printenv | grep RTM
RTM_LIB=/usr/lib/x86_64-linux-gnu/openrtm-2.1

RTC実行

$ ./ConsoleInComp -f rtc.http.conf
omniORB: (0) 2025-09-29 14:29:29.150250: Error: Unable to create an endpoint of this description: giop:http:http:///call
omniORB: (0) 2025-09-29 14:29:29.151544: Error: Unable to create an endpoint of this description: giop:http:http:///call
omniORB: (? 129454131115712) 2025-09-29 14:29:49.777858: Error: the application attempted to invoke an operation on a nil pseudo-object reference.
terminate called after throwing an instance of 'CORBA::INV_OBJREF'
中止 (コアダンプ)

この時のRTCログ抜粋

Sep 29 05:29:29.149 PARANOID: manager: ORB options: -ORBserverTransportRule "* http" -ORBclientTransportRule "* http" -ORBendPoint giop:http:http:///call -ORBendPointPublish all(addr)
Sep 29 05:29:29.150 ERROR: manager: Exception: Caught unknown exception in initORB().
Sep 29 05:29:29.150 TRACE: manager: Manager::initNaming()
Sep 29 05:29:29.150 TRACE: manager: Register Naming Server: corba/http://localhost:2809/call

rtc.confで環境変数を使わない場合は問題なく動作する

manager.modules.load_path: /usr/lib/x86_64-linux-gnu/openrtm-2.1/http
manager.preload.modules: HTTPTransport.so

正常に動いた時のRTCログは下記

Sep 29 05:37:41.899 PARANOID: manager: ORB options: -ORBserverTransportRule "* http" -ORBclientTransportRule "* http" -ORBendPoint giop:http:http:///call -ORBendPointPublish all(addr)
Sep 29 05:37:41.910 TRACE: manager: Manager::initNaming()
Sep 29 05:37:41.910 TRACE: manager: Register Naming Server: corba/http://localhost:2809/call

Nobu19800 · 2025-09-29T09:54:27Z

再度修正したので試してください。

n-kawauchi · 2025-10-10T06:37:12Z

修正して頂いたソースで確認しましたが、全部OKになりません。
logger.pluginsとmanager.preload.modulesの結果OK/NGが修正の都度入れ替わっています。

前々回の確認
- logger.plugins　・・・NG
- manager.modules.load_path、manager.modules. [lang] .load_paths　・・・OK
- manager.preload.modules　・・・OK
前回の確認
- logger.plugins　・・・前回の修正で動作OKとなる
- manager.modules.load_path、manager.modules. [lang] .load_paths　・・・OK
- manager.preload.modules　・・・前回の修正で動作NGとなる
今回の確認
- logger.plugins　・・・今回の修正で動作NGとなる
  - 環境変数が展開されません。従来の絶対パスで指定した場合はOKです。
- manager.modules.load_path、manager.modules. [lang] .load_paths　・・・OK
- manager.preload.modules　・・・今回の修正で動作OKとなる

Nobu19800 · 2025-10-14T05:41:18Z

修正したので確認をお願いします。
@n-kawauchi

n-kawauchi

Ubuntu24.04環境で動作OKを確認できました。確認内容は以下の通りです。

１）logger.plugins の確認

HOME下にRTCと対象confファイルをコピーして確認

rtc.fluentbit_stream.confを下記とする

logger.plugins: ${RTM_LIB}/logger/FluentBit.so

環境変数を指定してRTC実行

$ export RTM_LIB=/usr/lib/x86_64-linux-gnu/openrtm-2.1
$ export LD_PRELOAD=/usr/lib/fluent-bit/libfluent-bit.so
$ ./ConsoleOutComp -f rtc.fluentbit_stream.conf

この時のRTCログで、FluentBit.soのフルパスは問題なく展開されている

Oct 14 06:53:02.991 DEBUG: ModuleManager: Finding function symbol: FluentBitInit in /usr/lib/x86_64-linux-gnu/openrtm-2.1/logger/FluentBit.so
Oct 14 06:53:02.999 INFO: manager: Logstream fluentd created.
Oct 14 06:53:03.009 INFO: manager: Logstream fluentd added.

２）manager.modules.load_path
- マスターマネージャーからC++のスレーブマネージャー経由でRTCを起動する動作で確認
- rtc.confを次のように指定
```
manager.modules.load_path: ${RTM_ROOT}/c++/examples/rtc/,${RTM_ROOT}/python3/SimpleIO/,${RTM_ROOT}/java/RTMExamples/SimpleIO/
```
- 以下を実行し、RTSEのManagerのプロパティでのLoadableModulesのコンポーネントリストを確認
```
$ export RTM_ROOT=/usr/share/openrtm-2.1/components
$ rtcd2 -d -f rtc.conf
```
３）manager.modules. [lang] .load_paths
- マスターマネージャーからC++のスレーブマネージャー経由でRTCを起動する動作で確認
- rtc.confを次のように指定し、２）と同様に rtcd2 -d -f rtc.conf を実行
```
manager.modules.load_path:
manager.modules.C++.load_paths: ${RTM_ROOT}/c++/examples/rtc/
manager.modules.Python.load_paths: ${RTM_ROOT}/python3/SimpleIO/
manager.modules.Java.load_paths: ${RTM_ROOT}/java/RTMExamples/SimpleIO/
```

４）manager.preload.modules

HTTP通信で使用する /usr/etc/http/rtc.http.conf をコピーして次のように修正して確認
```
manager.modules.load_path:
manager.preload.modules: ${RTM_LIB}/http/HTTPTransport.so
```

以下を実行

$ /usr/bin/openrtmNames -f /usr/etc/rtc.names.http.conf
$ export RTM_LIB=/usr/lib/x86_64-linux-gnu/openrtm-2.1
$ ./ConsoleOutComp -f rtc.http.conf

rtlsでRTC起動を確認
rtls実行に必要な環境変数を定義しているrtls_export.shを読み込んでからrtlsを実行
```
$ source rtls_export.sh
$ rtls /http://localhost:2809/call#`hostname`.host_cxt
ConsoleOut0.rtc
```

[compat] replace environment value in config file.

7324501

Nobu19800 added the enhancement New feature or request label Jan 19, 2022

Nobu19800 requested a review from n-ando January 19, 2022 09:04

Nobu19800 self-assigned this Jan 19, 2022

Nobu19800 mentioned this pull request Jan 19, 2022

ロードするモジュールのパスに環境変数を設定可能にする OpenRTM/OpenRTM-aist-Python#256

Merged

3 tasks

n-ando previously approved these changes Jan 24, 2022

View reviewed changes

Merge branch 'bugs/modulemanagerlang' into feature/config_replace_env

97cc4a7

Nobu19800 dismissed n-ando’s stale review via 97cc4a7 March 23, 2022 11:20

Merge branch 'master' into feature/config_replace_env

89703e0

n-kawauchi marked this pull request as ready for review August 30, 2024 09:02

n-kawauchi reviewed Aug 30, 2024

View reviewed changes

Merge branch 'master' into feature/config_replace_env

360a9a7

Nobu19800 added 2 commits September 25, 2025 18:33

[compat] Fixing logger.plugins settings

5296954

Merge branch 'master' into feature/config_replace_env

0eacf67

[compat] fixed bugs.

eea54b7

Update Manager.cpp

0fa9a06

n-kawauchi approved these changes Oct 14, 2025

View reviewed changes

n-ando approved these changes Oct 20, 2025

View reviewed changes

n-ando merged commit bee6e52 into OpenRTM:master Oct 20, 2025
3 of 8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ロードするモジュールのパスに環境変数を設定可能にする #1010

ロードするモジュールのパスに環境変数を設定可能にする #1010

Uh oh!

Nobu19800 commented Jan 19, 2022

Uh oh!

n-kawauchi left a comment

Uh oh!

n-kawauchi commented Sep 12, 2025

Uh oh!

n-kawauchi commented Sep 24, 2025

Uh oh!

Nobu19800 commented Sep 25, 2025

Uh oh!

n-kawauchi commented Sep 29, 2025

Uh oh!

Nobu19800 commented Sep 29, 2025

Uh oh!

n-kawauchi commented Oct 10, 2025

Uh oh!

Nobu19800 commented Oct 14, 2025

Uh oh!

n-kawauchi left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ロードするモジュールのパスに環境変数を設定可能にする #1010

ロードするモジュールのパスに環境変数を設定可能にする #1010

Uh oh!

Conversation

Nobu19800 commented Jan 19, 2022

Identify the Bug

Description of the Change

Verification

Uh oh!

n-kawauchi left a comment

Choose a reason for hiding this comment

Uh oh!

n-kawauchi commented Sep 12, 2025

Uh oh!

n-kawauchi commented Sep 24, 2025

Uh oh!

Nobu19800 commented Sep 25, 2025

Uh oh!

n-kawauchi commented Sep 29, 2025

Uh oh!

Nobu19800 commented Sep 29, 2025

Uh oh!

n-kawauchi commented Oct 10, 2025

Uh oh!

Nobu19800 commented Oct 14, 2025

Uh oh!

n-kawauchi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants