Rustでdllを作ってほかのクレートから使ったら１回の呼び出しはうまくいくが２回呼び出すと正常に動作しない

Question

環境

• Windows 10
• Rust 1.50.0

生じている問題

RustでDLLを作ってそれをほかのクレートから呼び出そうとしました。DLLを作る側は

lib.rs

use std::os::raw::{c_int, c_short, c_uchar, c_uint};

#[no_mangle]
pub extern "C" fn TUSB0216AD_Device_Open(_id: c_short) -> c_short {
    return 0;
}

#[no_mangle]
pub extern "C" fn TUSB0216AD_Device_Close(_id: c_short) {}

#[no_mangle]
pub extern "C" fn TUSB0216AD_Start(
    _id: c_short,
    _ch: c_uchar,
    _pre_len: c_int,
    _trig_type: c_uchar,
    _trig_ch: c_uchar,
) -> c_short {
    return 0;
}

#[no_mangle]
pub extern "C" fn TUSB0216AD_Stop(_id: c_short) -> c_short {
    return 0;
}

#[no_mangle]
pub extern "C" fn TUSB0216AD_Ad_Data(
    _id: c_short,
    _ch: c_short,
    _data: *mut c_int,
    _datalen: *mut c_uint,
) -> c_short {
    unsafe {
        *_data = 10;
        *_datalen = 1;
    }

    return 0;
}

#[no_mangle]
pub extern "C" fn TUSB0216AD_AdClk_Set(_id: c_short, _clk_time: c_int, _sel: c_uchar) -> c_short {
    return 0;
}

#[no_mangle]
pub extern "C" fn TUSB0216AD_Input_Set(_id: c_short, _type1: c_uchar, _type2: c_uchar) -> c_short {
    return 0;
}

#[no_mangle]
pub extern "C" fn TUSB0216AD_Trigger(_id: c_short) -> c_short {
    return 0;
}

生ポインタを使っていたりするのは、このDLLがもともとある装置のCインターフェースをモックするという目的で作っているためです。

これを使っている側は

lib.rs

mod helper;

use std::sync::{Arc, Mutex};
use std::thread;

#[no_mangle]
pub extern "C" fn run(id: i32, seconds: u64) {
    // sequence が走っているかを示すフラグ
    // -1: not-started, 0: running, 1: finished
    let flag = Arc::new(Mutex::new(0));
    const DATA_SIZE: usize = 50000;

    let flg1 = Arc::clone(&flag);
    let time_keeper = thread::spawn(move || {
        helper::continuous_read(id, seconds, flg1);
    });

    let flg2 = Arc::clone(&flag);
    let mut x = vec![0.0 as f32; DATA_SIZE];
    let mut y = vec![0.0 as f32; DATA_SIZE];

    let job_runner = thread::spawn(move || {
        helper::get_data(id, flg2, &mut x, &mut y);
    });

    time_keeper.join().unwrap();
    job_runner.join().unwrap();
}

helper.rs

use std::sync::{Arc, Mutex};
use std::{thread, time};

#[link(name = "ad_mock.dll", kind = "dylib")]
#[allow(dead_code)]
extern "C" {
	pub fn TUSB0216AD_Device_Open(id: i32) -> i32;
	pub fn TUSB0216AD_Device_Close(id: i32);
	/// 連続測定を開始
	/// ch: 0 (1chのみ)、1(2chのみ)、2(1, 2ch同時)
	/// PreLen: プレトリガ長
	/// TrigType: トリガ種類、0: 内部トリガ、1: 外部デジタル、2: アナログ立ち上がり、3: アナログ立下り
	/// TrigCh: アナログトリガのトリガチャネル、0: ch1, 1: ch2
	pub fn TUSB0216AD_Start(id: i32, ch: &u8, PreLen: i32, TrigType: u8, TrgCh: u8) -> i32;
	/// 連続取り込み停止
	pub fn TUSB0216AD_Stop(id: i32) -> i32;
	/// 取り込み済みデータを取得
	/// data: 取り込みデータの格納先のポインタ
	/// datalen: 取り込み要求長。1~262144、戻るときには実際に取得された数が入っている
	pub fn TUSB0216AD_Ad_Data(id: i32, ch: u8, data: *mut i32, datalen: *mut u32) -> i32;
	/// クロック時間の設定
	/// ClkTime: 内部クロック周期設定、500 ~ 2147483647。クロック周期 = ClkTime * 20 ns
	/// sel: クロックソース、0: 内部クロック、1: 外部クロック
	pub fn TUSB0216AD_AdClk_Set(id: i32, ClkTime: i32, sel: u8) -> i32;
	/// ソフトウェアトリガを掛ける
	pub fn TUSB0216AD_Trigger(id: i32) -> i32;
}

pub fn continuous_read(id: i32, seconds: u64, flag: Arc<Mutex<i8>>) {
	println!("Timer start!");
	let sleeping_time = time::Duration::from_secs(seconds);

	unsafe {
		TUSB0216AD_Input_Set(id, 0, 0);
		TUSB0216AD_Start(id, &(2 as u8), 0, 0, 0);
		TUSB0216AD_Trigger(id);
	}

	*flag.lock().unwrap() = 0; // 計測開始のフラグを立てる
	thread::sleep(sleeping_time);

	unsafe {
		TUSB0216AD_Stop(id);
	}

	*flag.lock().unwrap() = 1; // 計測終了のフラグを立てる
	println!("Timer stopped");
}

