【COBOL学習｜豆知識】ALLOCATE RETURNING句でスマートな動的メモリ管理！

皆さん、お元気ですか？ベテランCOBOLプログラマーの〇〇です。今回は、モダンCOBOLの便利な機能、ALLOCATE … RETURNING 句について深掘りしていきましょう。この機能を知れば、動的メモリ確保のコードがより安全に、そして簡潔になりますよ。

1. 導入：なぜ今、ALLOCATE RETURNING句なのか？

COBOLの世界でも、実行時に柔軟にメモリを確保する「動的メモリ管理」の重要性が増しています。特に、可変長のデータを扱ったり、大量のレコードを一時的に保持したりする場合に欠かせません。

しかし、従来のCOBOLで動的メモリを確保する際は、まず ALLOCATE 文でメモリを確保し、次に SET 文でそのアドレスをポインタ変数に代入するという2段階の操作が必要でした。この方式だと、「ALLOCATEはしたけど、SETを忘れてしまった」「ALLOCATEとSETの間に別の処理が入ってしまい、誤ってポインタがNULLのまま使われてしまった」といった、ちょっとしたヒューマンエラーや見落としによるバグのリスクがありました。

ALLOCATE … RETURNING 句は、このような課題を解決するために生まれました。メモリ確保とポインタへのアドレス代入を1ステップで行うことで、初期化忘れを防ぎ、コードをよりシンプルで堅牢にするためのモダンな機能なのです。

2. 基礎知識：動的メモリとポインタ

ここで、改めて動的メモリとポインタの基本をおさらいしておきましょう。

動的メモリ確保：プログラムの実行中に、必要に応じてメモリ領域を確保することです。例えば、ユーザーからの入力データ量によって必要なメモリサイズが変わる場合などに利用します。
ポインタ (USAGE POINTER)：メモリ上の特定のアドレス（番地）を指し示すデータ項目です。確保した動的メモリの「場所」を覚えておくために使います。
ALLOCATE 文：COBOLで動的にメモリを確保するための命令です。指定したサイズのメモリ領域をOSに要求します。
RETURNING 句：COBOL 2002標準以降で追加された、ALLOCATE文の拡張機能です。ALLOCATEで確保したメモリ領域の開始アドレスを、直接指定したポインタ変数に代入します。これにより、SET文を別途記述する必要がなくなります。

従来の記述と比較すると、そのメリットは一目瞭然です。

従来の記述:

ALLOCATE WS-SIZE.
SET WS-PTR TO ADDRESS OF WS-ALLOCATED-AREA. > ここでミスが発生する可能性

ALLOCATE … RETURNING 句を使った記述:

ALLOCATE WS-SIZE RETURNING WS-PTR. > 1ステップで完結！

3. 実装/解決策：RETURNING句の使い方

ALLOCATE … RETURNING 句の使い方は非常にシンプルです。ALLOCATE 文の後に、確保するメモリのサイズを指定し、続けて RETURNING 句でアドレスを受け取るポインタ変数を指定します。

ALLOCATE 確保するサイズ RETURNING ポインタ変数
    ON EXCEPTION
        > メモリ確保失敗時の処理
    END-ALLOCATE.

「確保するサイズ」には、PIC S9(9) COMP-5のような整数型のデータ項目（バイト数を指定）や、データ構造のサイズを直接指定する LENGTH OF 句（COBOL 2002以降）を使用できます。

この方法により、以下のようなメリットが得られます。

コードの簡潔化：ALLOCATEとSETの2行が1行になり、コードが短くなります。
初期化忘れの防止：メモリ確保と同時にポインタにアドレスが代入されるため、ポインタがNULLのまま使われるリスクが大幅に減少します。
可読性の向上：何をしているのかがより明確になり、コードの意図が伝わりやすくなります。

4. サンプルプログラム：実際に動かしてみよう！

それでは、ALLOCATE … RETURNING 句を使った具体的なCOBOLプログラムを見てみましょう。このコードは、動的に確保したメモリ領域にデータを書き込み、表示し、そして解放する一連の処理を示しています。

IDENTIFICATION DIVISION.
PROGRAM-ID. ALLOCATE-RETURNING-SAMPLE.
AUTHOR. VETERAN-COBOL-ENGINEER.

DATA DIVISION.
WORKING-STORAGE SECTION.
    > 確保するデータ構造のテンプレート
    01 WS-MY-RECORD.
       05 REC-ID       PIC X(5).
       05 REC-NAME     PIC X(20).
       05 REC-AMOUNT   PIC 9(7)V99.

    > 動的に確保した領域を指すポインタ
    01 WS-DYNAMIC-REC-PTR USAGE POINTER.

    > 確保するメモリのサイズを保持する変数
    > LENGTH OF を使うのがスマートですが、互換性のためS9(9) COMP-5も併記
    01 WS-ALLOC-SIZE      PIC S9(9) COMP-5.

    > 処理結果の状態を保持
    01 WS-STATUS-FLAG     PIC X(1) VALUE SPACES.
        88 STATUS-OK             VALUE '0'.
        88 STATUS-ERROR          VALUE 'E'.

