src/intel/mda/debug_archiver.c

/*
 * Copyright 2024 Intel Corporation
 * SPDX-License-Identifier: MIT
 */

#include "debug_archiver.h"

#include "slice.h"
#include "tar.h"
#include "util/ralloc.h"
#include "util/u_debug.h"
#include "util/u_process.h"

#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>

struct debug_archiver
{
   FILE *f;
   tar_writer *tw;
   char prefix[128];
   char *archive_path;
   char *mda_dir_in_archive;
};

DEBUG_GET_ONCE_OPTION(mda_output_dir, "MDA_OUTPUT_DIR", "")
DEBUG_GET_ONCE_OPTION(mda_prefix, "MDA_PREFIX", NULL)
DEBUG_GET_ONCE_OPTION(mda_filter, "MDA_FILTER", NULL)

static bool
ensure_output_dir(const char *dir)
{
   if (!dir || !*dir || !strcmp(dir, "."))
      return true;

   struct stat st;
   if (stat(dir, &st) == 0)
      return S_ISDIR(st.st_mode);

   return mkdir(dir, 0755) == 0;
}

static bool
debug_archiver_should_create(const char *name_str)
{
   const char *filter_str = debug_get_option_mda_filter();
   if (filter_str && *filter_str) {
      slice filter = slice_from_cstr(filter_str);
      slice name = slice_from_cstr(name_str);

      while (!slice_is_empty(filter)) {
         slice_cut_result cut = slice_cut(filter, ',');
         slice pattern = cut.before;

         if (!slice_is_empty(pattern) &&
             slice_contains_str(name, pattern))
            return true;

         filter = cut.after;
      }

      /* MDA_FILTER exist but did not match, don't create. */
      return false;
   }

   return true;
}

debug_archiver *
debug_archiver_open(void *mem_ctx, const char *name, const char *info)
{
   if (!debug_archiver_should_create(name))
      return NULL;

   debug_archiver *da = rzalloc(mem_ctx, debug_archiver);

   char *filename = ralloc_asprintf(mem_ctx, "%s.mda.tar", name);

   const char *output_dir = debug_get_option_mda_output_dir();
   const char *prefix     = debug_get_option_mda_prefix();

   if (!output_dir || !*output_dir) {
      const char *process_name = util_get_process_name();
      if (!process_name || !*process_name)
         process_name = "unknown_process";

      output_dir = ralloc_asprintf(da, "./%s_%d_mda", process_name, getpid());
   }

   if (!ensure_output_dir(output_dir)) {
      /* Fallback to current directory on failure. */
      output_dir = ".";
   }

   if (prefix) {
      if (!strcmp(prefix, "timestamp")) {
         time_t now = time(NULL);
         struct tm *tm_info = localtime(&now);

         if (tm_info) {
            prefix = ralloc_asprintf(da, "%04d%02d%02d-%02d%02d%02d",
                                     tm_info->tm_year + 1900,
                                     tm_info->tm_mon + 1,
                                     tm_info->tm_mday,
                                     tm_info->tm_hour,
                                     tm_info->tm_min,
                                     tm_info->tm_sec);
         }
      }

      /* Prefix shouldn't have any `/` characters. */
      if (strchr(prefix, '/')) {
         char *safe_prefix = ralloc_strdup(da, prefix);
         for (char *p = safe_prefix; *p; p++) {
            if (*p == '/')
               *p = '_';
         }
         prefix = safe_prefix;
      }
   }

   da->archive_path = ralloc_asprintf(da, "%s/%s%s%s",
                                      output_dir,
                                      prefix ? prefix : "",
                                      prefix ? "."    : "",
                                      filename);

   da->f = fopen(da->archive_path, "wb+");

   da->tw = rzalloc(da, tar_writer);
   tar_writer_init(da->tw, da->f);

   {
      const char *filename_start = strrchr(da->archive_path, '/');
      filename_start = filename_start ? filename_start + 1 : da->archive_path;

      char *filename_copy = ralloc_strdup(da, filename_start);
      char *tar_ext = strstr(filename_copy, ".tar");
      if (tar_ext) {
         *tar_ext = '\0';
      }
      da->mda_dir_in_archive = filename_copy;
   }

   debug_archiver_set_prefix(da, "");

   tar_writer_start_file(da->tw, "mesa.txt");
   fprintf(da->f, "Mesa %s\n", info);
   tar_writer_finish_file(da->tw);

   return da;
}

void
debug_archiver_set_prefix(debug_archiver *da, const char *prefix)
{
   if (!da)
      return;

   if (!prefix || !*prefix) {
      snprintf(da->prefix, ARRAY_SIZE(da->prefix) - 1, "%s", da->mda_dir_in_archive);
   } else {
      snprintf(da->prefix, ARRAY_SIZE(da->prefix) - 1, "%s/%s", da->mda_dir_in_archive, prefix);
   }

   da->tw->prefix = da->prefix;
}

void
debug_archiver_write_file(debug_archiver *da,
                          const char *filename,
                          const char *data, unsigned size)
{
   tar_writer_start_file(da->tw, filename);
   fwrite(data, size, 1, da->tw->file);
   tar_writer_finish_file(da->tw);
}

FILE *
debug_archiver_start_file(debug_archiver *da, const char *filename)
{
   tar_writer_start_file(da->tw, filename);
   return da->f;
}

void
debug_archiver_finish_file(debug_archiver *da)
{
   tar_writer_finish_file(da->tw);
}

void
debug_archiver_close(debug_archiver *da)
{
   if (da != NULL) {
      fclose(da->f);
      ralloc_free(da);
   }
}