_controlfp_s

[アーティクル]
08/09/2011

浮動小数点制御ワードの取得および設定を行います。この関数は、「CRT のセキュリティ機能」に説明されているように、_control87、_controlfp、__control87_2 のセキュリティが強化されたバージョンです。

errno_t _controlfp_s(
    unsigned int *currentControl,
    unsigned int newControl,
    unsigned int mask
);

パラメーター

currentControl
現在の制御ワードのビット値。
newControl
新しい制御ワードのビット値
mask
新しく設定する制御ワードビットのマスク。

戻り値

正常終了した場合は 0 を返し、失敗した場合は errno 値のエラーコードを返します。

解説

_controlfp_s 関数は、_control87 関数のセキュリティが強化された、プラットフォームに依存しないバージョンであり、currentControl と newControl のそれぞれのアドレスに対して、浮動小数点制御ワードの取得と設定を行います。この値のビットは、浮動小数点のコントロールの状態を示します。浮動小数点のコントロールの状態を使用すると、プログラムで使用する浮動小数点演算パッケージの精度、丸め、および無限大の各モードを変更できます。 _controlfp_s を使用して、浮動小数点例外のマスクの設定および解除を行うこともできます。

mask の値を 0 にすると、_controlfp_s は浮動小数点制御ワードを取得し、その取得した値を currentControl に格納します。

場合maskは 0 以外、制御ワードの新しい値を設定。（1 に等しい）ではmask、ビットがnew制御ワードの更新に使用されます。つまり、fpcntrl = ((fpcntrl & ~mask) | (new & mask)) で、fpcntrl は浮動小数点制御ワードです。この場合、変更が完了してから currentControl に値が設定されるため、古い制御ワードのビット値ではありません。

注意

既定では、ランタイムライブラリは、すべての浮動小数点例外をマスクします。

Intel (x86) プラットフォームでは _controlfp_s 関数は _control87 関数とほぼ同じです。また、MIPS と ALPHA の各プラットフォームでサポートされています。浮動小数点コードを MIPS または ALPHA に確実に移植するには、_controlfp_s を使用します。 x86 プラットフォームを対象とする場合は、_control87 関数または _controlfp_s 関数を使用します。

_control87 関数と _controlfp_s 関数の違いは、DENORMAL 値の扱い方です。 Intel (x86) プラットフォームでは、_control87 によって DENORMAL OPERAND 例外マスクの設定および解除を行うことができます。 ALPHA プラットフォームでは、この例外がサポートされていないため、_controlfp_s では DENORMAL OPERAND 例外マスクが変更されません。違いは、次のとおりです。

_control87( _EM_INVALID, _MCW_EM ); 
// DENORMAL is unmasked by this call.
_controlfp( _EM_INVALID, _MCW_EM ); 
// DENORMAL exception mask remains unchanged.

マスク定数の対象となる値 (mask) および新しい制御値 (newControl) を下記の「16 進数の値」の表に示します。 2 つの関数の引数には、16 進数値を明示的に指定せずに、表に示すような移植性の高い定数 (_MCW_EM、_EM_INVALID など) を使用します。

ALPHA プラットフォームでは、DENORMAL 入出力値がソフトウェアでサポートされています。これらのプラットフォーム上の Windows NT の既定の動作では、DENORMAL 入出力値がゼロにフラッシュされます。 _controlfp_s 関数では新しいマスクを使用して、DENORMAL 入出力値の保持およびフラッシュを行います。

Intel (x86) プラットフォームでは、DENORMAL 入出力値がハードウェアでサポートされています。このプラットフォームでは DENORMAL 値を保持するように動作します。 _control87 関数はこの動作を変更するマスクを使用しません。次の例に、この違いを示します。

controlfp( _DN_SAVE, _MCW_DN);   
// Denormal values preserved by software on ALPHA. NOP on x86
controlfp( _DN_FLUSH, _MCW_DN);   
// Denormal values flushed to zero by hardware on ALPHA. Ignored on x86

