[project-vvm-async-api] output_系引数がunalignedであることを許す
#534
Conversation
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
qryxip
commented
Jul 1, 2023
There was a problem hiding this comment.
APIとしてのドキュメントの変更についてはすべて #532 に回すことにします(現段階ではそもそもsafetyについて正しいことが書かれていないため)。
Hiroshiba
approved these changes
Jul 1, 2023
qryxip
added a commit
to qryxip/voicevox_core
that referenced
this pull request
Jul 1, 2023
Hiroshiba
pushed a commit
that referenced
this pull request
Jul 2, 2023
qryxip
added a commit
to qryxip/voicevox_core
that referenced
this pull request
Jul 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
内容
C APIにおける
output_系のポインタがunalignedであることを許可します。Rustの参照 (reference)は有効 (valid)であると同時にアラインメントに沿って (aligned)いなければなりません。そうでなければRustにおける未定義動作 (undefined behavior)となります。そのためC側から渡される生ポインタ (raw pointer)を参照として解釈するときは、アラインメントにも注意する必要があります。
Cの
const VoicevoxSynthesizer*を&VoicevoxSynthesizerとして、VoicevoxSynthesizer*をBox<VoicevoxSynthesizer>として解釈するのにはアラインメント的な問題はありません。何故ならVoicevoxSynthesizerを作れるのはVOICEVOX COREだけであり、ユーザーはVoicevoxSynthesizerの実体に触れないようになっているため、「有効なVoicevoxSynthesizerのポインタ」がRustの世界で生まれたalignedなものであると言えるからです。またconst char*を&CStrとして読むときもアラインメントを気にする必要はありません。c_charは1バイトだからです。しかしオブジェクトを"new"したり"create"したりする先の
T**/*mut *mut Tは別です。ドキュメントを通じてユーザーにお願いしない限り、(T*)*としてのアラインメントに沿わない (unaligned)ポインタが渡ってくる可能性があります。このPRではC APIの
output_系の引数をalignedだと仮定せず、&mutを経由しないように注意して<*mut T>::write_unalignedで"new"/"create"対象を書き込むようにします。最初「unalignedなポインタをよこすな」というドキュメントを書けばいいと思っていたのですが、実際に #532 で書こうとしたら我々とユーザーの両方に面倒を生じさせることに気づいてしまいました。アラインメントを気にする必要があるのは
output_系の引数だけなので、write_unalignedする方が良いと思いました。関連 Issue
その他