図解 MemoryLayout<T>で解き明かす型のメモリー構成

# プロパティの宣言順番によってメモリサイズが異る
以下のFooとBarは、どちらもInt型とInt8型,Int32型のプロパティだけを持つ値型ですが、
それぞれ確保されるメモリサイズが異なります。

※ 1.3 GHz Intel Core i5 (64bit)の場合

```foo.swift
struct Foo {
	let a: Int
	let b: Int8
	let c: Int32
}
print(MemoryLayout<Foo>.size) // 16
```

```bar.swift
struct Bar {
	let b: Int8
	let a: Int
	let c: Int32
}
print(MemoryLayout<Bar>.size) // 20
```

どうしてこのような結果になるのか、
MemoryLayoutで定義されている以下の３つの型プロパティをもとに考えたいと思います。

# 各プロパティについて
以下[リファレンス](http://swiftdoc.org/v3.1/type/MemoryLayout/)を自分なりに意訳してみました。

| name | 説明 |
|:--------|:-----|
|alignment|型Tのデフォルトのメモリアライメント値。単位はバイト。<br>unsafe pointerを使ってメモリーを確保する際は、このalimentプロパティを使用すること。<br>この値は常に正。|
|size     |型Tが必要とするメモリ容量(バイト数)。<br><br>この値には、動的に生成されたメモリや離れた箇所へのメモリ領域は含まれない。<br>とりわけ、型Tがclassの場合は、定義されているストアドプロパティの数は関係しない。<br><br>またunsafe pointerを使用して、複数のTインスタンスのメモリーを確保する際には、sizeの代わりにstrideプロパティを使用すること。|
|stride   |Array\<T\>もしくは連続して型Tインスタンスを確保した際に、型Tインスタンスの開始から次のインスタンスまでのバイト数。<br>この値は、UnsafePointer\<T\>インスタンスがインクリメントされる時に移動されるバイト数と同一である。<br><br>型Tは効率的なメモリ空間と引き換えに、最適なランタイムパフォーマンスを提供する最小のアライメント値を持つ。|

## 疑問
リファレンスの説明は難しい。。。以下僕に生じた疑問です。
1. alignmentの説明が分からない。そもそもalignmentとは何なのか?
2. なぜ連続して型Tインスタンスのメモリーを確保する時は、sizeではなくstrideなのか?

まずalignementについて調べようと思います。
実はこれが前述したFooとBarのサイズが異る理由になっていました。

# 疑問1 alignmentとは
alignmentの必要性を理解するためには、
CPUがメインメモリからどのようにデータを読み込んでいるかを理解する必要があります。
alignmentは、この読み込みを最適化し、かつメモリリソースの効率化を実現するための仕組みだからです。

## CPUがメインメモリーからデータを読み取る仕組みについて

### CPUがメインメモリーからデータを読み取るまでのフロー
![[CPU]メモリからデータの読み込みイメージ図.png](https://qiita-image-store.s3.amazonaws.com/0/70065/bcc01bc7-33bb-6545-3ab5-df3a6bb8d9b9.png "[CPU]メモリからデータの読み込みイメージ図.png")

1. CPUはメインメモリーに対してアドレスバスを通じて読み取りたいデータのアドレスを伝える。
2. メインメモリーは1の要求を受けてデータバスに該当のメモリアドレスに格納されているデータを出力する。
3. CPUはデータバスを通して、データを受け取る。

つまりCPUとメインメモリーに関して以下のことがいえます。

### CPUとメインメモリーについて

* メモリアドレスは64bitの場合、8バイトずつ割り振られている。(32bitは4バイト、16bitは2バイトずつ。またこの値は **アドレス長** と表現される。)
* CPUはメモリーに対してアドレス長毎にしかデータを取得(or格納)できない。
  もし下図のように、4バイトのデータaと8バイトのデータbを詰めてメモリーに格納してしまった場合、
データbの値を取得するのにCPUは、メインメモリーから2回データを読み取る必要が発生する。
![データa(4)とb(8)が詰めて格納された場合.png](https://qiita-image-store.s3.amazonaws.com/0/70065/1e41fe2b-4c0b-1736-2833-e72878e2fb92.png "データa(4)とb(8)が詰めて格納された場合.png")

* アドレス長(ここでは８バイト)毎にデータを格納すれば、一度に大きな値を取得(or格納)することが出来る。

![アドレス長ごとにデータを格納すれば.png](https://qiita-image-store.s3.amazonaws.com/0/70065/b45b28b1-761d-122f-68f6-aef2f4fe2fbd.png "アドレス長ごとにデータを格納すれば.png")


* 闇雲にアドレス長毎にデータを格納していくと、 小さなデータは無駄にメモリをがめる事になる。
  ![abcが1バイトずつ.png](https://qiita-image-store.s3.amazonaws.com/0/70065/b10e9155-554a-8b4d-2570-7a8c65a48ee9.png "abcが1バイトずつ.png")

  また上図の場合、データa,b,cを同一のアドレス位置に格納しても、データbの取得は一回で行え、また省メモリにもつながる。

  ![abcが同じメモリアドレスに.png](https://qiita-image-store.s3.amazonaws.com/0/70065/ab84bf7f-e720-fefe-7494-ebee1a3e3b81.png "abcが同じメモリアドレスに.png")


そこで各型において、 **CPUからの読み取り回数を減らし、かつメモリーもなるべく収まるような最適な位置にデータが割り当てるための値** を考えます。

これがalignment値です。

## alignmentとは
つまりalignmentは、CPUの最適なパフォーマンスとなるべくデータの省メモリー化を実現するための兼ね合いから考え出された妥協の産物だといえます。

ここでSwift Standard Libraryで用意されている基本型のaliment値を確認すると以下の用になっていました。

※ 1.3 GHz Intel Core i5 (64bit)の場合

|型          |alignment|size|stride|
|:-----------|:-------:|:--:|:----:|
|Int8        |1        |1   |1     |
|Int16       |2        |2   |2     |
|Int32       |4        |4   |4     |
|Int64       |8        |8   |8     |
|Int         |8        |8   |8     |

つまりInt8はalignmentの値が１なので、メモリーアドレス値が **１の倍数** の位置に格納されるということになります。
またInt16は **2の倍数**, Int32は **4の倍数**,  Int64は **8の倍数** の位置に。<br>
これはsizeの値と一緒に考えると、
例えば型Intの場合、sizeは8バイトなので、alignment値が8であれば、メインメモリーに対して8の倍数となる位置に読み込まれるため、一つのメモリアドレス空間にデータを格納できます。
※ SwiftのInt型のsizeはアドレス長です。

このaliment値から、FooとBarのメモリ構成は以下のようになっていると考えれれます。

## FooとBarのメモリ構成

### Fooのメモリ構成
``` foo.swift
struct Foo {
	let a: Int
	let b: Int8
	let c: Int32
}
print(MemoryLayout<Foo>.size) // 16
```

![Fooのメモリ構成.png](https://qiita-image-store.s3.amazonaws.com/0/70065/15fce37e-0142-160d-259c-e06e7b6965fa.png "Fooのメモリ構成.png")
占めているメモリ容量 = a(8) + b(1) + 灰色(3) + c(4) = 16 

### Barのメモリ構成
```bar.swift
struct Bar {
	let b: Int8
	let a: Int
	let c: Int32
}
print(MemoryLayout<Bar>.size) // 20
```

![Barのメモリ構成.png](https://qiita-image-store.s3.amazonaws.com/0/70065/1bea7d8f-7ff3-d18e-1eb8-a89aae4f3717.png "Barのメモリ構成.png")
占めているメモリ容量 = b(1) + 灰色(7) + a(8) + c(4) = 20 

それぞれMemoryLayout\<T\>.sizeで取得した値になっています。

# 疑問２ Strideの役割
sizeプロパティの説明にて、
> 型Tインスタンスを連続して生成する際は、sizeではなく、stride値を使用すること

とあり、またstrideの定義は以下のように説明されています。
> Array\<T\>もしくは連続して型Tインスタンスを確保した際に、型Tインスタンスの開始から次のインスタンスまでのバイト数。
> この値は、UnsafePointer\<T\>インスタンスがインクリメントされる時に移動されるバイト数と同一である。

<br>
このStride値について、再度型Barを用いて考えたいと思います。

## MemoryLayout\<Bar\> 各プロパティ値
```bar.swift
struct Bar {
	let b: Int8
	let a: Int
	let c: Int32
}
```

MemoryLayout\<Bar\>における各値

|alignment|size|stride|
|---------|----|------|
|8        |20|24  |

つまり型Barのalignment値は8なので、型Barインスタンスは、アドレス値が8の倍数の位置にしか格納出来ないことが分かる。
従って、size値を用いて連続的にBarインスタンスを確保することが出来ない。
そこでalignmentが考慮されたstride値が必要となると考えられる。(下図)

![[Bar]のメインメモリー上のメモリ構成 .png](https://qiita-image-store.s3.amazonaws.com/0/70065/291405b8-ce30-3292-d92d-6d954c82802c.png "[Bar]のメインメモリー上のメモリ構成 .png")

# 最後に
FooとBarのメモリ構成は最適化を指定して実行した際も異なっていました。
つまり型を定義する際に、alignment値を考慮すれば、ある程度は省メモリ化することが出来るということがいえます。


# 参考サイト
アライメントについて

* [データ型のアラインメントとは何か，なぜ必要なのか？](http://www5d.biglobe.ne.jp/~noocyte/Programming/Alignment.html)  
  今回のアライメントの理解はこのサイト無くしてはありえませんでした。感謝です。

MemoryLayout\<T\>について

 * [Swiftのメモリレイアウトを調べる](http://qiita.com/omochimetaru/items/64b073c5d6bcf1bbbf99)  
   データをダンプしてその実態まで調査されている力に脱帽です。
   今回、自分がバイナリ値を直接読み取る力がないため、図にしてみようと思ったきっかけになった記事です。
 * [MemoryLayout and Data in Swift3](http://qiita.com/naru-jpn/items/ac4442758212570ee071)  
   MemoryLayout\<T\>の使い方に非常に参考にさせていただきました。