_controlfp_s 関数は、x87 と SSE2 がある場合はその両方の制御ワードに影響します。直前の __control87_2 呼び出しなどにより、2 つの制御ワードが食い違ってしまう可能性もあります。2 つの制御ワード間で不整合が生じた場合、_controlfp_s により、currentControl に EM_AMBIGUOUS フラグが設定されます。これは、返された制御ワードが両方の浮動小数点制御ワードの状態を正確に表していない可能性があるという警告です。

x64 アーキテクチャでは、浮動小数点の精度の変更はサポートされていません。そのプラットフォームで精度の制御マスクが使用されている場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。

マスクが正しく設定されていないと、「パラメーターの検証」に説明されているように、この関数は無効なパラメーターの例外を生成します。実行の継続が許可された場合、この関数は EINVAL を返し、errno を EINVAL に設定します。

共通言語ランタイムは浮動小数点の既定の精度のみをサポートするため、/clr (共通言語ランタイムのコンパイル) または /clr:pure を使用してコンパイルする場合、この関数は使用しないでください。

16 進数の値

_MCW_EM マスクに関しては、マスクを解除すると例外が設定されてハードウェア例外が許可されます。マスクを設定すると例外は無効になります。 _EM_UNDERFLOW または _EM_OVERFLOW が発生した場合は、次回の浮動小数点命令が実行されるまで、ハードウェア例外はスローされません。 _EM_UNDERFLOW または _EM_OVERFLOW の発生後すぐにハードウェア例外を生成するには、FWAIT MASM 命令を呼び出します。

マスク	16 進値	定数	16 進値
_MCW_DN (DENORMAL 制御)	0x03000000	_DN_SAVE _DN_FLUSH	0x00000000 0x01000000
_MCW_EM (割り込み例外マスク)	0x0008001F	_EM_INVALID _EM_DENORMAL _EM_ZERODIVIDE _EM_OVERFLOW _EM_UNDERFLOW _EM_INEXACT	0x00000010 0x00080000 0x00000008 0x00000004 0x00000002 0x00000001
_MCW_IC (無限制御)	0x00040000	_IC_AFFINE _IC_PROJECTIVE	0x00040000 0x00000000
_MCW_RC (丸め制御)	0x00000300	_RC_CHOP _RC_UP _RC_DOWN _RC_NEAR	0x00000300 0x00000200 0x00000100 0x00000000
_MCW_PC (精度制御)	0x00030000	_PC_24 (24 ビット) _PC_53 (53 ビット) _PC_64 (64 ビット)	0x00020000 0x00010000 0x00000000

必要条件

ルーチン	必須ヘッダー
_controlfp_s	<float.h>

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// crt_contrlfp_s.c
// processor: x86
// This program uses _controlfp_s to output the FP control 
// word, set the precision to 24 bits, and reset the status to 
// the default.
//

#include <stdio.h>
#include <float.h>
#pragma fenv_access (on)

int main( void )
{
    double a = 0.1;
    unsigned int control_word;
    int err;

    // Show original FP control word and do calculation.
    err = _controlfp_s(&control_word, 0, 0);
    if ( err ) /* handle error here */;

    printf( "Original: 0x%.4x\n", control_word );
    printf( "%1.1f * %1.1f = %.15e\n", a, a, a * a );

    // Set precision to 24 bits and recalculate.
    err = _controlfp_s(&control_word, _PC_24, MCW_PC);
    if ( err ) /* handle error here */;

    printf( "24-bit:   0x%.4x\n", control_word );
    printf( "%1.1f * %1.1f = %.15e\n", a, a, a * a );

    // Restore default precision-control bits and recalculate.
    err = _controlfp_s(&control_word, _CW_DEFAULT, MCW_PC);
    if ( err ) /* handle error here */;

    printf( "Default:  0x%.4x\n", control_word );
    printf( "%1.1f * %1.1f = %.15e\n", a, a, a * a );
}

出力

Original: 0x9001f
0.1 * 0.1 = 1.000000000000000e-002
24-bit:   0xa001f
0.1 * 0.1 = 9.999999776482582e-003
Default:  0x9001f
0.1 * 0.1 = 1.000000000000000e-002