Arduino – ESP32 の関数の参照渡し、ポインタ渡し、String渡しについて考えてみた

Arduino の String 型もクラスなので、関数の引数にする場合は参照渡しにすべし

Arduino でとっても良く使う String 型があります。
これは C++ のクラスです。
これ、熟練者の方々には当たり前のことだと思いますが、私はつい最近まで気が付かずに、関数の引数を渡していました。

自分でライブラリのクラスを作成していて、それを引数にして関数に渡す場合には、メモリを意識して「参照渡し」にしているのに、なぜか String 型は全くスルーしていて、普通の変数のように「値渡し」にして、コピーコンストラクタを作成してしまっていました。
メモリの無駄遣いですね。

既に公開してしまったライブラリは、今更変更できないでこのまま残しておきます。
今後公開するライブラリは意識して直していこうと思っています。

String 変数は、Arduino コーディングの場合、char 型文字列よりも手軽でとっても便利なので、よく使います。
char 型のように事前に配列の要素数を決めなくて良く、好きな長さの文字列を格納することができますし。
私の様なアマチュアにとって、電子工作や自作 IoT には欠かせません。
Arduino IDE 用の String クラスの詳しい使い方は、私もよく利用させて頂いている以下のサイトに詳しく書いてあります。

Arduino 日本語リファレンス

では、先に述べたように、String クラスの「値渡し」と「参照渡し」とで、メモリの使われ方に違いがあるかを比較してみたいと思います。
まず、以下のような簡単なコードを例とします。

【ソースコード】 (※無保証　※PCの場合、ダブルクリックすればコード全体を選択できます)

void setup() {
  Serial.begin(115200);
  Serial.println();

  String str1, str2;
  str1 = "abcdefghijklmnopqrstuvwxyz";
  str2 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

  printTestData( str1, str2 );
}

void loop() {
  String str1, str2;
  str1 = "abcdefghijklmnopqrstuvwxyz";
  str2 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

  printTestData( str1, str2 );
  delay(20000);
}

void printTestData( String &s1, String &s2 ) {
  Serial.println( s1 );
  Serial.println( s2 );
}

まずは、String クラスを「値渡し」にした場合、要所要所にヒープメモリの空きサイズをシリアルモニタに出力させるスケッチは以下のようになります。

【ソースコード】 (※無保証　※PCの場合、ダブルクリックすればコード全体を選択できます)

void setup() {
  Serial.begin(115200);
  Serial.println();
  Serial.print( "Free Heap Size(setup0) = " );
  Serial.println( esp_get_free_heap_size() );

  String str1, str2;

  Serial.print( "Free Heap Size(setup1) = " );
  Serial.println( esp_get_free_heap_size() );

  str1 = "abcdefghijklmnopqrstuvwxyz";
  str2 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

  Serial.print( "Free Heap Size(setup2) = " );
  Serial.println( esp_get_free_heap_size() );

  printTestData( str1, str2 ); //値渡し

  Serial.print( "Free Heap Size(setup3) = " );
  Serial.println( esp_get_free_heap_size() );
}

void loop() {
  Serial.println( "---------------------" );
  Serial.print( "Free Heap Size(main loop0) = " );
  Serial.println( esp_get_free_heap_size() );

  String str1, str2;

  Serial.print( "Free Heap Size(main loop1) = " );
  Serial.println( esp_get_free_heap_size() );

  str1 = "abcdefghijklmnopqrstuvwxyz";
  str2 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

  Serial.print( "Free Heap Size(main loop2) = " );
  Serial.println( esp_get_free_heap_size() );

  printTestData( str1, str2 ); //値渡し

  Serial.print( "Free Heap Size(main loop3) = " );
  Serial.println( esp_get_free_heap_size() );
  delay(20000);
}

void printTestData( String s1, String s2 ) { //値渡し
  Serial.print( "Free Heap Size(Function) = " );
  Serial.println( esp_get_free_heap_size() );

  Serial.println( s1 );
  Serial.println( s2 );
}

実行結果

