release/man3/endian.3

   1 .\" Copyright (C) 2009, Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\" a few pieces remain from an earlier version
   4 .\" Copyright (C) 2008, Nanno Langstraat <nal@ii.nl>
   5 .\"
   6 .\" %%%LICENSE_START(VERBATIM)
   7 .\" Permission is granted to make and distribute verbatim copies of this
   8 .\" manual provided the copyright notice and this permission notice are
   9 .\" preserved on all copies.
  10 .\"
  11 .\" Permission is granted to copy and distribute modified versions of this
  12 .\" manual under the conditions for verbatim copying, provided that the
  13 .\" entire resulting derived work is distributed under the terms of a
  14 .\" permission notice identical to this one.
  15 .\"
  16 .\" Since the Linux kernel and libraries are constantly changing, this
  17 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  18 .\" responsibility for errors or omissions, or for damages resulting from
  19 .\" the use of the information contained herein.  The author(s) may not
  20 .\" have taken the same level of care in the production of this manual,
  21 .\" which is licensed free of charge, as they might when working
  22 .\" professionally.
  23 .\"
  24 .\" Formatted or processed versions of this manual, if unaccompanied by
  25 .\" the source, must acknowledge the copyright and authors of this work.
  26 .\" %%%LICENSE_END
  27 .\"
  28 .\"*******************************************************************
  29 .\"
  30 .\" This file was generated with po4a. Translate the source file.
  31 .\"
  32 .\"*******************************************************************
  33 .TH ENDIAN 3 2010\-09\-10 GNU "Linux Programmer's Manual"
  34 .SH 名前
  35 htobe16, htole16, be16toh, le16toh, htobe32, htole32, be32toh,
  36 le32toh, htobe64, htole64, be64toh, le64toh \- ホストバイトオーダーと
  37 ビッグ/リトルエンディアンバイトオーダーの間で値の変換を行う
  38 .SH 書式
  39 .nf
  40 \fB#define _BSD_SOURCE\fP             /* feature_test_macros(7) 参照 */
  41 \fB#include <endian.h>\fP
  42
  43 \fBuint16_t htobe16(uint16_t \fP\fIhost_16bits\fP\fB);\fP
  44 \fBuint16_t htole16(uint16_t \fP\fIhost_16bits\fP\fB);\fP
  45 \fBuint16_t be16toh(uint16_t \fP\fIbig_endian_16bits\fP\fB);\fP
  46 \fBuint16_t le16toh(uint16_t \fP\fIlittle_endian_16bits\fP\fB);\fP
  47
  48 \fBuint32_t htobe32(uint32_t \fP\fIhost_32bits\fP\fB);\fP
  49 \fBuint32_t htole32(uint32_t \fP\fIhost_32bits\fP\fB);\fP
  50 \fBuint32_t be32toh(uint32_t \fP\fIbig_endian_32bits\fP\fB);\fP
  51 \fBuint32_t le32toh(uint32_t \fP\fIlittle_endian_32bits\fP\fB);\fP
  52
  53 \fBuint64_t htobe64(uint64_t \fP\fIhost_64bits\fP\fB);\fP
  54 \fBuint64_t htole64(uint64_t \fP\fIhost_64bits\fP\fB);\fP
  55 \fBuint64_t be64toh(uint64_t \fP\fIbig_endian_64bits\fP\fB);\fP
  56 \fBuint64_t le64toh(uint64_t \fP\fIlittle_endian_64bits\fP\fB);\fP
  57 .fi
  58 .SH 説明
  59 これらの関数は、整数値のバイトエンコーディングを、
  60 使用中の CPU ("ホスト") のバイトオーダーから
  61 リトルエンディアンやビッグエンディアンバイトオーダーへの変換や
  62 その逆の変換を行う。
  63
  64 各関数の名前に付いている数字 \fInn\fP は、その関数が扱う整数のサイズ
  65 (16, 32, 64 ビットのどれか) を示している。
  66
  67 名前が "htobe\fInn\fP" という形の関数は、ホストバイトオーダーから
  68 ビッグエンディアンバイトオーダーへの変換を行う。
  69
  70 名前が "htole\fInn\fP" という形の関数は、ホストバイトオーダーから
  71 リトルエンディアンバイトオーダーへの変換を行う。
  72
  73 名前が "be\fInn\fPtoh" という形の関数は、ビッグエンディアンバイトオーダー
  74 からホストバイトオーダーへの変換を行う。
  75
  76 名前が "le\fInn\fPtoh" という形の関数は、リトルエンディアンバイトオーダー
  77 からホストバイトオーダーへの変換を行う。
  78 .SH バージョン
  79 これらの関数は glibc バージョン 2.9 で追加された。
  80 .SH 準拠
  81 これらの関数は非標準である。
  82 BSD には同様の関数が存在するが、 BSD では
  83 必要なヘッダファイルは \fI<endian.h>\fP ではなく
  84 \fI<sys/endian.h>\fP である。
  85 不幸なことに、 NetBSD, FreeBSD, glibc では、
  86 これらの関数の元々の OpenBSD での、 \fInn\fP は常に関数名の末尾に置く
  87 という名前付けルールが踏襲されていない
  88 (そのため、例を挙げると、 OpenBSD の "betoh32" と等価な関数は
  89 NetBSD, FreeBSD, glibc では "be32toh" となる)。
  90 .SH 注意
  91 これらの関数は、前からある \fBbyteorder\fP(3) 系の関数と同じである。
  92 例えば、 \fBbe32toh\fP() は \fBntohl\fP() と等価である。
  93
  94 \fBbyteorder\fP(3) 系の関数のメリットは、これらが
  95 全ての UNIX システムで利用可能な標準関数である点である。
  96 一方で、これらの関数は TCP/IP 処理で使用されることを想定して
  97 設計されたため、このページで説明している 64 ビット版や
  98 リトルエンディアン版などが存在しない。
  99 .SH 例
 100 以下のプログラムは、整数をホストバイトオーダーからリトルエンディアンと
 101 ビットエンディアンの両方のバイトオーダーに変換し、その結果を表示する。
 102 ホストバイトオーダーはリトルエンディアンかビットエンディアンのいずれか
 103 なので、変換に意味があるのはどちらか一方だけである。
 104 このプログラムを x86\-32 などのリトルエンディアンのシステムで実行した
 105 場合の実行結果は下記のようになる。
 106 .in +4n
 107 .nf
 108
 109 $ \fB./a.out\fP
 110 x.u32 = 0x44332211
 111 htole32(x.u32) = 0x44332211
 112 htobe32(x.u32) = 0x11223344
 113 .fi
 114 .in
 115 .SS プログラムのソース
 116 \&
 117 .nf
 118 #include <endian.h>
 119 #include <stdint.h>
 120 #include <stdio.h>
 121 #include <stdlib.h>
 122
 123 int
 124 main(int argc, char *argv[])
 125 {
 126     union {
 127         uint32_t u32;
 128         uint8_t arr[4];
 129     } x;
 130
 131     x.arr[0] = 0x11;    /* Lowest\-address byte */
 132     x.arr[1] = 0x22;
 133     x.arr[2] = 0x33;
 134     x.arr[3] = 0x44;    /* Highest\-address byte */
 135
 136     printf("x.u32 = 0x%x\en", x.u32);
 137     printf("htole32(x.u32) = 0x%x\en", htole32(x.u32));
 138     printf("htobe32(x.u32) = 0x%x\en", htobe32(x.u32));
 139
 140     exit(EXIT_SUCCESS);
 141 }
 142 .fi
 143 .SH 関連項目
 144 \fBbyteorder\fP(3)
 145 .SH この文書について
 146 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
 147 である。プロジェクトの説明とバグ報告に関する情報は
 148 http://www.kernel.org/doc/man\-pages/ に書かれている。