change: VoiceModel → VoiceModelFile (#832)

現在の`VoiceModel`は、コンストラクトされるときに`id`, `manifest`,
`metas`の情報だけ取得してそれらと`path`だけ保持し、モデル本体は要求され
てから`path`を開いて読むという形になっている。このような責務になっている
ことをユーザーが今のAPIのシグネチャから察するのは困難である。このことか
ら、次の変更を行う。

1. `VoiceModel` → `VoiceModelFile`にリネーム
    * C APIの`voicevox_voice_model_…`は`voicevox_voice_model_file_…`に
2. `VoiceModel::from_path` → `VoiceModelFile::open`にリネーム
    * C APIも同様
3. Python APIには`__{,a}{enter,exit}__`、Java APIには`Closable`の実装
    * `id`と`metas`はクローズ後にもgetできるようにする
    * Rust APIの`blocking`のものを除き、`.close()`で閉じられるように
    * C APIの`delete`は`close`にリネーム

Python APIとJava APIで`Synthesizer::load_voice_model`中に
`VoiceModelFile::close`を行うときの挙動としては、`load_voice_model`がす
べて終わるのを待ってからクローズ処理を行う。実装には`RwLock`を用いる。
```py
    async with await VoiceModelFile.open(vvm_path) as model:
        _ = synthesizer.load_voice_model(model) # awaitしない
```
```console
[WARNING] voicevox_core_python_api: The `VoiceModelFile` is still in use. Waiting before closing
[DEBUG] voicevox_core_python_api: Closing a VoiceModelFile
# `load_voice_model`が無事完了している
```

ただしC APIでは`load_voice_model`中の`close`は現行のままUBとする。
`RwLock`でロックすることで安全なAPIにすることはfuture workとする。

実装の都合上、Python APIの`voicevox_core.asyncio.Synthesizer`も
`__{enter,exit}__`ではなく`__a{enter,exit}__`を持つようして、
`VoiceModelFile`同様に`RwLock`でロック管理を行うようにする。

Resolves #829.

Cargo.toml

@@ -9,6 +9,7 @@ anstyle-query = "1.0.0"
 anyhow = "1.0.65"
 assert_cmd = "2.0.8"
 async-fs = "2.1.2"
+async-lock = "3.4.0"
 async_zip = "=0.0.16"
 bindgen = "0.69.4"
 binstall-tar = "0.4.39"

crates/voicevox_core/Cargo.toml

@@ -16,7 +16,8 @@ link-onnxruntime = []
 
 [dependencies]
 anyhow.workspace = true
-async-fs.workspace = true
+async-fs.workspace = true # 今これを使っている箇所はどこにも無いが、`UserDict`にはこれを使った方がよいはず
+async-lock.workspace = true
 async_zip = { workspace = true, features = ["deflate"] }
 blocking.workspace = true
 camino.workspace = true

crates/voicevox_core/src/__internal/doctest_fixtures.rs

@@ -26,7 +26,7 @@ pub async fn synthesizer_with_sample_voice_model(
         },
     )?;
 
-    let model = &crate::nonblocking::VoiceModel::from_path(voice_model_path).await?;
+    let model = &crate::nonblocking::VoiceModelFile::open(voice_model_path).await?;
     syntesizer.load_voice_model(model).await?;
 
     Ok(syntesizer)

crates/voicevox_core/src/__internal/interop.rs

@@ -1,3 +1,5 @@
+pub mod raii;
+
 pub use crate::{
     metas::merge as merge_metas, synthesizer::blocking::PerformInference,
     voice_model::blocking::IdRef,

crates/voicevox_core/src/__internal/interop/raii.rs

@@ -0,0 +1,43 @@
+use std::{marker::PhantomData, ops::Deref};
+
+use ouroboros::self_referencing;
+
+pub enum MaybeClosed<T> {
+    Open(T),
+    Closed,
+}
+
+// [`mapped_lock_guards`]のようなことをやるためのユーティリティ。
+//
+// [`mapped_lock_guards`]: https://github.com/rust-lang/rust/issues/117108
+pub fn try_map_guard<'lock, G, F, T, E>(guard: G, f: F) -> Result<impl Deref<Target = T> + 'lock, E>
+where
+    G: 'lock,
+    F: FnOnce(&G) -> Result<&T, E>,
+    T: 'lock,
+{
+    return MappedLockTryBuilder {
+        guard,
+        target_builder: f,
+        marker: PhantomData,
+    }
+    .try_build();
+
+    #[self_referencing]
+    struct MappedLock<'lock, G: 'lock, T> {
+        guard: G,
+
+        #[borrows(guard)]
+        target: &'this T,
+
+        marker: PhantomData<&'lock T>,
+    }
+
+    impl<'lock, G: 'lock, T: 'lock> Deref for MappedLock<'lock, G, T> {
+        type Target = T;
+
+        fn deref(&self) -> &Self::Target {
+            self.borrow_target()
+        }
+    }
+}

crates/voicevox_core/src/asyncs.rs

@@ -15,15 +15,29 @@
 
 use std::{
     io::{self, Read as _, Seek as _, SeekFrom},
+    ops::DerefMut,
     path::Path,
     pin::Pin,
     task::{self, Poll},
 };
 
+use blocking::Unblock;
 use futures_io::{AsyncRead, AsyncSeek};
+use futures_util::ready;
 
 pub(crate) trait Async: 'static {
-    async fn open_file(path: impl AsRef<Path>) -> io::Result<impl AsyncRead + AsyncSeek + Unpin>;
+    type Mutex<T: Send + Sync + Unpin>: Mutex<T>;
+    type RoFile: AsyncRead + AsyncSeek + Send + Sync + Unpin;
+
+    /// ファイルを読み取り専用(RO)で開く。
+    ///
+    /// `io::Error`は素（`i32`相当）のままにしておき、この関数を呼び出す側でfs-err風のメッセージを付
+    /// ける。
+    async fn open_file_ro(path: impl AsRef<Path>) -> io::Result<Self::RoFile>;
+}
+
+pub(crate) trait Mutex<T>: From<T> + Send + Sync + Unpin {
+    async fn lock(&self) -> impl DerefMut<Target = T>;
 }
 
 /// エグゼキュータが非同期タスクの並行実行をしないことを仮定する、[`Async`]の実装。
@@ -39,30 +53,47 @@ pub(crate) trait Async: 'static {
 pub(crate) enum SingleTasked {}
 
 impl Async for SingleTasked {
-    async fn open_file(path: impl AsRef<Path>) -> io::Result<impl AsyncRead + AsyncSeek + Unpin> {
-        return std::fs::File::open(path).map(BlockingFile);
-
-        struct BlockingFile(std::fs::File);
-
-        impl AsyncRead for BlockingFile {
-            fn poll_read(
-                mut self: Pin<&mut Self>,
-                _: &mut task::Context<'_>,
-                buf: &mut [u8],
-            ) -> Poll<io::Result<usize>> {
-                Poll::Ready(self.0.read(buf))
-            }
-        }
+    type Mutex<T: Send + Sync + Unpin> = StdMutex<T>;
+    type RoFile = StdFile;
 
-        impl AsyncSeek for BlockingFile {
-            fn poll_seek(
-                mut self: Pin<&mut Self>,
-                _: &mut task::Context<'_>,
-                pos: SeekFrom,
-            ) -> Poll<io::Result<u64>> {
-                Poll::Ready(self.0.seek(pos))
-            }
-        }
+    async fn open_file_ro(path: impl AsRef<Path>) -> io::Result<Self::RoFile> {
+        std::fs::File::open(path).map(StdFile)
+    }
+}
+
+pub(crate) struct StdMutex<T>(std::sync::Mutex<T>);
+
+impl<T> From<T> for StdMutex<T> {
+    fn from(inner: T) -> Self {
+        Self(inner.into())
+    }
+}
+
+impl<T: Send + Sync + Unpin> Mutex<T> for StdMutex<T> {
+    async fn lock(&self) -> impl DerefMut<Target = T> {
+        self.0.lock().unwrap_or_else(|e| panic!("{e}"))
+    }
+}
+
+pub(crate) struct StdFile(std::fs::File);
+
+impl AsyncRead for StdFile {
+    fn poll_read(
+        mut self: Pin<&mut Self>,
+        _: &mut task::Context<'_>,
+        buf: &mut [u8],
+    ) -> Poll<io::Result<usize>> {
+        Poll::Ready(self.0.read(buf))
+    }
+}
+
+impl AsyncSeek for StdFile {
+    fn poll_seek(
+        mut self: Pin<&mut Self>,
+        _: &mut task::Context<'_>,
+        pos: SeekFrom,
+    ) -> Poll<io::Result<u64>> {
+        Poll::Ready(self.0.seek(pos))
     }
 }
 
@@ -74,7 +105,76 @@ impl Async for SingleTasked {
 pub(crate) enum BlockingThreadPool {}
 
 impl Async for BlockingThreadPool {
-    async fn open_file(path: impl AsRef<Path>) -> io::Result<impl AsyncRead + AsyncSeek + Unpin> {
-        async_fs::File::open(path).await
+    type Mutex<T: Send + Sync + Unpin> = async_lock::Mutex<T>;
+    type RoFile = AsyncRoFile;
+
+    async fn open_file_ro(path: impl AsRef<Path>) -> io::Result<Self::RoFile> {
+        AsyncRoFile::open(path).await
+    }
+}
+
+impl<T: Send + Sync + Unpin> Mutex<T> for async_lock::Mutex<T> {
+    async fn lock(&self) -> impl DerefMut<Target = T> {
+        self.lock().await
+    }
+}
+
+// TODO: `async_fs::File::into_std_file`みたいなのがあればこんなの↓は作らなくていいはず。PR出す？
+pub(crate) struct AsyncRoFile {
+    // `poll_read`と`poll_seek`しかしない
+    unblock: Unblock<std::fs::File>,
+
+    // async-fsの実装がやっているように「正しい」シーク位置を保持する。ただしファイルはパイプではな
+    // いことがわかっているため smol-rs/async-fs#4 は考えない
+    real_seek_pos: Option<u64>,
+}
+
+impl AsyncRoFile {
+    async fn open(path: impl AsRef<Path>) -> io::Result<Self> {
+        let path = path.as_ref().to_owned();
+        let unblock = Unblock::new(blocking::unblock(|| std::fs::File::open(path)).await?);
+        Ok(Self {
+            unblock,
+            real_seek_pos: None,
+        })
+    }
+
+    pub(crate) async fn close(self) {
+        let file = self.unblock.into_inner().await;
+        blocking::unblock(|| drop(file)).await;
+    }
+}
+
+impl AsyncRead for AsyncRoFile {
+    fn poll_read(
+        mut self: Pin<&mut Self>,
+        cx: &mut task::Context<'_>,
+        buf: &mut [u8],
+    ) -> Poll<io::Result<usize>> {
+        if self.real_seek_pos.is_none() {
+            self.real_seek_pos = Some(ready!(
+                Pin::new(&mut self.unblock).poll_seek(cx, SeekFrom::Current(0))
+            )?);
+        }
+        let n = ready!(Pin::new(&mut self.unblock).poll_read(cx, buf))?;
+        *self.real_seek_pos.as_mut().expect("should be present") += n as u64;
+        Poll::Ready(Ok(n))
+    }
+}
+
+impl AsyncSeek for AsyncRoFile {
+    fn poll_seek(
+        mut self: Pin<&mut Self>,
+        cx: &mut task::Context<'_>,
+        pos: SeekFrom,
+    ) -> Poll<io::Result<u64>> {
+        // async-fsの実装がやっているような"reposition"を行う。
+        // https://github.com/smol-rs/async-fs/issues/2#issuecomment-675595170
+        if let Some(real_seek_pos) = self.real_seek_pos {
+            ready!(Pin::new(&mut self.unblock).poll_seek(cx, SeekFrom::Start(real_seek_pos)))?;
+        }
+        self.real_seek_pos = None;
+
+        Pin::new(&mut self.unblock).poll_seek(cx, pos)
     }
 }

crates/voicevox_core/src/blocking.rs

@@ -3,7 +3,7 @@
 pub use crate::{
     engine::open_jtalk::blocking::OpenJtalk, infer::runtimes::onnxruntime::blocking::Onnxruntime,
     synthesizer::blocking::Synthesizer, user_dict::dict::blocking::UserDict,
-    voice_model::blocking::VoiceModel,
+    voice_model::blocking::VoiceModelFile,
 };
 
 pub mod onnxruntime {

crates/voicevox_core/src/engine/open_jtalk.rs

@@ -1,4 +1,4 @@
-// TODO: `VoiceModel`のように、次のような設計にする。
+// TODO: `VoiceModelFile`のように、次のような設計にする。
 //
 // ```
 // pub(crate) mod blocking {

crates/voicevox_core/src/infer/runtimes/onnxruntime.rs

@@ -1,4 +1,4 @@
-// TODO: `VoiceModel`のように、次のような設計にする。
+// TODO: `VoiceModelFile`のように、次のような設計にする。
 //
 // ```
 // pub(crate) mod blocking {

crates/voicevox_core/src/nonblocking.rs

@@ -15,7 +15,7 @@
 pub use crate::{
     engine::open_jtalk::nonblocking::OpenJtalk,
     infer::runtimes::onnxruntime::nonblocking::Onnxruntime, synthesizer::nonblocking::Synthesizer,
-    user_dict::dict::nonblocking::UserDict, voice_model::nonblocking::VoiceModel,
+    user_dict::dict::nonblocking::UserDict, voice_model::nonblocking::VoiceModelFile,
 };
 
 pub mod onnxruntime {

crates/voicevox_core/src/status.rs

@@ -408,7 +408,7 @@ mod tests {
                 talk: enum_map!(_ => InferenceSessionOptions::new(0, DeviceSpec::Cpu)),
             },
         );
-        let model = &crate::nonblocking::VoiceModel::sample().await.unwrap();
+        let model = &crate::nonblocking::VoiceModelFile::sample().await.unwrap();
         let model_contents = &model.read_inference_models().await.unwrap();
         let result = status.insert_model(model.header(), model_contents);
         assert_debug_fmt_eq!(Ok(()), result);
@@ -424,7 +424,7 @@ mod tests {
                 talk: enum_map!(_ => InferenceSessionOptions::new(0, DeviceSpec::Cpu)),
             },
         );
-        let vvm = &crate::nonblocking::VoiceModel::sample().await.unwrap();
+        let vvm = &crate::nonblocking::VoiceModelFile::sample().await.unwrap();
         let model_header = vvm.header();
         let model_contents = &vvm.read_inference_models().await.unwrap();
         assert!(