C++のenable_shared_from_thisを使う

2019/04/16
このエントリーをはてなブックマークに追加

はじめに

カブクの甘いもの担当の高橋憲一です。
相変わらず日々甘いものを食しながらC++でZ軸を触るコードを書いています。最近のお気に入りはローソンの「あんこ天国」という名前のあんぱんです。中のあんこが透けて見えるほど薄い生地にたっぷりのあんこが包まれていて満足度が高く、食べるとコーディングが捗ります 🙂

スマートポインタを使っていて遭遇した問題

C++プログラマにとってstd::shared_ptrやstd::unique_ptrなどのスマートポインタを使うことは、もはや疑う余地のないことではありますが、こんな場面に遭遇したことはありませんでしょうか。

std::make_shared<Foo>()でstd::shared_ptrとして生成したあと、そのFooのクラスの中で自分自身(this)をどこかのコンテナに入れたい。

そんな状況を作り出した自分のコード設計が悪いのかと最初は考えあぐねていたのですが、幸い世の中に同じ状況に遭遇する人は多いようで、それを解決してくれるものがC++11以降では標準で用意されていました。

std::shared_ptrの意図しない領域解放

std::shared_ptrはリファレンスカウントにより、そのポインタが指し示すメモリ領域を管理してリファレンスカウントが0になった際にその領域を解放してくれます。

auto foo = std::make_shared<Foo>();

とすることで、オブジェクトのインスタンスをヒープ領域に生成し、参照するポインタをstd::shared_ptrの管理下におくことができます。

auto hoge = foo;
というように、他のstd::shared_ptr<Foo>型の変数に代入して複数箇所で使用し、hoge、fooのどちらもスコープから外れた際にリファレンスカウントが0になり、指し示す領域は解放されます。

ここまでで、Fooのクラスの外で使う分においては何も困ったことは起こらないはずです。
しかし、Fooのクラスのメソッド内でthisを外部と絡む処理で使いたい場合、例えばstd::vector<std::shared_ptr<Foo>>というコンテナに入れたいというような場合にどうすれば良いのでしょうか。
ここでもし、

auto p = std::shared_ptr<Foo>(this);

というように、単純にthisを新たにstd::shared_ptrで包んで、同じポインタを異なるstd::shared_ptrで管理するとどのようなことが起きるか…想像するだけで恐ろしいです。

具体的には複数のstd::shared_ptrで同じメモリ領域を管理してしまうことになります。すなわち、1つ目のstd::shared_ptrではリファレンスカウントが0より大きいのにもかかわらず、2つ目のstd::shared_ptrのリファレンスカウントが0になった際に、その領域が解放されてしまうということが起こります。ここで1つ目のstd::shared_ptrはまだ領域が有効だという認識ですので、その領域への参照が発生した際に、解放済み領域へのアクセスという不正な処理が発生します。

もちろん、一度std::shared_ptrに委ねた領域のポインタを生で管理する(std::vector<Foo *>というコンテナを用意してthisを入れる)ようなことも避けるべきです。そんなことをしたらコンテナの預かり知らないところでstd::shared_ptrのリファレンスカウントが0になって領域が開放され、このコンテナの要素が指し示す先を参照した際にやはり解放済み領域への不正アクセスが発生します。

解決策 std::enable_shared_from_this

まず、std::enabled_shared_from_this<Foo>というように、そのクラス自身をテンプレート引数として指定したクラスをpublic継承します。

class Foo : public std::enable_shared_from_this<Foo> {
    //
};

実際にstd::shared_ptr管理下のthisが必要な場所で、例えば

auto p = shared_from_this();

というようにします。これで二重管理することなくFooのクラスの中でstd::shared_ptr配下のthisを得ることができます。

実際に動作するコードです。
macOS Mojave (version 10.14.4) + clang (Apple LLVM version 10.0.1) の環境と、Ubuntu 16.04.1 LTS + gcc (version 5.4.0) の環境で確認しました。

