本稿では、Rust においてメモリ使用量を削減するために「Box（ボックスタイプ）」をどのように活用するか解説します。 - RUST ヒント：`Box<T>` はスプラッシュメモリの削減や大型構造体の配置制御に有効です。

現実世界の Rust プログラムで 895 MB を使用していたメモリ容量を、一部の構造体（struct）の配置や JSON ファイルのデシリアライズ方法を変更するだけで 475 MB も節約することができました。

実際のユースケース

このプログラムは、https://github.com/awslabs/aws-sdk-rust/tree/main/aws-models にあるすべての JSON ファイルを、「Smithy Shape」構造体に変換してデシリアライズします。

これらのファイルには、以下の例に似た数千人規模の構造体が含まれています：

"com.amazonaws.iam#EnableOrganizationsRootSessionsResponse": {
    "type": "structure",
    "members": {
        "OrganizationId": {
            "target": "com.amazonaws.iam#OrganizationIdType",
            "traits": {
                "smithy.api#documentation": "<p>The unique identifier (ID) of an organization.</p>"
            }
        },
        "EnabledFeatures": {
            "target": "com.amazonaws.iam#FeaturesListType",
            "traits": {
                "smithy.api#documentation": "<p>The features you have enabled for centralized root access.</p>"
            }
        }
    },
    "traits": {
        "smithy.api#output": {}
    }
}

Rust の慣習に従い、非常に便利な

serde

serde

#[derive(Clone, Deserialize, Serialize)]
pub struct SmithyShape {
    #[serde(rename = "type")]
    pub shape_type: SmithyShapeType,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub operations: Vec<SmithyReference>,
    #[serde(default)]
    pub members: FxHashMap<String, SmithyReference>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<SmithyReference>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value: Option<SmithyReference>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub member: Option<SmithyReference>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub input: Option<SmithyReference>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub output: Option<SmithyReference>,
    #[serde(default)]
    pub traits: SmithyTraits,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SmithyReference {
    pub target: ShortShapeId,
    #[serde(default)]
    pub traits: SmithyTraits,
}

#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct SmithyTraits {
    #[serde(rename = "smithy.api#title", skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(rename = "aws.api#service", skip_serializing_if = "Option::is_none")]
    pub service: Option<SmithyServiceTrait>,
    #[serde(
        rename = "smithy.api#sensitive",
        skip_serializing_if = "Option::is_none"
    )]
    pub sensitive: Option<SmithySensitiveTrait>,
    #[serde(
        rename = "smithy.api#documentation",
        skip_serializing_if = "Option::is_none"
    )]
    pub documentation: Option<String>,
    #[serde(rename = "smithy.api#pattern", skip_serializing_if = "Option::is_none")]
    pub pattern: Option<String>,
    #[serde(rename = "aws.iam#iamAction", skip_serializing_if = "Option::is_none")]
    pub iam_action: Option<SmithyIamAction>,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SmithyServiceTrait {
    pub sdk_id: Option<String>,
    pub arn_namespace: Option<String>,
    pub cloud_formation_name: Option<String>,
    pub cloud_trail_event_source: Option<String>,
    pub endpoint_prefix: Option<String>,
}

これは標準的な見映えをしたコードであり、現在の慣行ですが、私たちはこれを「 naïve（天真的）」とも呼ぶこともできます。このようにデシリアライズすることで、構造体が 895 MB のメモリを消費してしまいます。分析の結果、大部分の可視化された文字列が欠落していることが判明し、そこで大幅なメモリフットプリント削減を実現しました。

しかし、これには Rust に特有のいくつかのポイントを知る必要があるため、少し寄り道が必要です：

Rust の構造体とメモリについて

64 ビットのプラットフォームでは、1 ワードは 8 バイトで構成されています（例え

usize

String

String

dbg!(std::mem::size_of::<String>());

niche compiler optimization（ニッチなコンパイラ最適化）により、

Option<String>

None

したがって、以下の構造体は、すべての文字列が欠落している（

None

pub struct SmithyServiceTrait {
    pub sdk_id: Option<String>,
    pub arn_namespace: Option<String>,
    pub cloud_formation_name: Option<String>,
    pub cloud_trail_event_source: Option<String>,
    pub endpoint_prefix: Option<String>,
}

さて、構造体の合成についてです。別の構造体を「含む」ような構造体を見てみましょう。ここでは単純化のために、当方の

SmithyServiceTrait

pub struct Container1 {
    pub some_string: Option<String>,
    #[serde(default)]
    pub trait: SmithyServiceTrait,
}

最小サイズは、予想通り 24 + 120 = 144 バイトとなります。

しかし、我々の

SmithyShape

Container

Option<SmithyServiceTrait>