PROCEDURE DIVISION.
MAIN-PROCEDURE.
    DISPLAY "--- ALLOCATE ... RETURNING 句による動的メモリ管理サンプル ---"

    > 確保するデータ構造のサイズを取得（LENGTH OF はCOBOL 2002以降）
    MOVE LENGTH OF WS-MY-RECORD TO WS-ALLOC-SIZE.
    DISPLAY "確保するレコードのサイズ: " WS-ALLOC-SIZE " バイト".

    > 
    > ALLOCATE ... RETURNING 句でメモリを確保し、ポインタに直接代入
    > 
    ALLOCATE WS-ALLOC-SIZE RETURNING WS-DYNAMIC-REC-PTR
        ON EXCEPTION
            DISPLAY "エラー: メモリ確保に失敗しました！"
            SET STATUS-ERROR TO TRUE
            GO TO END-PROGRAM
    END-ALLOCATE.

    > メモリ確保が成功したかを確認
    IF WS-DYNAMIC-REC-PTR = NULL
        DISPLAY "警告: ポインタがNULLです。メモリ確保に失敗したか、システムがNULLを返しました。"
        SET STATUS-ERROR TO TRUE
        GO TO END-PROGRAM
    END-IF.

    DISPLAY "メモリを正常に確保しました。ポインタ値: " WS-DYNAMIC-REC-PTR.

    > 
    > 確保したメモリ領域へのアクセス（参照変更）
    > SET ADDRESS OF 文を使って、テンプレートを確保領域に重ねる
    > 
    SET ADDRESS OF WS-MY-RECORD TO WS-DYNAMIC-REC-PTR.

    > 確保した領域にデータを設定
    MOVE "ITEM01"    TO REC-ID
    MOVE "Sample Product Name" TO REC-NAME
    MOVE 98765.43   TO REC-AMOUNT.

    DISPLAY "--- 確保したメモリ領域に設定したデータ ---"
    DISPLAY "  ID    : " REC-ID
    DISPLAY "  NAME  : " REC-NAME
    DISPLAY "  AMOUNT: " REC-AMOUNT.

    > 
    > 確保したメモリの解放
    > 不要になったメモリは必ず解放しましょう（メモリリーク防止）
    > 
    IF WS-DYNAMIC-REC-PTR NOT = NULL
        FREE WS-DYNAMIC-REC-PTR
            ON EXCEPTION
                DISPLAY "エラー: メモリ解放に失敗しました！"
                SET STATUS-ERROR TO TRUE
            NOT ON EXCEPTION
                DISPLAY "メモリを正常に解放しました。"
        END-FREE
    ELSE
        DISPLAY "警告: 解放すべきポインタがNULLでした。"
    END-IF.

END-PROGRAM.
    IF STATUS-ERROR
        DISPLAY "プログラムはエラー終了しました。"
    ELSE
        DISPLAY "プログラムは正常終了しました。"
    END-IF.
    STOP RUN.

5. 応用・注意点：現場で役立つヒントと落とし穴

モダンCOBOLの機能であること：ALLOCATE … RETURNING 句はCOBOL 2002標準で導入された機能です。お使いのCOBOLコンパイラや実行環境がこの標準をサポートしているか確認してください。古い環境では使用できません。
メモリリークの防止：動的に確保したメモリは、使用し終わったら必ず FREE 文で解放してください。解放を忘れると、プログラムが使用するメモリが徐々に増え続け、システム全体の性能低下や異常終了を引き起こす「メモリリーク」の原因となります。
エラーハンドリングの徹底：ALLOCATE 文は、システムメモリが不足している場合などに失敗することがあります。必ず ON EXCEPTION 句を使って、メモリ確保失敗時のエラー処理を記述してください。ポインタがNULLかどうかを確認するのも重要です。
確保するサイズの指定：データ項目全体を確保したい場合は、LENGTH OF 句を使うのが最もスマートです。例えば `ALLOCATE LENGTH OF MY-RECORD RETURNING MY-PTR.` のように記述できます。これにより、レコード構造が変更されてもコードを修正する必要がありません。
ポインタの参照外し：確保したメモリ領域にアクセスするには、SET ADDRESS OF データ項目 TO ポインタ変数 を使って、その領域を既存のデータ項目定義に重ねる（参照変更する）のが一般的です。これにより、通常のデータ項目と同じようにアクセスできるようになります。

ALLOCATE … RETURNING 句は、COBOLプログラムをより現代的で安全なものにするための強力なツールです。ぜひ皆さんの開発現場で活用し、より堅牢で保守しやすいシステム構築に役立ててください。

それでは、また次回の豆知識でお会いしましょう！