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

[project-vvm-async-api] extern "C"の生ポインタをABI互換のに置き換え #514

Conversation

qryxip
Copy link
Member

@qryxip qryxip commented Jun 8, 2023

内容

extern "C" fnの宣言において、引数の型を次のように置き換えます。これによるC ABI上のシグネチャは変化しないはずであるので、.hは変化しません。

  1. &Tとして読む*const T&T
  2. &mut Tとして読む*mut T&mut T
  3. 書き込み専用の*mut T&mut MaybeUninit<T>
  4. Box<T>として扱う*mut TBox<T>

各公式ドキュメントを読めばこの置き換えをしていいことがわかりますし、cbindgenもそのように判断しています。
また1., 2., 3.についてはOSSでの実例もいくつも見つけることができます。4.だけ実例をあまり見つけることができないのですが、これはBox<impl Sized>のレイアウトが正式に保証されたのが Rust 1.41 (2020年)と比較的最近だからだと思われます(ただこのリンク先のコード例をもって正当性の根拠とすることができると思います)。

関連 Issue

#497

その他

mainブランチの方に向けようか迷ったのですが、Synthesizerとかへの適用が主になると思ったので、project-vvm-async-apiに向けることにしました。

このPRは現在 #512 に続く形で実装しています。

@qryxip qryxip changed the title [project-vvm-async-api] C APIの宣言で互換レイアウトの型を使う [project-vvm-async-api] C APIの宣言でABI互換の型を使う Jun 8, 2023
@qryxip qryxip changed the title [project-vvm-async-api] C APIの宣言でABI互換の型を使う [project-vvm-async-api] extern "C" fnの生ポインタをABI互換の型に置き換える Jun 9, 2023
@qryxip qryxip changed the title [project-vvm-async-api] extern "C" fnの生ポインタをABI互換の型に置き換える [project-vvm-async-api] extern "C"の生ポインタをABI互換のに置き換え Jun 9, 2023
@qryxip qryxip marked this pull request as ready for review June 9, 2023 06:33
@qryxip
Copy link
Member Author

qryxip commented Jun 9, 2023

あ、このPRの利点ですが一応:

  • 健全性(soundness)の向上
  • 読むときの認知負荷の軽減

を目的としています。

@qryxip
Copy link
Member Author

qryxip commented Jun 9, 2023

あ、*mut u8(wavファイルのやつ)とかもNonNull<u8>とかにしておいた方がいいかも。

@qryxip
Copy link
Member Author

qryxip commented Jun 9, 2023

↑ なしで。ユーザーに貸し出すべき配列が空だったらとか考えると利点の割に面倒になります。

@qryxip
Copy link
Member Author

qryxip commented Jun 9, 2023

なんかunsafeが10箇所不要になって外せました。

Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

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

LGTM!!

引数の型でMaybeUninit使うの面白いですね。
本当にやりたいのはwrite onlyな気がしますが。(そういうの無さそう)

@Hiroshiba
Copy link
Member

問題ないと思うのでマージします!!

@Hiroshiba Hiroshiba merged commit d193856 into VOICEVOX:project-vvm-async-api Jun 9, 2023
@qryxip qryxip mentioned this pull request Jun 10, 2023
67 tasks
@qryxip qryxip mentioned this pull request Jul 22, 2023
69 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants