load/save state are now actual tasks

command.c

@@ -1228,13 +1228,12 @@ static void command_event_load_auto_state(void)
    if (!path_file_exists(savestate_name_auto))
       return;
 
-   ret = content_load_state(savestate_name_auto, false);
+   ret = content_load_state(savestate_name_auto, false, true);
 
    RARCH_LOG("Found auto savestate in: %s\n", savestate_name_auto);
 
    snprintf(msg, sizeof(msg), "Auto-loading savestate from \"%s\" %s.",
          savestate_name_auto, ret ? "succeeded" : "failed");
-   runloop_msg_queue_push(msg, 1, 180, false);
    RARCH_LOG("%s\n", msg);
 }
 
@@ -1612,19 +1611,7 @@ static void command_event_save_state(const char *path,
    settings_t *settings = config_get_ptr();
 
    if (!content_save_state(path, true))
-   {
-      snprintf(s, len, "%s \"%s\".",
-            msg_hash_to_str(MSG_FAILED_TO_SAVE_STATE_TO),
-            path);
       return;
-   }
-
-   if (settings->state_slot < 0)
-      snprintf(s, len, "%s #-1 (auto).",
-            msg_hash_to_str(MSG_SAVED_STATE_TO_SLOT));
-   else
-      snprintf(s, len, "%s #%d.", msg_hash_to_str(MSG_SAVED_STATE_TO_SLOT),
-            settings->state_slot);
 }
 
 static void command_event_undo_save_state(char *s, size_t len)
@@ -1659,24 +1646,12 @@ static void command_event_load_state(const char *path, char *s, size_t len)
 {
    settings_t *settings = config_get_ptr();
 
-   if (!content_load_state(path, false))
+   if (!content_load_state(path, false, false))
-   {
-      snprintf(s, len, "%s \"%s\".",
-            msg_hash_to_str(MSG_FAILED_TO_LOAD_STATE),
-            path);
       return;
-   }
 
 #ifdef HAVE_NETWORKING
    netplay_driver_ctl(RARCH_NETPLAY_CTL_LOAD_SAVESTATE, NULL);
 #endif
-
-   if (settings->state_slot < 0)
-      snprintf(s, len, "%s #-1 (auto).",
-            msg_hash_to_str(MSG_LOADED_STATE_FROM_SLOT));
-   else
-      snprintf(s, len, "%s #%d.", msg_hash_to_str(MSG_LOADED_STATE_FROM_SLOT),
-            settings->state_slot);
 }
 
 static void command_event_undo_load_state(char *s, size_t len)
@@ -1713,6 +1688,7 @@ static void command_event_main_state(unsigned cmd)
    char msg[128]              = {0};
    global_t *global           = global_get_ptr();
    settings_t *settings       = config_get_ptr();
+   bool push_msg              = true;
 
    if (settings->state_slot > 0)
       snprintf(path, sizeof(path), "%s%d",
@@ -1731,9 +1707,11 @@ static void command_event_main_state(unsigned cmd)
       {
          case CMD_EVENT_SAVE_STATE:
             command_event_save_state(path, msg, sizeof(msg));
+            push_msg = false;
             break;
          case CMD_EVENT_LOAD_STATE:
             command_event_load_state(path, msg, sizeof(msg));
+            push_msg = false;
             break;
          case CMD_EVENT_UNDO_LOAD_STATE:
             command_event_undo_load_state(msg, sizeof(msg));
@@ -1747,6 +1725,7 @@ static void command_event_main_state(unsigned cmd)
       strlcpy(msg, msg_hash_to_str(
                MSG_CORE_DOES_NOT_SUPPORT_SAVESTATES), sizeof(msg));
 
+   if (push_msg)
       runloop_msg_queue_push(msg, 2, 180, true);
    RARCH_LOG("%s\n", msg);
 }

content.h

@@ -44,7 +44,7 @@ bool content_load_ram_file(unsigned slot);
 bool content_save_ram_file(unsigned slot);
 
 /* Load a state from disk to memory. */
-bool content_load_state(const char* path, bool load_to_backup_buffer);
+bool content_load_state(const char* path, bool load_to_backup_buffer, bool autoload);
 
 /* Save a state from memory to disk. */
 bool content_save_state(const char *path, bool save_to_disk);

tasks/task_save.c

@@ -32,6 +32,7 @@
 #include <streams/file_stream.h>
 #include <rthreads/rthreads.h>
 #include <file/file_path.h>
+#include <retro_miscellaneous.h>
 
 #ifdef HAVE_CONFIG_H
 #include "../core.h"
@@ -46,7 +47,7 @@
 #include "../verbosity.h"
 #include "tasks_internal.h"
 
-/* TODO/FIXME - turn this into actual task */
+#define SAVE_STATE_CHUNK 4096
 
 static struct string_list *task_save_files = NULL;
 
@@ -70,6 +71,22 @@ struct sram_block
    size_t size;
 };
 
+typedef struct
+{
+   RFILE *file;
+   char path[PATH_MAX_LENGTH];
+   void *data;
+   void *undo_data;
+   ssize_t size;
+   ssize_t undo_size;
+   ssize_t written;
+   ssize_t bytes_read;
+   bool load_to_backup_buffer;
+   bool autoload;
+} save_task_state_t;
+
+typedef save_task_state_t load_task_data_t;
+
 /* Holds the previous saved state
  * Can be restored to disk with undo_save_state(). */
 static struct save_state_buf undo_save_buf;
@@ -479,127 +496,237 @@ bool content_undo_save_state(void)
    return ret;
 }
 
-
-/* TODO/FIXME - turn this into actual task */
-
 /**
- * save_state:
+ * task_save_handler_finished:
- * @path      : path of saved state that shall be written to.
+ * @task : the task to finish
- * @save_to_disk: If false, saves the state onto undo_load_buf.
+ * @state : the state associated with this task
- * Save a state from memory to disk.
  *
- * Returns: true if successful, false otherwise.
+ * Close the save state file and finish the task.
  **/
-bool content_save_state(const char *path, bool save_to_disk)
+static void task_save_handler_finished(retro_task_t *task,
+      save_task_state_t *state)
 {
-   retro_ctx_serialize_info_t serial_info;
+   task->finished = true;
-   retro_ctx_size_info_t info;
-   bool ret    = false;
-   void *data  = NULL;
 
-   core_serialize_size(&info);
+   filestream_close(state->file);
 
-   RARCH_LOG("%s: \"%s\".\n",
+   if (!task->error && task->cancelled)
-         msg_hash_to_str(MSG_SAVING_STATE),
+      task->error = strdup("Task canceled");
-         path);
 
-   if (info.size == 0)
+   if (state->data)
-      return false;
+      free(state->data);
 
-   data = malloc(info.size);
+   free(state);
-
-   if (!data)
-      return false;
-
-   RARCH_LOG("%s: %d %s.\n",
-         msg_hash_to_str(MSG_STATE_SIZE),
-         (int)info.size,
-         msg_hash_to_str(MSG_BYTES));
-
-   serial_info.data = data;
-   serial_info.size = info.size;
-   ret              = core_serialize(&serial_info);
-
-   if (ret)
-   {
-      if (save_to_disk)
-      {
-         if (path_file_exists(path))
-         {
-            /* Before overwritting the savestate file, load it into a buffer
-            to allow undo_save_state() to work */
-            /* TODO/FIXME - Use msg_hash_to_str here */
-            RARCH_LOG("%s\n",
-               "File already exists. Saving to backup buffer...");
-
-            content_load_state(path, true);
-         }
-
-         ret = filestream_write_file(path, data, info.size);
-      }
-      
-      else 
-      {
-         /* save_to_disk is false, which means we are saving the state
-         in undo_load_buf to allow content_undo_load_state() to restore it */
-
-         /* If we were holding onto an old state already, clean it up first */
-         if (undo_load_buf.data)
-         {
-            free(undo_load_buf.data);
-            undo_load_buf.data = NULL;
-         }
-
-         undo_load_buf.data = malloc(info.size);
-         if (!undo_load_buf.data)
-         {
-            free(data);
-            return false;
-         }
-
-         memcpy(undo_load_buf.data, data, info.size);
-         undo_load_buf.size = info.size;
-         strlcpy(undo_load_buf.path, path, sizeof(undo_load_buf.path));
-      }
-   }
-   else
-   {
-      RARCH_ERR("%s \"%s\".\n",
-            msg_hash_to_str(MSG_FAILED_TO_SAVE_STATE_TO),
-            path);
-   }
-
-   free(data);
-
-   return ret;
 }
 
 /**
- * content_load_state:
+ * task_load_handler_finished:
+ * @task : the task to finish
+ * @state : the state associated with this task
+ *
+ * Close the loaded state file and finish the task.
+ **/
+static void task_load_handler_finished(retro_task_t *task,
+      save_task_state_t *state)
+{
+   load_task_data_t *task_data = NULL;
+   task->finished = true;
+
+   filestream_close(state->file);
+
+   if (!task->error && task->cancelled)
+      task->error = strdup("Task canceled");
+
+   task_data = (load_task_data_t*)calloc(1, sizeof(*task_data));
+   memcpy(task_data, state, sizeof(*task_data));
+
+   task->task_data = task_data;
+
+   free(state);
+}
+
+/**
+ * task_save_handler:
+ * @task : the task being worked on
+ *
+ * Write a chunk of data to the save state file.
+ **/
+static void task_save_handler(retro_task_t *task)
+{
+   save_task_state_t *state = (save_task_state_t*)task->state;
+   int written;
+   ssize_t remaining;
+
+   if (!state->file)
+   {
+      state->file = filestream_open(state->path, RFILE_MODE_WRITE, -1);
+
+      if (!state->file)
+         return;
+   }
+
+   remaining = MIN(state->size - state->written, SAVE_STATE_CHUNK);
+
+   written = filestream_write(state->file, state->data + state->written, remaining);
+
+   state->written += written;
+   task->progress = (state->written / (float)state->size) * 100;
+
+   if (task->cancelled || written != remaining)
+   {
+      char err[PATH_MAX_LENGTH] = {0};
+      snprintf(err, sizeof(err), "%s %s", msg_hash_to_str(MSG_FAILED_TO_SAVE_STATE_TO), state->path);
+      task->error = strdup(err);
+      task_save_handler_finished(task, state);
+      return;
+   }
+
+   if (state->written == state->size)
+   {
+      settings_t *settings = config_get_ptr();
+      char msg[1024] = {0};
+
+      task_save_handler_finished(task, state);
+
+      if (task->title)
+         free(task->title);
+
+      task->title = NULL;
+
+      if (settings->state_slot < 0)
+         snprintf(msg, sizeof(msg), "%s #-1 (auto).",
+               msg_hash_to_str(MSG_SAVED_STATE_TO_SLOT));
+      else
+         snprintf(msg, sizeof(msg), "%s #%d.", msg_hash_to_str(MSG_SAVED_STATE_TO_SLOT),
+               settings->state_slot);
+
+      runloop_msg_queue_push(msg, 2, 180, true);
+
+      return;
+   }
+}
+
+/**
+ * task_load_handler:
+ * @task : the task being worked on
+ *
+ * Load a chunk of data from the save state file.
+ **/
+static void task_load_handler(retro_task_t *task)
+{
+   save_task_state_t *state = (save_task_state_t*)task->state;
+   ssize_t remaining;
+   ssize_t bytes_read;
+
+   if (!state->file)
+   {
+      state->file = filestream_open(state->path, RFILE_MODE_READ, -1);
+
+      if (!state->file)
+         return;
+
+      if (filestream_seek(state->file, 0, SEEK_END) != 0)
+         return;
+
+      state->size = filestream_tell(state->file);
+
+      if (state->size < 0)
+         return;
+
+      filestream_rewind(state->file);
+
+      state->data = malloc(state->size + 1);
+
+      if (!state->data)
+         return;
+   }
+
+   remaining = MIN(state->size - state->bytes_read, SAVE_STATE_CHUNK);
+
+   bytes_read = filestream_read(state->file, state->data + state->bytes_read, remaining);
+
+   state->bytes_read += bytes_read;
+   task->progress = (state->bytes_read / (float)state->size) * 100;
+
+   if (task->cancelled || bytes_read != remaining)
+   {
+      if (state->autoload)
+      {
+         char msg[1024] = {0};
+         snprintf(msg, sizeof(msg), "Auto-loading savestate from \"%s\" failed.",
+               state->path);
+         task->error = strdup(msg);
+      }
+      else
+      {
+         task->error = strdup(msg_hash_to_str(MSG_FAILED_TO_LOAD_STATE));
+      }
+
+      free(state->data);
+      state->data = NULL;
+      task_load_handler_finished(task, state);
+      return;
+   }
+
+   if (state->bytes_read == state->size)
+   {
+      settings_t *settings = config_get_ptr();
+      char msg[1024] = {0};
+
+      if (task->title)
+         free(task->title);
+
+      task->title = NULL;
+
+      if (state->autoload)
+      {
+         snprintf(msg, sizeof(msg), "Auto-loading savestate from \"%s\" succeeded.",
+               state->path);
+         runloop_msg_queue_push(msg, 1, 180, true);
+      }
+      else
+      {
+         if (settings->state_slot < 0)
+            snprintf(msg, sizeof(msg), "%s #-1 (auto).",
+                  msg_hash_to_str(MSG_LOADED_STATE_FROM_SLOT));
+         else
+            snprintf(msg, sizeof(msg), "%s #%d.", msg_hash_to_str(MSG_LOADED_STATE_FROM_SLOT),
+                  settings->state_slot);
+
+         runloop_msg_queue_push(msg, 2, 180, true);
+      }
+
+      task_load_handler_finished(task, state);
+
+      return;
+   }
+}
+
+/**
+ * content_load_state_cb:
  * @path      : path that state will be loaded from.
- * @load_to_backup_buffer: If true, the state will be loaded into undo_save_buf.
  * Load a state from disk to memory.
  *
- * Returns: true if successful, false otherwise.
- *
- *
  **/
-bool content_load_state(const char *path, bool load_to_backup_buffer)
+static void content_load_state_cb(void *task_data,
+                           void *user_data, const char *error)
 {
+   load_task_data_t *load_data = (load_task_data_t*)task_data;
    unsigned i;
-   ssize_t size;
+   bool ret;
+   ssize_t size = load_data->size;
    retro_ctx_serialize_info_t serial_info;
    unsigned num_blocks       = 0;
-   void *buf                 = NULL;
+   void *buf                 = load_data->data;
    struct sram_block *blocks = NULL;
-   bool ret                  = filestream_read_file(path, &buf, &size);
    settings_t *settings      = config_get_ptr();
+   char err_buf[1024] = {0};
 
    RARCH_LOG("%s: \"%s\".\n",
          msg_hash_to_str(MSG_LOADING_STATE),
-         path);
+         load_data->path);
 
-   if (!ret || size < 0)
+   if (size < 0 || !buf)
       goto error;
 
    RARCH_LOG("%s: %u %s.\n",
@@ -609,7 +736,7 @@ bool content_load_state(const char *path, bool load_to_backup_buffer)
 
    /* This means we're backing up the file in memory, so content_undo_save_state()
    can restore it */
-   if (load_to_backup_buffer)
+   if (load_data->load_to_backup_buffer)
    {
       /* If we were previously backing up a file, let go of it first */
       if (undo_save_buf.data)
@@ -624,10 +751,11 @@ bool content_load_state(const char *path, bool load_to_backup_buffer)
 
       memcpy(undo_save_buf.data, buf, size);
       undo_save_buf.size = size;
-      strlcpy(undo_save_buf.path, path, sizeof(undo_save_buf.path));
+      strlcpy(undo_save_buf.path, load_data->path, sizeof(undo_save_buf.path));
 
       free(buf);
-      return true;
+      free(load_data);
+      return;
    }
 
    if (settings->block_sram_overwrite && task_save_files
@@ -713,15 +841,238 @@ bool content_load_state(const char *path, bool load_to_backup_buffer)
       goto error;
 
    free(buf);
+   free(load_data);
 
-   return true;
+   return;
 
 error:
+   if (load_data->autoload)
+      snprintf(err_buf, sizeof(err_buf), "Auto-loading savestate from \"%s\" failed.",
+            load_data->path);
+   else
+      snprintf(err_buf, sizeof(err_buf), "%s \"%s\".\n",
+                          msg_hash_to_str(MSG_FAILED_TO_LOAD_STATE),
+                          load_data->path);
+
+   runloop_msg_queue_push(err_buf, 1, 180, true);
+
    RARCH_ERR("%s \"%s\".\n",
          msg_hash_to_str(MSG_FAILED_TO_LOAD_STATE),
-         path);
+         load_data->path);
+   if (buf)
       free(buf);
+   free(load_data);
+   return;
+}
+
+/**
+ * task_push_save_state:
+ * @path : file path of the save state
+ * @data : the save state data to write
+ * @size : the total size of the save state
+ *
+ * Create a new task to save the content state.
+ **/
+static void task_push_save_state(const char *path, void *data, size_t size)
+{
+   retro_task_t *task = (retro_task_t*)calloc(1, sizeof(*task));
+   save_task_state_t *state = (save_task_state_t*)calloc(1, sizeof(*state));
+
+   if (!task || !state)
+   {
+      if (data)
+         free(data);
+      return;
+   }
+
+   strlcpy(state->path, path, sizeof(state->path));
+   state->data = data;
+   state->size = size;
+
+   task->state = state;
+   task->handler = task_save_handler;
+   task->title = strdup(msg_hash_to_str(MSG_SAVING_STATE));
+
+   task_queue_ctl(TASK_QUEUE_CTL_PUSH, task);
+}
+
+/**
+ * content_load_and_save_state_cb:
+ * @path      : path that state will be loaded from.
+ * Load then save a state.
+ *
+ **/
+static void content_load_and_save_state_cb(void *task_data,
+                           void *user_data, const char *error)
+{
+   load_task_data_t *load_data = (load_task_data_t*)task_data;
+   char *path = strdup(load_data->path);
+   void *data = load_data->undo_data;
+   size_t size = load_data->undo_size;
+
+   content_load_state_cb(task_data, user_data, error);
+
+   task_push_save_state(path, data, size);
+
+   free(path);
+}
+
+/**
+ * task_push_load_and_save_state:
+ * @path : file path of the save state
+ * @data : the save state data to write
+ * @size : the total size of the save state
+ * @load_to_backup_buffer : If true, the state will be loaded into undo_save_buf.
+ *
+ * Create a new task to both load and save the content state.
+ **/
+static void task_push_load_and_save_state(const char *path, void *data, size_t size, bool load_to_backup_buffer)
+{
+   retro_task_t *task = (retro_task_t*)calloc(1, sizeof(*task));
+   save_task_state_t *state = (save_task_state_t*)calloc(1, sizeof(*state));
+
+   if (!task || !state)
+   {
+      if (data)
+         free(data);
+      return;
+   }
+
+   strlcpy(state->path, path, sizeof(state->path));
+   state->load_to_backup_buffer = load_to_backup_buffer;
+   state->undo_size = size;
+   state->undo_data = data;
+
+   task->state = state;
+
+   task->handler = task_load_handler;
+   task->callback = content_load_and_save_state_cb;
+   task->title = strdup(msg_hash_to_str(MSG_LOADING_STATE));
+
+   task_queue_ctl(TASK_QUEUE_CTL_PUSH, task);
+}
+
+/**
+ * content_save_state:
+ * @path      : path of saved state that shall be written to.
+ * @save_to_disk: If false, saves the state onto undo_load_buf.
+ * Save a state from memory to disk.
+ *
+ * Returns: true if successful, false otherwise.
+ **/
+bool content_save_state(const char *path, bool save_to_disk)
+{
+   retro_ctx_serialize_info_t serial_info;
+   retro_ctx_size_info_t info;
+   bool ret    = false;
+   void *data  = NULL;
+
+   core_serialize_size(&info);
+
+   RARCH_LOG("%s: \"%s\".\n",
+         msg_hash_to_str(MSG_SAVING_STATE),
+         path);
+
+   if (info.size == 0)
       return false;
+
+   data = malloc(info.size);
+
+   if (!data)
+      return false;
+
+   RARCH_LOG("%s: %d %s.\n",
+         msg_hash_to_str(MSG_STATE_SIZE),
+         (int)info.size,
+         msg_hash_to_str(MSG_BYTES));
+
+   serial_info.data = data;
+   serial_info.size = info.size;
+   ret              = core_serialize(&serial_info);
+
+   if (ret)
+   {
+      if (save_to_disk)
+      {
+         if (path_file_exists(path))
+         {
+            /* Before overwritting the savestate file, load it into a buffer
+            to allow undo_save_state() to work */
+            /* TODO/FIXME - Use msg_hash_to_str here */
+            RARCH_LOG("%s\n",
+               "File already exists. Saving to backup buffer...");
+
+            task_push_load_and_save_state(path, data, info.size, true);
+         }
+         else
+            task_push_save_state(path, data, info.size);
+      }
+      else
+      {
+         /* save_to_disk is false, which means we are saving the state
+         in undo_load_buf to allow content_undo_load_state() to restore it */
+
+         /* If we were holding onto an old state already, clean it up first */
+         if (undo_load_buf.data)
+         {
+            free(undo_load_buf.data);
+            undo_load_buf.data = NULL;
+         }
+
+         undo_load_buf.data = malloc(info.size);
+         if (!undo_load_buf.data)
+         {
+            free(data);
+            return false;
+         }
+
+         memcpy(undo_load_buf.data, data, info.size);
+         free(data);
+         undo_load_buf.size = info.size;
+         strlcpy(undo_load_buf.path, path, sizeof(undo_load_buf.path));
+      }
+   }
+   else
+   {
+      free(data);
+      RARCH_ERR("%s \"%s\".\n",
+            msg_hash_to_str(MSG_FAILED_TO_SAVE_STATE_TO),
+            path);
+   }
+
+   return ret;
+}
+
+/**
+ * content_load_state:
+ * @path      : path that state will be loaded from.
+ * @load_to_backup_buffer: If true, the state will be loaded into undo_save_buf.
+ * Load a state from disk to memory.
+ *
+ * Returns: true if successful, false otherwise.
+ *
+ *
+ **/
+bool content_load_state(const char *path, bool load_to_backup_buffer, bool autoload)
+{
+   retro_task_t *task = (retro_task_t*)calloc(1, sizeof(*task));
+   save_task_state_t *state = (save_task_state_t*)calloc(1, sizeof(*state));
+
+   if (!task || !state)
+      return false;
+
+   strlcpy(state->path, path, sizeof(state->path));
+   state->load_to_backup_buffer = load_to_backup_buffer;
+   state->autoload = autoload;
+
+   task->state = state;
+   task->handler = task_load_handler;
+   task->callback = content_load_state_cb;
+   task->title = strdup(msg_hash_to_str(MSG_LOADING_STATE));
+
+   task_queue_ctl(TASK_QUEUE_CTL_PUSH, task);
+
+   return true;
 }
 
 bool content_rename_state(const char *origin, const char *dest)