/// CH1, CH2 からのデータを取得する
pub fn get_data(
	id: i32,
	flag: Arc<Mutex<i8>>,
	_position: &mut Vec<f32>,
	_intensity: &mut Vec<f32>,
) {
	const MAX_LENGTH: usize = 262142;
	let mut length = MAX_LENGTH as u32;

	println!("Data acquisition started");
	loop {
		if *flag.lock().unwrap() != -1 {
			break;
		}
		thread::sleep(time::Duration::from_millis(10));
	}

	let mut data1 = [0; MAX_LENGTH];
	let mut data2 = [0; MAX_LENGTH];
	let l_ptr = &mut length as *mut u32;

	loop {
		if *flag.lock().unwrap() == 1 {
			break;
		}

        // 問題の部分!!!!!!!!!!!!
		unsafe {
			TUSB0216AD_Ad_Data(id, 1, data1.as_mut_ptr(), l_ptr);
			TUSB0216AD_Ad_Data(id, 2, data2.as_mut_ptr(), l_ptr);
		}

		
	}
	println!("Data acquisition stopped");
}

lib.rs中の runを実行すると、

Timer start!
Data acquisition started
Timer stopped
Data acquisition stopped

という文字列が現れることが期待できます。実際、TUSB0216AD_Ad_Data(id, 1, data1.as_mut_ptr(), l_ptr)とTUSB0216AD_Ad_Data(id, 2, data2.as_mut_ptr(), l_ptr)の一方のみの時には期待通りの動作をします。しかし上のように２つ並べて書くと、

Timer start!

だけ表示されてプロセスが何のエラーも吐かずに終わってしまいます。

全く自分では原因がわからず困っています。よろしくお願いいたします。

Answer 1

いま手元にWindows環境がないので試してみることができないのですが、怪しいのは以下のところでしょうか。

helper.rs

    const MAX_LENGTH: usize = 262142;

    let mut data1 = [0; MAX_LENGTH];
    let mut data2 = [0; MAX_LENGTH];

Rustの配列はスタック上にアロケートされます。0i32型の値が262142個入る配列が2つですから、4 * 262142 * 2で2097136バイト（約2MiB）のメモリーが必要です。

しかしスタックのサイズは限られています。Windowsでどのくらいの領域が確保されるのか知らないのですが、2MiBではスタック領域を大きくはみ出ている可能性があります。（スタックがオーバーフローしている）

data1とdata2の2つの配列があったときは以下のようになりそうです。

• 片方の配列の先頭バイトはスタック領域内にあり、途中からスタック領域外にはみ出している
• もう一方の配列は先頭から最後までの全体がスタック領域外にある

TUSB0216AD_Ad_Dataは配列の先頭の4バイトにアクセスしていますので、上でいう「もう一方の配列」の先頭の4バイトにアクセスしたときにメモリーアクセス違反のようなエラーが起きて、プログラムが強制終了させられると思います。

unsafe {
            TUSB0216AD_Ad_Data(id, 1, data1.as_mut_ptr(), l_ptr);
            TUSB0216AD_Ad_Data(id, 2, data2.as_mut_ptr(), l_ptr);
        }

ではなぜTUSB0216AD_Ad_Data片方だけを書くとうまくいくのかというと、多分、質問者さんがreleaseモードでコンパイルしているのではないでしょうか？

たとえば以下のようにdata1だけにアクセスしてdata2にアクセスしない場合、releaseモードでコンパイルすると、最適化によってdata2に関係するコードが全て削除されます。配列が1つだけなら、その先頭アドレスはスタック領域に入っているので動くのだと思います。

unsafe {
            TUSB0216AD_Ad_Data(id, 1, data1.as_mut_ptr(), l_ptr);
        }

試しにMAX_LENGTHを100のような小さな数字にして実行してみてください。もしそれで解決したら、スタックオーバーフローが起きているということになります。その場合は配列を使うのをやめて、ヒープにアロケートされるVec<u32>を使ってください。

訂正

data1とdata2の2つの配列があったときは以下のようになりそうです。

• 片方の配列の先頭バイトはスタック領域内にあり、途中からスタック領域外にはみ出している
• もう一方の配列は先頭から最後までの全体がスタック領域外にある

Rustは配列を初期値で埋めますので、上のようになっていると、配列が1つしかないときでもメモリーアクセス違反のようなエラーが起きてしまいます。ということは、上は間違いで、下のようになっているのかもしれません。

• 片方の配列は先頭から最後までの全体がスタック領域内にある
• もう一方の配列の先頭バイトはスタック領域内にあり、途中からスタック領域外にはみ出している

そして、配列が2つあったときは、TUSB0216AD_Ad_Dataを呼ぶところではなく、配列を初期化するところでメモリーアクセス違反のようなエラーが起きているのかもしれません。

Comments

[Yhaya]

ご回答ありがとうございます。試してみましたところ、data1, 2のサイズを小さくしてみるとエラーが出なくなりました。262142はだめで260000までは正常に動きましたのでどうやらスタック領域は2MiBなようです。ありがとうございました。

[tatsuya6502]

なるほど、少しだけはみ出していたのですね。解決してよかったです。