g++ -std=c++17 sharedPtrTest.c++ というようにしてコンパイル、リンクします。

実行例:

radius=0.9
radius=0.1
a.use_count=1
b.use_count=2
c.use_count=2

3つのCircleオブジェクトが作成され、そのうちsmall cirlceとして判定された半径が1.0より小さなものが2件(bとc)出力されています。つづく3行ではa, b, cそれぞれのリファレンスカウントが出力されます。bとcはstd::vectorのコンテナに格納されていますので、その分リファレンスカウントが1つ増えて2になっています。これは10行目のshared_from_this()により返されたものが別のstd::shared_ptrを作成するのではなく、最初に作成されたstd::shared_ptrに結び付けられているということを示しています。

std::enable_shared_from_thisを使用する例がEffective Modern C++の4章に載っているのは安心材料の一つです。”The line creating 〜 is a stylistic abomination. (〜を作成する行は見た目も醜悪です。)といったような言い回しが出てくる書籍ですので、もし良くない用法だとしたらバッサリ切り捨てられているはずです。

さいごに

カブクでは実行時に高いパフォーマンスが必要とされる3DメッシュデータやCADデータを扱う処理をC++で実装しています。C++によるプログラミングの腕に覚えがあり、3Dデータを扱う処理に興味があるという方はぜひ kenichi.takahashi@kabuku.co.jp までご連絡ください。

追記(2019年4月19日)

まだ私がC++プログラマとして駆け出しだった頃(19961998年くらい)の師匠から「ブログ記事を興味深く読ませてもらいました」と連絡をいただきました。師からの久しぶりの便りに喜んだのも束の間、「一つ気になったのは、shared_from_this()を導入することで生のポインタ経由でCircleクラスを使うことを禁止しなくては危険なような気がすることです。shared_from_this()を呼ぶ前に、少なくとも1つのshared_ptrを構築済みでないといけないようですので。」という、全くもって的確なツッコミをもらい、この記事を書いたことで思いがけず師を前にする懐かしくもあり心地よい緊張感を味わうことになりました。

実はブログ記事用にサンプルコードを用意するにあたり少々手を抜いてしまいまして、本来ならコンストラクタはprivateとして宣言することでクラス利用者からは隠蔽し、ファクトリ関数を用意してクラスの利用者にはファクトリ関数経由でオブジェクトを生成するようにしてもらうようにするべきだったのです。

それに基づいて書き換えたコードは以下のようになります。これで生のポインタ経由でクラスを使うことを禁止することができます。

増えた行数は高々6サンプルコードは必要最小限にしたかったとはいえ、抑えるところはちゃんと抑えないといけないとあらためて思い直しました。まだまだ精進が必要なようです。

その他の記事

Other Articles

2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる

2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発(Python で API 編)

2019/04/08
WebGLでレイマーチングを使ったCSGを実現する

2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話

2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた

2019/03/27
任意のブラウザ上でJestで書いたテストを実行する

2019/02/08
TypeScript で “radian” と “degree” を間違えないようにする

2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法

2019/01/18
SIGGRAPH Asia 2018 参加レポート

2019/01/08
お正月だョ!ECMAScript Proposal全員集合!!

2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋

2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発(環境編)

2018/12/23
いまMLKitカスタムモデル(TF Lite)は使えるのか

2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する

2018/12/11
TypeScriptで実現する型安全な多言語対応(Angularを例に)

2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜

2018/12/02
single quotes な Black を vendoring して packaging

2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用

2018/11/04
Node Knockout 2018 に参戦しました

2018/10/24
SIGGRAPH 2018参加レポート-後編(VR/AR)

2018/10/11
Angular 4アプリケーションをAngular 6に移行する

2018/10/05
SIGGRAPH 2018参加レポート-特別編(VR@50)

2018/10/03
Three.jsでVRしたい

2018/10/02
SIGGRAPH 2018参加レポート-前編

2018/09/27
ズーム可能なSVGを実装する方法の解説

2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips

2018/09/21
競技プログラミングの勉強会を開催している話

