From a791a68b613b162c88a83f5f0225223bc167c762 Mon Sep 17 00:00:00 2001
From: Mack Straight <eiz@users.noreply.github.com>
Date: Mon, 20 Mar 2023 12:26:01 -0700
Subject: [PATCH] move file magic/version to header, print expected version
 (#319)

---
 main.cpp     | 10 +++++-----
 quantize.cpp | 10 +++++-----
 utils.h      |  8 ++++++++
 3 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/main.cpp b/main.cpp
index 159033373..3321818d3 100644
--- a/main.cpp
+++ b/main.cpp
@@ -106,12 +106,12 @@ bool llama_model_load(const std::string & fname, llama_model & model, gpt_vocab
     {
         uint32_t magic;
         fin.read((char *) &magic, sizeof(magic));
-        if (magic == 0x67676d6c) {
+        if (magic == FILE_MAGIC_UNVERSIONED) {
             fprintf(stderr, "%s: invalid model file '%s' (too old, regenerate your model files!)\n",
                     __func__, fname.c_str());
             return false;
         }
-        if (magic != 0x67676d66) {
+        if (magic != FILE_MAGIC) {
             fprintf(stderr, "%s: invalid model file '%s' (bad magic)\n", __func__, fname.c_str());
             return false;
         }
@@ -119,9 +119,9 @@ bool llama_model_load(const std::string & fname, llama_model & model, gpt_vocab
         uint32_t format_version;
         fin.read((char *) &format_version, sizeof(format_version));
 
-        if (format_version != 1) {
-            fprintf(stderr, "%s: invalid model file '%s' (unsupported format version %" PRIu32 ")\n",
-                    __func__, fname.c_str(), format_version);
+        if (format_version != FILE_VERSION) {
+            fprintf(stderr, "%s: invalid model file '%s' (unsupported format version %" PRIu32 ", expected %d)\n",
+                    __func__, fname.c_str(), format_version, FILE_VERSION);
             return false;
         }
     }
diff --git a/quantize.cpp b/quantize.cpp
index 166e9163a..07db33a3c 100644
--- a/quantize.cpp
+++ b/quantize.cpp
@@ -64,12 +64,12 @@ bool llama_model_quantize(const std::string & fname_inp, const std::string & fna
     {
         uint32_t magic;
         finp.read((char *) &magic, sizeof(magic));
-        if (magic == 0x67676d6c) {
+        if (magic == FILE_MAGIC_UNVERSIONED) {
             fprintf(stderr, "%s: invalid model file '%s' (too old, regenerate your model files!)\n",
                     __func__, fname_inp.c_str());
             return false;
         }
-        if (magic != 0x67676d66) {
+        if (magic != FILE_MAGIC) {
             fprintf(stderr, "%s: invalid model file '%s' (bad magic)\n", __func__, fname_inp.c_str());
             return false;
         }
@@ -79,9 +79,9 @@ bool llama_model_quantize(const std::string & fname_inp, const std::string & fna
         uint32_t format_version;
         finp.read((char *) &format_version, sizeof(format_version));
 
-        if (format_version != 1) {
-            fprintf(stderr, "%s: invalid model file '%s' (unsupported format version %" PRIu32 ")\n",
-                    __func__, fname_inp.c_str(), format_version);
+        if (format_version != FILE_VERSION) {
+            fprintf(stderr, "%s: invalid model file '%s' (unsupported format version %" PRIu32 ", expected %d)\n",
+                    __func__, fname_inp.c_str(), format_version, FILE_VERSION);
             return false;
         }
 
diff --git a/utils.h b/utils.h
index b3a0f4724..65fe02ba1 100644
--- a/utils.h
+++ b/utils.h
@@ -48,6 +48,14 @@ void gpt_print_usage(int argc, char ** argv, const gpt_params & params);
 
 std::string gpt_random_prompt(std::mt19937 & rng);
 
+//
+// Model file parsing
+//
+
+#define FILE_MAGIC_UNVERSIONED 0x67676d6c // pre-versioned files
+#define FILE_MAGIC 0x67676d66 // 'ggmf' in hex
+#define FILE_VERSION 1
+
 //
 // Vocab utils
 //