pub struct Container2 {
    pub some_string: Option<String>,
    #[serde(default)]
    pub trait: Option<SmithyServiceTrait>,
}

両方の

some_string

trait

None

Container1

SmithyServiceTrait

Option<String>

これを我々の

SmithyTraits

これらの言語では、以下の場合：

class Container {
    String someString;
    SmithyServiceTrait trait;
}

null トリート（trait）はメモリ上でポインタサイズのワードのみを使用します。

我々の Rust の

Container

pub struct Container3 {
    pub some_string: Option<String>,
    pub trait: Option<Box<SmithyServiceTrait>>,
}

今、両方の

some_string

trait

None

Option<String>

Option<Box<...>>

Option<Box<...>>

Box<...>

メモリを回復させた変更

基本的には、変化は以下の点に集約されます：

1. 構造体が不要である何时を検出する（すなわち、すべてのフィールドが

   None

   の時）
2. その親構造体内でそれを可視化にし、ヒープ上に移動させる
3. 空の不要な構造体を保存しないようにカスタムデシリアライザを実装する

したがって：

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SmithyReference {
    pub target: ShortShapeId,
    #[serde(default)]
    pub traits: SmithyTraits,
}

は以下のように変更されます：

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SmithyReference {
    pub target: ShortShapeId,
    #[serde(
        default,
        deserialize_with = "deserialize_boxed_traits",
        serialize_with = "serialize_boxed_traits"
    )]
    pub traits: Option<Box<SmithyTraits>>,
}

fn deserialize_boxed_traits<'de, D: Deserializer<'de>>(
    deserializer: D
) -> Result<Option<Box<SmithyTraits>>, D::Error> {
    let traits = SmithyTraits::deserialize(deserializer)?;
    if traits.is_empty() { // すなわち、すべての可視化された文字列が none の場合
        Ok(None)
    } else {
        Ok(Some(Box::new(traits)))
    }
}

同様にして、

SmithyShape

Option<SmithyReference>

Option<Box<SmithyReference>>

いくつかのノート：

• このデシリアライゼーションは、オブジェクトが廃棄される前にデシリアライズされるため、CPU でより多くのコストがかかります。しかし、メモリの検索を必要としなくなったことで、この追加の手順にもかかわらずタスク全体が早まったという点において、トレードオフは完全な勝利となりました。
• 多くのボックスは破片化されたヒープを意味します。このような場合の問題ではありませんが、これは覚えておく価値があります。

検証：影響の実証

経験を持つと、どこでスペースを節約し、どれだけなのかへの直感を得ることができます。しかし、真剣に作業するためには、行ったことが機能したことを確認し、価値があったかを検証する必要があります。つまり、測定が必要です。Rust にて、すべてのポインターをたどって複合オブジェクトが消費する総空間を知る簡単な軽量な方法はありません。ここでは、割り当ての状態に関する情報を提供するアロケータを使用する解決策を選びました（標準アロケータは内部統計について限られた可視性しか提供しないため、

jemalloc

常にこのアロケータを使用したいわけではないので、

Cargo.toml

[features]
profile = ["tikv-jemallocator", "tikv-jemalloc-ctl"]

[dependencies]
tikv-jemallocator = { optional = true, version = "0.6", features = ["stats", "profiling"] }
tikv-jemalloc-ctl = { optional = true, version="0.6", features = ["stats"] }

そして、メインで使用することを宣言します：

#[cfg(feature = "profile")]
#[global_allocator]
static ALLOC: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;

次に、それらの shape をすべてデシリアライズする関数において、測定を実行します：

#[cfg(feature = "profile")]
fn allocated_mb() -> usize {
    tikv_jemalloc_ctl::epoch::advance().unwrap();
    tikv_jemalloc_ctl::stats::allocated::read().unwrap_or(0) / (1024 * 1024)
}

#[cfg(feature = "profile")]
let base = allocated_mb();

... shape をすべて読み込む ...

#[cfg(feature = "profile")]
eprintln!(
    "Memory used for the shapes = {} MB (total)",
    allocated_mb() - base
);

ヒント：

tikv_jemalloc_ctl

結論：覚えておくべきことは何か（簡潔に）

総括すると、Rust 開発者が必要として理解し、覚えておくべきものは以下の通りです：

• 複合構造体は有意なメモリを消費します。
• コンテンツが重要でないことを検出することで、フィールド（

  BigStruct

  ）を可視化にすることは費用対効果があります。
• 可視化されたフィールド

  Option<BigStruct>

  は、

  None

  でも少なくとも

  BigStruct

  のスペースを取ります。

• field: Option<Box<BigStruct>>

  でボックス化することで、この連鎖を断ち切る（その時、

  None

  は親構造体でワードのみをとる）。
• これらの最適化は、Serde によるデシリアライゼーションにおいても可能にします。