次の方法で共有

_controlfp_s

  • [アーティクル]

浮動小数点制御ワードの取得および設定を行います。 この関数は、「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 以外にすると、制御ワードに新しい値が設定されます。mask のビットのいずれかを設定 (つまり 1 に) すると、new の対応するビットが制御ワードの更新に使用されます。 つまり、fpcntrl= ((fpcntrl& ~mask) | (new & mask)) で、fpcntrl は浮動小数点制御ワードです。 この場合、変更が完了してから currentControl に値が設定されるため、古い制御ワードのビット値ではありません。

注意

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

_controlfp_s は、Intel (x86)、x64、および ARM のプラットフォームでは _control87 関数とほぼ同じです。 x86、x64、または ARM プラットフォームを対象とする場合は、_control87 関数、または _controlfp_s 関数を使用します。

_control87 と _controlfp_s との違いは、DENORMAL 値の処理方法にあります。 Intel (x86)、x64、および ARM の各プラットフォームでは、_control87 を使用して DENORMAL OPERAND 例外マスクを設定および解除できます。 _controlfp_s は DENORMAL OPERAND 例外マスクを変更しません。 次の例に、この違いを示します。

_control87( _EM_INVALID, _MCW_EM ); 
// DENORMAL is unmasked by this call.
unsigned int current_word = 0;
_controlfp_s( &current_word, _EM_INVALID, _MCW_EM ); 
// DENORMAL exception mask remains unchanged.

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

Intel (x86) から派生したプラットフォームでは、DENORMAL 入出力値がハードウェアでサポートされています。 x86 では DENORMAL 値を保持するように動作します。 SSE2 をサポートしている ARM プラットフォームと x64 プラットフォームでは、DENORMAL オペランドと結果をフラッシュするか、強制的にゼロにすることができます。 _controlfp_s 関数、_controlfp 関数、および _control87 関数は、この動作を変更するマスクを使用します。 このマスクの使用例を次に示します。

unsigned int current_word = 0;
_controlfp_s(&current_word, _DN_SAVE, _MCW_DN);   
// Denormal values preserved on ARM platforms and on x64 processors with
// SSE2 support. NOP on x86 platforms.
_controlfp_s(&current_word, _DN_FLUSH, _MCW_DN);   
// Denormal values flushed to zero by hardware on ARM platforms 
// and x64 processors with SSE2 support. Ignored on other x86 platforms.

ARM のプラットフォームでは、_controlfp_s 関数は FPSCR の登録に適用されます。 x64 アーキテクチャでは、MXCSR レジスタに格納されている SSE2 制御ワードだけに影響します。 Intel (x86) プラットフォームでは、_controlfp_s 関数は、存在する場合は x87 と SSE2 の両方の制御ワードに影響します。 直前の __control87_2 呼び出しなどにより、2 つの制御ワードが食い違ってしまう可能性もあります。2 つの制御ワード間で不整合が生じた場合、_controlfp_s により、currentControl に EM_AMBIGUOUS フラグが設定されます。 これは、返された制御ワードが両方の浮動小数点制御ワードの状態を正確に表していない可能性があるという警告です。

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

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

共通言語ランタイム (CLR) は浮動小数点の既定の精度のみをサポートするため、/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 (無限制御)

(ARM プラットフォームまたは x64 プラットフォームではサポートされていません。)

0x00040000

_IC_AFFINE

_IC_PROJECTIVE

0x00040000

0x00000000

_MCW_RC (丸め制御)

0x00000300

_RC_CHOP

_RC_UP

_RC_DOWN

_RC_NEAR

0x00000300

0x00000200

0x00000100

0x00000000

_MCW_PC (精度制御)

(ARM プラットフォームまたは x64 プラットフォームではサポートされていません。)

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

同等の .NET Framework 関数

使用できません。 標準 C 関数を呼び出すには、PInvoke を使用します。 詳細については、「プラットフォーム呼び出しの例」を参照してください。

参照

関連項目

浮動小数点サポート

_clear87、_clearfp

_status87、_statusfp、_statusfp2

_control87、_controlfp、__control87_2