どうですか？
先に Test クラスを作成したスケッチと同じ結果になり、メモリの減り方も全く同じ結果になりました。
要するに関数の引数で String 型で渡す時、「値渡し」はメモリを無駄に消費しています。

では、今度は「参照渡し」を見てみたいと思います。

【ソースコード】 (※無保証　※PCの場合、ダブルクリックすればコード全体を選択できます)

void setup() {
  Serial.begin(115200);
  Serial.println();
  Serial.print( "Free Heap Size(setup0) = " );
  Serial.println( esp_get_free_heap_size() );

  String str1, str2;

  Serial.print( "Free Heap Size(setup1) = " );
  Serial.println( esp_get_free_heap_size() );

  str1 = "abcdefghijklmnopqrstuvwxyz";
  str2 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

  Serial.print( "Free Heap Size(setup2) = " );
  Serial.println( esp_get_free_heap_size() );

  printTestData( str1, str2 ); //参照渡し

  Serial.print( "Free Heap Size(setup3) = " );
  Serial.println( esp_get_free_heap_size() );
}

void loop() {
  Serial.println( "---------------------" );
  Serial.print( "Free Heap Size(main loop0) = " );
  Serial.println( esp_get_free_heap_size() );

  String str1, str2;

  Serial.print( "Free Heap Size(main loop1) = " );
  Serial.println( esp_get_free_heap_size() );

  str1 = "abcdefghijklmnopqrstuvwxyz";
  str2 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

  Serial.print( "Free Heap Size(main loop2) = " );
  Serial.println( esp_get_free_heap_size() );

  printTestData( str1, str2 ); //参照渡し

  Serial.print( "Free Heap Size(main loop3) = " );
  Serial.println( esp_get_free_heap_size() );
  delay(20000);
}

void printTestData( String &s1, String &s2 ) { //参照渡し
  Serial.print( "Free Heap Size(Function) = " );
  Serial.println( esp_get_free_heap_size() );

  Serial.println( s1 );
  Serial.println( s2 );
}

実行結果

初回のメモリサイズはちょっと不思議な数値ですが、２回目以降は printTestData関数に入る前と入った後でヒープメモリサイズは変わりありません。
以上から、私の結論として

関数の String 型引数は「参照渡し」にすべし！
そして、Arduino ライブラリの関数の場合には const を外しても良い！

ということです。
（あくまで個人的推測）

ただし、以下のように、関数に文字列を直に渡したい場合、

printTestData( “hello”, “world” );

これは「参照渡し」ではエラーになりますのでご注意ください。
こういう用途でも使いたいならば、「値渡し」しかありません。
Arduino 関数ではよく見かけますが・・・。

まとめ

いろいろごたごたと書きましたが、私なりに解釈したことをまとめるとこんな感じです。

● 関数に沢山の引数がある場合は、構造体やクラスにするとメチャ便利。

● 関数の引数に構造体やクラスを使う場合は、メモリ節約のために「参照渡し」か「ポインタ渡し」にすべし。

● Arduino コーディングの場合には「ポインタ渡し」は極力避け、「参照渡し」にする。

● 「参照渡し」の場合、一般的には const を付けるが、Arduino コーディングの場合は const を外しても良い。

頭では分かっているのですが、こうやってブログ記事にするとメチャメチャ長くなってしまいました。
逆に自分自身が勉強になりますね。

実は、コメント投稿欄でご意見いただき、以上の私の推測は必ずしもそうとは限らないということを教えて頂きました。
やっぱり独学だと推測の域を出ないので、改めてこういうご意見をいただくと、とても勉強になります。
叩かれるのを恐れて記事を書かないよりも、いろいろ叩かれてもこういう記事を発信することは、意味のあることだなと思いました。

ということで、自分自身のライブラリをこれから見直していきたいと思います。
私は基本的に素人なので、間違えているかもしれません。
何かお気づきの点がありましたら、コメント投稿等でご連絡いただけると助かります。

ということで、今回はここまでです。

では、皆さまにとっても自分にとっても良い年でありますように・・・。