cr
1.0.0
/*
C++ で記述された、C 用の単一ファイル ヘッダーのみのライブ リロード ソリューション:
注: このリポジトリ内で重要なファイルはcr.hのみです。
このファイルには、マークダウン形式のドキュメント、ライセンス、実装、およびパブリック API が含まれています。このリポジトリ内の他のファイルはすべてサポート ファイルなので、無視しても問題ありません。
vcpkg 依存関係マネージャーを使用して cr をダウンロードしてインストールできます。
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install cr
vcpkg の cr ポートは、Microsoft チームのメンバーとコミュニティの貢献者によって最新の状態に保たれています。バージョンが古い場合は、vcpkg リポジトリで問題を作成するか、プル リクエストを作成してください。
(シン) ホスト アプリケーションの実行可能ファイルはcrを利用して、動的にロード可能なバイナリの形式で実際のアプリケーションのライブ リロードを管理します。ホストは次のようになります。
#define CR_HOST // required in the host only and before including cr.h
#include "../cr.h"
int main ( int argc , char * argv []) {
// the host application should initalize a plugin with a context, a plugin
cr_plugin ctx ;
// the full path to the live-reloadable application
cr_plugin_open ( ctx , "c:/path/to/build/game.dll" );
// call the update function at any frequency matters to you, this will give
// the real application a chance to run
while (! cr_plugin_update ( ctx )) {
// do anything you need to do on host side (ie. windowing and input stuff?)
}
// at the end do not forget to cleanup the plugin context
cr_plugin_close ( ctx );
return 0 ;
}ゲスト (実際のアプリケーション) は次のようになります。
CR_EXPORT int cr_main ( struct cr_plugin * ctx , enum cr_op operation ) {
assert ( ctx );
switch ( operation ) {
case CR_LOAD : return on_load (...); // loading back from a reload
case CR_UNLOAD : return on_unload (...); // preparing to a new reload
case CR_CLOSE : ...; // the plugin will close and not reload anymore
}
// CR_STEP
return on_update (...);
}CR_INITIAL_FAILUREを追加しました。最初のプラグインがクラッシュした場合、ホストは次のパスを決定する必要があり、壊れたプラグインはリロードされません。 cr_plugin_closeとの一貫性を保つために、 cr_plugin_loadを非推奨にし、 cr_plugin_openを優先しました。問題 #49 を参照してください。CR_BAD_IMAGEを追加しました。これは、ファイルの生成 (コンパイラーまたはコピー) が遅い場合に発生する可能性があります。CR_BAD_IMAGE参照)。現在、バージョンはクラッシュ ハンドラーで一度デクリメントされ、次にロールバック中にもう一度デクリメントされ、その後再びバンプされます。不完全なイメージによるロールバックでは、2 つのバージョンが誤ってロールバックされることはありません。イメージが有効になる (コピーまたはコンパイラーがイメージへの書き込みを終了する) まで、同じバージョンでロードを再試行し続けます。 CR_UNLOAD中にversion情報が使用される場合、バージョン情報は異なる値になるため、これはcrの現在の使用に影響を与える可能性があります。2 つの簡単なサンプルがsamplesディレクトリにあります。
1 つ目は、インスタンス間で動作するいくつかの基本的な静的状態と基本的なクラッシュ処理テストを示す単純なコンソール アプリケーションです。 Print to Output は、何が起こっているかを示すために使用されます。
2 つ目は、Dear ImGui を使用して opengl アプリケーションをライブリロードする方法を示しています。一部の状態はホスト側にありますが、コードの大部分はゲスト側にあります。
サンプルとテストでは fips ビルド システムを使用します。 Python と CMake が必要です。
$ ./fips build # will generate and build all artifacts
$ ./fips run crTest # To run tests
$ ./fips run imgui_host # To run imgui sample
# open a new console, then modify imgui_guest.cpp
$ ./fips make imgui_guest # to build and force imgui sample live reload
int (*cr_main)(struct cr_plugin *ctx, enum cr_op operation)これは、動的にロード可能なバイナリ エントリ ポイント関数への関数ポインタです。
引数
ctx現在ロードされているバージョン、失敗の理由、およびユーザー データに関する貴重な情報を含む、 hostからguestに渡されるコンテキストへのポインター。詳細については、 cr_plugin参照してください。operation 、 cr_op参照してください。戻る
CR_USERに設定されます。 0 またはhostプロセスに渡される正の値。 bool cr_plugin_open(cr_plugin &ctx, const char *fullpath)プラグインをロードして初期化します。
引数
ctxプラグインの内部データとユーザーデータを管理するコンテキスト。fullpathプラグインのロード可能なバイナリへのファイル名を含むフルパス、またはNULL 。戻る
true 、それ以外の場合はfalse 。 void cr_set_temporary_path(cr_plugin& ctx, const std::string &path)プラグインの一時コピーが配置される一時パスを設定します。 cr_plugin_open()の直後に呼び出す必要があります。 temporaryパスが設定されていない場合、ファイルの一時コピーは元のファイルが存在するのと同じディレクトリにコピーされます。
引数
ctxプラグインの内部データとユーザーデータを管理するコンテキスト。pathプラグインの一時コピーを保存するために使用される既存のディレクトリへのフルパス。 int cr_plugin_update(cr_plugin &ctx, bool reloadCheck = true)この関数はプラグインcr_main関数を呼び出します。コア ロジック/アプリケーションが必要とするのと同じくらい頻繁に呼び出す必要があります。
引数
ctx現在のプラグイン コンテキスト データ。reloadCheckオプション: ディスク チェック (stat()) を実行して、ダイナミック ライブラリのリロードが必要かどうかを確認します。戻る
cr_mainから直接返されます。 void cr_plugin_close(cr_plugin &ctx)プラグインが不要になったら、内部状態をクリーンアップします。
引数
ctx現在のプラグイン コンテキスト データ。 cr_op hostによって実行されているステップの種類を示す列挙型:
CR_LOADリロードによるロードが実行されており、保存された内部状態を復元するために使用できます。CR_STEPアプリケーションの更新。これは通常の最も頻繁な操作です。CR_UNLOADプラグインを再ロードするためのアンロードが実行され、アプリケーションに必要なデータを保存する機会が 1 回与えられます。CR_CLOSEプラグインを閉じるときに使用されます。これはCR_UNLOADと同様に機能しますが、その後CR_LOAD期待されません。 cr_pluginプラグイン インスタンスのコンテキスト構造体。
p内部 cr データの不透明なポインタ。userdata 、リロード間で情報を渡すためにユーザーによって使用される場合があります。version増分番号。最初のロードでは 1 から始まります。バージョンはクラッシュ処理プロセス中に変更されます。failure 、ロールバックの原因となった最後の障害エラー コードが保持されます。可能な値の詳細については、 cr_failureを参照してください。 cr_failureロード可能なバイナリでクラッシュが発生した場合、クラッシュ ハンドラーは次のいずれかでクラッシュの理由を示します。
CR_NONEエラーなし。CR_SEGFAULTセグメンテーション違反。 Linux/OSX ではSIGSEGV 、Windows ではEXCEPTION_ACCESS_VIOLATION 。CR_ILLEGAL不正な命令の場合。 Linux/OSX の場合はSIGILL 、Windows の場合はEXCEPTION_ILLEGAL_INSTRUCTIONです。CR_ABORT中止、Linux/OSX ではSIGBRT 、Windows では使用されません。CR_MISALIGNバス エラー、Linux/OSX ではSIGBUS 、Windows ではEXCEPTION_DATATYPE_MISALIGNMENT 。CR_BOUNDS EXCEPTION_ARRAY_BOUNDS_EXCEEDEDです (Windows のみ)。CR_STACKOVERFLOWはEXCEPTION_STACK_OVERFLOWです (Windows のみ)。CR_STATE_INVALIDATED静的なCR_STATE管理の安全性エラー。CR_BAD_IMAGEプラグインは有効なイメージではありません (つまり、コンパイラがまだ書き込んでいる可能性があります)。CR_OTHERその他の信号、Linux のみ。CR_USERユーザー エラー ( cr_mainから返された負の値の場合)。 CR_HOST定義この定義は、 cr.h hostに含める前に使用する必要があります。 CR_HOSTが定義されていない場合、 cr.h guest実装で使用されるパブリック API ヘッダー ファイルとして機能します。
オプションで、自動静的状態管理 ( CR_STATE ) のsafety動作モードを構成する方法として、 CR_HOST次のいずれかの値に定義することもできます。
CR_SAFESTリロード中に状態データ セクションのアドレスとサイズを検証します。何か変更があった場合、ロードはロールバックされます。CR_SAFE状態セクションのサイズのみを検証します。これは、静的なアドレスが変更される可能性があることを意味します (静的なものへのポインターを保持しないことが最善です)。CR_UNSAFEセクションのサイズが適合すること以外は何も検証しませんが、必ずしも正確である必要はありません (拡大は許容されますが、縮小は許容されません)。これがデフォルトの動作です。CR_DISABLE自動静的状態管理を完全に無効にします。 CR_STATEマクロリロード中に保存および復元されるグローバルまたはローカル静的変数にタグを付けるために使用されます。
使用法
static bool CR_STATE bInitialized = false;
cr.h をホスト (CR_HOST) に組み込む前にこれらのマクロを定義して、cr.h のメモリ割り当てやその他の動作をカスタマイズできます。
CR_MAIN_FUNC : 「cr_main」シンボルをユーザー定義関数名に変更します。デフォルト: #define CR_MAIN_FUNC "cr_main"CR_ASSERT : アサートをオーバーライドします。デフォルト: #define CA_ASSERT(e)assert(e)CR_REALLOC : libc の realloc をオーバーライドします。デフォルト: #define CR_REALLOC(ptr, size) ::realloc(ptr, size)CR_MALLOC : libc の malloc をオーバーライドします。デフォルト: #define CR_MALLOC(サイズ) ::malloc(サイズ)CR_FREE : libc の free をオーバーライドします。デフォルト: #define CR_FREE(ptr) ::free(ptr)CR_DEBUG : デバッグ メッセージを CR_ERROR、CR_LOG、CR_TRACE に出力します。CR_ERROR : デバッグ メッセージを標準エラー出力に記録します。デフォルト (CR_DEBUG のみ): #define CR_ERROR(...) fprintf(stderr, VA_ARGS )CR_LOG : デバッグ メッセージをログに記録します。デフォルト (CR_DEBUG のみ): #define CR_LOG(...) fprintf(stdout, VA_ARGS )CR_TRACE : 関数呼び出しを出力します。デフォルト (CR_DEBUG のみ): #define CR_TRACE(...) fprintf(stdout, "CR_TRACE: %sn", FUNCTION )A: ここでこれを作成した理由について読んでください。
A: アプリケーション ホストと DLL の両方が動的ランタイム (/MD または /MDd) を使用していることを確認してください。ヒープ内に割り当てられたデータは、ゲストとの間でランタイムを共有することにより、同じアロケータ インスタンスで解放する必要があるためです。ホストでは、同じアロケータが使用されていることを保証します。
A: はい。これは Windows では問題なく動作するはずです。 Linux および OSX では、クラッシュ処理に問題が発生する可能性があります
何らかの理由でcrの前に dll を読み込む必要がある場合、Visual Studio は PDB へのロックを保持したままになる可能性があります。この問題が発生している可能性があります。解決策はここにあります。
まず、ビルド システムが共有ライブラリにリンクしたままで干渉していないことを確認します。問題が発生する可能性があるものは非常に多く、共有ライブラリをcrだけが処理できるようにする必要があります。 Linux では、何が起こっているかを見つける方法の詳細については、この問題を確認してください。
cr Cリローダーであり、C を扱うと、単純なものがほとんど機能することが想定されます。
問題は、コード内で行われる変更の量に応じて、リンカがどのように再配置を決定するかということです。インクリメンタルな変更やローカライズされた変更については、何の問題もありませんでした。一般的に、通常の C コードを作成する場合には、ほとんど問題はありませんでした。現在、物事がより複雑になり、C++ に近づくと、よりリスクが高くなります。複雑な処理を行う必要がある場合は、RCCPP を確認し、この PDF とcrに関する私の元のブログ投稿を読むことをお勧めします。
これらすべての情報をもとに、どちらが自分のユースケースに適しているかを判断できるようになります。
crスポンサーcrの MacOSX への移植を後援するため。
ダニー・グレイン
ロカス・クプスティス
ノア・ラインハート
ニクラス・ランドバーグ
セファー・タグディシアン
ロバート・ガブリエル・ジャカボスキー
@pixelherodev
アレクサンダー
私たちはあらゆる貢献を歓迎します。小さなことでも貢献できます。たとえ 1 文字のタイプミスの修正であっても歓迎されます。
私たちが必要とするのは、徹底的にテストし、コード スタイルを維持し、ドキュメントを最新の状態に保つことだけです。
また、同じライセンスに基づいて投稿をリリースすることを受け入れ、同意します。
MIT ライセンス (MIT)
著作権 (c) 2017 ダニー アンジェロ カルミナティ グレイン
本ソフトウェアおよび関連ドキュメント ファイル (以下「ソフトウェア」) のコピーを入手した人には、使用、コピー、変更、マージする権利を含むがこれらに限定されない、制限なくソフトウェアを取り扱う許可が、ここに無償で与えられます。 、以下の条件を条件として、本ソフトウェアのコピーを出版、配布、サブライセンス、および/または販売すること、および本ソフトウェアが提供される人物にそのことを許可すること。
上記の著作権表示およびこの許可通知は、ソフトウェアのすべてのコピーまたは主要部分に含まれるものとします。
ソフトウェアは「現状のまま」提供され、明示的か黙示的かを問わず、商品性、特定目的への適合性、および非侵害の保証を含むがこれらに限定されない、いかなる種類の保証も行われません。いかなる場合においても、作者または著作権所有者は、契約行為、不法行為、またはその他の行為であるかどうかにかかわらず、ソフトウェアまたはソフトウェアの使用またはその他の取引に起因または関連して生じる、いかなる請求、損害、またはその他の責任に対しても責任を負わないものとします。ソフトウェア。
* /
#ifndef __CR_H__
#define __CR_H__
//
// Global OS specific defines/customizations
//
#if defined( _WIN32 )
#define CR_WINDOWS
#define CR_PLUGIN ( name ) "" name ".dll"
#elif defined( __linux__ )
#define CR_LINUX
#define CR_PLUGIN ( name ) "lib" name ".so"
#elif defined( __APPLE__ )
#define CR_OSX
#define CR_PLUGIN ( name ) "lib" name ".dylib"
#else
#error "Unknown/unsupported platform, please open an issue if you think this
platform should be supported."
#endif // CR_WINDOWS || CR_LINUX || CR_OSX
//
// Global compiler specific defines/customizations
//
#if defined( _MSC_VER )
#if defined( __cplusplus )
#define CR_EXPORT extern "C" __declspec(dllexport)
#define CR_IMPORT extern "C" __declspec(dllimport)
#else
#define CR_EXPORT __declspec(dllexport)
#define CR_IMPORT __declspec(dllimport)
#endif
#endif // defined(_MSC_VER)
#if defined( __GNUC__ ) // clang & gcc
#if defined( __cplusplus )
#define CR_EXPORT extern "C" __attribute__((visibility("default")))
#else
#define CR_EXPORT __attribute__((visibility("default")))
#endif
#define CR_IMPORT
#endif // defined(__GNUC__)
#if defined( __MINGW32__ )
#undef CR_EXPORT
#if defined( __cplusplus )
#define CR_EXPORT extern "C" __declspec(dllexport)
#else
#define CR_EXPORT __declspec(dllexport)
#endif
#endif
// cr_mode defines how much we validate global state transfer between
// instances. The default is CR_UNSAFE, you can choose another mode by
// defining CR_HOST, ie.: #define CR_HOST CR_SAFEST
enum cr_mode {
CR_SAFEST = 0 , // validate address and size of the state section, if
// anything changes the load will rollback
CR_SAFE = 1 , // validate only the size of the state section, this means
// that address is assumed to be safe if avoided keeping
// references to global/static states
CR_UNSAFE = 2 , // don't validate anything but that the size of the section
// fits, may not be identical though
CR_DISABLE = 3 // completely disable the auto state transfer
};
// cr_op is passed into the guest process to indicate the current operation
// happening so the process can manage its internal data if it needs.
enum cr_op {
CR_LOAD = 0 ,
CR_STEP = 1 ,
CR_UNLOAD = 2 ,
CR_CLOSE = 3 ,
};
enum cr_failure {
CR_NONE , // No error
CR_SEGFAULT , // SIGSEGV / EXCEPTION_ACCESS_VIOLATION
CR_ILLEGAL , // illegal instruction (SIGILL) / EXCEPTION_ILLEGAL_INSTRUCTION
CR_ABORT , // abort (SIGBRT)
CR_MISALIGN , // bus error (SIGBUS) / EXCEPTION_DATATYPE_MISALIGNMENT
CR_BOUNDS , // EXCEPTION_ARRAY_BOUNDS_EXCEEDED
CR_STACKOVERFLOW , // EXCEPTION_STACK_OVERFLOW
CR_STATE_INVALIDATED , // one or more global data section changed and does
// not safely match basically a failure of
// cr_plugin_validate_sections
CR_BAD_IMAGE , // The binary is not valid - compiler is still writing it
CR_INITIAL_FAILURE , // Plugin version 1 crashed, cannot rollback
CR_OTHER , // Unknown or other signal,
CR_USER = 0x100 ,
};
struct cr_plugin ;
typedef int ( * cr_plugin_main_func )( struct cr_plugin * ctx , enum cr_op operation );
// public interface for the plugin context, this has some user facing
// variables that may be used to manage reload feedback.
// - userdata may be used by the user to pass information between reloads
// - version is the reload counter (after loading the first instance it will
// be 1, not 0)
// - failure is the (platform specific) last error code for any crash that may
// happen to cause a rollback reload used by the crash protection system
struct cr_plugin {
void * p ;
void * userdata ;
unsigned int version ;
enum cr_failure failure ;
unsigned int next_version ;
unsigned int last_working_version ;
};
#ifndef CR_HOST
// Guest specific compiler defines/customizations
#if defined( _MSC_VER )
#pragma section(".state", read, write)
#define CR_STATE __declspec(allocate(".state"))
#endif // defined(_MSC_VER)
#if defined( CR_OSX )
#define CR_STATE __attribute__((used, section("__DATA,__state")))
#else
#if defined( __GNUC__ ) // clang & gcc
#define CR_STATE __attribute__((section(".state")))
#endif // defined(__GNUC__)
#endif
#else // #ifndef CR_HOST
// Overridable macros
#ifndef CR_LOG
# ifdef CR_DEBUG
# include 