2018/09/19
Ladder Netwoksによる半教師あり学習

2018/08/10
「Maker Faire Tokyo 2018」に出展しました

2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法

2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと

2018/07/19
【深層学習】時系列データに対する1次元畳み込み層の出力を可視化

2018/07/11
きたない requirements.txt から Pipenv への移行

2018/06/26
CSS Houdiniを味見する

2018/06/25
不確実性を考慮した時系列データ予測

2018/06/20
Google Colaboratory を自分のマシンで走らせる

2018/06/18
Go言語でWebAssembly

2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春

2018/06/08
2018 年の tree shaking

2018/06/07
隠れマルコフモデル 入門

2018/05/30
DASKによる探索的データ分析(EDA)

2018/05/10
TensorFlowをソースからビルドする方法とその効果

2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ

2018/04/23
技術書典4にサークル参加してきました

2018/04/13
Python で Cura をバッチ実行するためには

2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜

2018/04/02
深層学習を用いた時系列データにおける異常検知

2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案

2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る

2018/03/23
ngUpgrade を使って AngularJS から Angular に移行

2018/03/14
Three.jsのパフォーマンスTips

2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」

2018/01/17
時系列データにおける異常検知

2018/01/11
異常検知の基礎

2018/01/09
three.ar.jsを使ったスマホAR入門

2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方

2017/12/15
WebAssembly(wat)を手書きする

2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用

2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)

2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)

2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋

2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編

2017/10/13
第2回 魁!! GPUクラスタ on GKE ~PodからGPUを使う編~

2017/10/05
第1回 魁!! GPUクラスタ on GKE ~GPUクラスタ構築編~

2017/09/13
「Maker Faire Tokyo 2017」に出展しました。

2017/09/11
PyConJP2017に参加しました

2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発

2017/08/23
OpenAPIのご紹介

2017/08/18
EuroPython2017で2名登壇しました。

2017/07/26
3DプリンターでLチカ

2017/07/03
Three.js r86で何が変わったのか

2017/06/21
3次元データへの深層学習の適用

2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春

2017/05/08
Three.js r85で何が変わったのか

2017/04/10
GCPのGPUインスタンスでレンダリングを高速化

2017/02/07
Three.js r84で何が変わったのか

2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する

2016/12/21
Three.js r83で何が変わったのか

2016/12/02
Three.jsでのクリッピング平面の利用

2016/11/08
Three.js r82で何が変わったのか

2016/12/17
SIGGRAPH 2016 レポート

2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋

2016/10/28
PyConJP2016 行きました

2016/10/17
EuroPython2016で登壇しました

2016/10/13
Angular 2.0.0ファイナルへのアップグレード

2016/10/04
Three.js r81で何が変わったのか

2016/09/14
カブクのエンジニアインターンシッププログラムについての詩

2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜

2016/08/30
Three.js r80で何が変わったのか

2016/07/15
Three.js r79で何が変わったのか

2016/06/02
Vulkanを試してみた

2016/05/20
MakerGoの作り方

2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法

2016/04/27
Blenderの3DデータをMinecraftに送りこむ

2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査

→
←

関連職種

Recruit

バックエンドエンジニア(Python・Go)

業務内容

当ポジションは弊社Webサービスのバックエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

フロントエンドエンジニア(TypeScript)

業務内容

当ポジションは弊社Webサービスのフロントエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

機械学習エンジニア

業務内容

センサーデータの分析モデルの調査・研究・開発。 Kabuku Connectの製造データ(3D、2D)から情報を抽出するモデルの構築。 データの前処理や学習、ハイパーパラメータチューニング、獲得モデルの評価、プロダクションのデータパイプラインとの連携をお願いします。

インターン(Webエンジニア)

業務内容

業務から独立した、調査・研究系のタスクをおまかせしています。コードレビュー、 社内での報告会、 ブログ記事執筆を通して着実にスキルアップしていただくことを目指しています。 (希望があれば、プロダクトの開発業務もおまかせします。)

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く