iSulad/src/image/oci/isula_image.c

/******************************************************************************
* Copyright (c) Huawei Technologies Co., Ltd. 2019. All rights reserved.
 * iSulad licensed under the Mulan PSL v1.
 * You can use this software according to the terms and conditions of the Mulan PSL v1.
 * You may obtain a copy of Mulan PSL v1 at:
 *     http://license.coscl.org.cn/MulanPSL
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR
 * PURPOSE.
 * See the Mulan PSL v1 for more details.
* Author: liuhao
* Create: 2019-07-15
* Description: provide isula image operator definition
*******************************************************************************/
#include "isula_image.h"

#include <pthread.h>
#include <semaphore.h>

#include "log.h"
#include "run_image_server.h"
#include "isula_image_connect.h"
#include "isula_image_pull.h"
#include "isula_rootfs_prepare.h"
#include "isula_rootfs_remove.h"
#include "isula_rootfs_mount.h"
#include "isula_rootfs_umount.h"
#include "isula_image_rmi.h"
#include "isula_container_fs_usage.h"
#include "isula_image_fs_info.h"
#include "isula_storage_status.h"
#include "isula_image_load.h"
#include "isula_container_export.h"
#include "isula_login.h"
#include "isula_logout.h"
#include "isula_health_check.h"
#include "isula_images_list.h"
#include "isula_containers_list.h"

#include "containers_store.h"
#include "oci_images_store.h"

#include "isulad_config.h"
#include "utils.h"

#define IMAGE_NOT_KNOWN_ERR "image not known"
#define ISULA_IMAGE_SERVER_DEFAULT_SOCK "/var/run/isula_image.sock"

pthread_t g_monitor_thread;

void isula_exit(void)
{
    int nret;

    isula_img_exit();
    nret = pthread_cancel(g_monitor_thread);
    if (nret != 0) {
        SYSERROR("Cancel isula monitor thread failed");
    }
}

static int start_isula_image_server(void)
{
#define MIN_OPT_TIMEOUT 15
    struct server_monitor_conf sm_conf = { 0 };
    struct timespec ts = { 0 };
    sem_t wait_monitor_sem;
    unsigned int im_opt_timeout = conf_get_im_opt_timeout();
    int ret = 0;

    im_opt_timeout = im_opt_timeout >= MIN_OPT_TIMEOUT ? im_opt_timeout : MIN_OPT_TIMEOUT;

    // check whether isulad-img is running by systemd
    if (util_file_exists(ISULA_IMAGE_SERVER_DEFAULT_SOCK)) {
        if (!conf_update_im_server_sock_addr(ISULA_IMAGE_SERVER_DEFAULT_SOCK)) {
            ERROR("Update image socket address failed");
            return -1;
        }
        return 0;
    }

    if (sem_init(&wait_monitor_sem, 0, 0) != 0) {
        ERROR("Semaphore init failed");
        ret = -1;
        goto out;
    }
    sm_conf.wait_ok = &wait_monitor_sem;

    ret = pthread_create(&g_monitor_thread, NULL, isula_image_server_monitor, (void *)(&sm_conf));
    if (ret != 0) {
        ERROR("Create isula image monitor thread failed: %s", strerror(ret));
        goto out;
    }

    if (clock_gettime(CLOCK_REALTIME, &ts) == -1) {
        SYSERROR("Get real time failed");
        ret = -1;
        goto out;
    }
    ts.tv_sec += (time_t)im_opt_timeout; // set deadline

    ret = sem_timedwait(&wait_monitor_sem, &ts);
    if (ret != 0) {
        SYSERROR("Image Server Start failed");
        goto out;
    }
    INFO("Image Server is Running...");

out:
    sem_destroy(&wait_monitor_sem);
    return ret;
}

/*
 * start isula image grpc server
 * */
int isula_init(const struct im_configs *conf)
{
    int ret = -1;

    if (conf == NULL) {
        ERROR("Invalid image config");
        return ret;
    }

    /* init grpc client */
    ret = isula_image_ops_init();
    if (ret != 0) {
        ERROR("Init grpc client for isula image server failed");
        goto out;
    }

    ret = start_isula_image_server();
    if (ret != 0) {
        goto out;
    }

    ret = oci_image_store_init();
out:
    return ret;
}

int isula_pull_rf(const im_pull_request *request, im_pull_response **response)
{
    return isula_pull_image(request, response);
}

int isula_prepare_rf(const im_prepare_request *request, char **real_rootfs)
{
    if (request == NULL) {
        ERROR("Bim is NULL");
        return -1;
    }

    return isula_rootfs_prepare_and_get_image_conf(request->container_id, request->image_name, request->storage_opt,
                                                   real_rootfs, NULL);
}

int isula_merge_conf_rf(const host_config *host_spec, container_config *container_spec,
                        const im_prepare_request *request, char **real_rootfs)
{
    oci_image_spec *image = NULL;
    int ret = -1;

    if (request == NULL) {
        ERROR("Bim is NULL");
        return -1;
    }

    ret = isula_rootfs_prepare_and_get_image_conf(request->container_id, request->image_name, host_spec->storage_opt,
                                                  real_rootfs, &image);
    if (ret != 0) {
        ERROR("Get prepare rootfs failed of image: %s", request->image_name);
        goto out;
    }
    ret = oci_image_conf_merge_into_spec(request->image_name, container_spec);
    if (ret != 0) {
        ERROR("Failed to merge oci config for image: %s", request->image_name);
        goto out;
    }

out:
    free_oci_image_spec(image);
    return ret;
}

int isula_delete_rf(const im_delete_request *request)
{
    if (request == NULL) {
        ERROR("Request is NULL");
        return -1;
    }
    return isula_rootfs_remove(request->name_id);
}

int isula_mount_rf(const im_mount_request *request)
{
    if (request == NULL) {
        ERROR("Invalid arguments");
        return -1;
    }
    return isula_rootfs_mount(request->name_id);
}

int isula_umount_rf(const im_umount_request *request)
{
    if (request == NULL) {
        ERROR("Invalid arguments");
        return -1;
    }

    return isula_rootfs_umount(request->name_id, request->force);
}

int isula_rmi(const im_remove_request *request)
{
    int ret = -1;
    char *real_image_name = NULL;
    oci_image_t *image_info = NULL;
    char *errmsg = NULL;

    if (request == NULL || request->image.image == NULL) {
        ERROR("Invalid input arguments");
        return -1;
    }

    real_image_name = oci_resolve_image_name(request->image.image);
    if (real_image_name == NULL) {
        ERROR("Failed to resolve image name");
        goto out;
    }
    image_info = oci_images_store_get(real_image_name);
    if (image_info == NULL) {
        INFO("No such image exist %s", real_image_name);
        ret = 0;
        goto out;
    }
    oci_image_lock(image_info);

    ret = isula_image_rmi(real_image_name, request->force, &errmsg);
    if (ret != 0) {
        if (strstr(errmsg, IMAGE_NOT_KNOWN_ERR) != NULL) {
            DEBUG("Image %s may already removed", real_image_name);
            ret = 0;
            goto clean_memory;
        }
        isulad_set_error_message("Failed to remove image with error: %s", errmsg);
        ERROR("Failed to remove image '%s' with error: %s", real_image_name, errmsg);
        goto unlock;
    }

clean_memory:
    ret = remove_oci_image_from_memory(real_image_name);
    if (ret != 0) {
        ERROR("Failed to remove image %s from memory", real_image_name);
    }
unlock:
    oci_image_unlock(image_info);
out:
    oci_image_unref(image_info);
    free(real_image_name);
    free(errmsg);
    return ret;
}

int isula_container_filesystem_usage(const im_container_fs_usage_request *request, imagetool_fs_info **fs_usage)
{
    int ret = 0;
    char *output = NULL;
    parser_error err = NULL;

    if (request == NULL || fs_usage == NULL) {
        ERROR("Invalid input arguments");
        return -1;
    }

    ret = isula_container_fs_usage(request->name_id, &output);
    if (ret != 0) {
        ERROR("Failed to inspect container filesystem info");
        goto out;
    }

    *fs_usage = imagetool_fs_info_parse_data(output, NULL, &err);
    if (*fs_usage == NULL) {
        ERROR("Failed to parse output json: %s", err);
        isulad_set_error_message("Failed to parse output json:%s", err);
        ret = -1;
    }

out:
    free(output);
    return ret;
}

int isula_get_filesystem_info(im_fs_info_response **response)
{
    int ret = -1;

    if (response == NULL) {
        ERROR("Invalid input arguments");
        return -1;
    }

    *response = (im_fs_info_response *)util_common_calloc_s(sizeof(im_fs_info_response));
    if (*response == NULL) {
        ERROR("Out of memory");
        return -1;
    }
    ret = isula_image_fs_info(*response);
    if (ret != 0) {
        ERROR("Failed to inspect image filesystem info");
        goto err_out;
    }

    return 0;
err_out:
    free_im_fs_info_response(*response);
    *response = NULL;
    return -1;
}

int isula_get_storage_status(im_storage_status_response **response)
{
    int ret = -1;

    if (response == NULL) {
        ERROR("Invalid input arguments");
        return ret;
    }

    *response = (im_storage_status_response *)util_common_calloc_s(sizeof(im_storage_status_response));
    if (*response == NULL) {
        ERROR("Out of memory");
        return ret;
    }

    ret = isula_do_storage_status(*response);
    if (ret != 0) {
        ERROR("Get get storage status failed");
        ret = -1;
        goto err_out;
    }

    return 0;
err_out:
    free_im_storage_status_response(*response);
    *response = NULL;
    return ret;
}

int isual_load_image(const im_load_request *request)
{
    char **refs = NULL;
    int ret = 0;
    int ret2 = 0;
    size_t i = 0;

    if (request == NULL) {
        ERROR("Invalid input arguments");
        return -1;
    }

    ret = isula_image_load(request->file, request->tag, &refs);
    if (ret != 0) {
        ERROR("Failed to load image");
        goto out;
    }

out:
    // If some of images are loaded, registery it.
    for (i = 0; i < util_array_len((const char **)refs); i++) {
        ret2 = register_new_oci_image_into_memory(refs[i]);
        if (ret2 != 0) {
            ERROR("Failed to register new image %s to images store", refs[i]);
            ret = -1;
            break;
        }
    }

    util_free_array(refs);
    refs = NULL;
    return ret;
}

int isula_export_rf(const im_export_request *request)
{
    int ret = 0;

    if (request == NULL) {
        ERROR("Invalid input arguments");
        return -1;
    }

    ret = isula_container_export(request->name_id, request->file, 0, 0, 0);
    if (ret != 0) {
        ERROR("Failed to export container: %s", request->name_id);
    }

    return ret;
}

int isula_login(const im_login_request *request)
{
    int ret = 0;

    if (request == NULL) {
        ERROR("Invalid input arguments");
        return -1;
    }

    ret = isula_do_login(request->server, request->username, request->password);
    if (ret != 0) {
        ERROR("Login failed");
    }

    return ret;
}

int isula_logout(const im_logout_request *request)
{
    int ret = 0;

    if (request == NULL) {
        ERROR("Invalid input arguments");
        return -1;
    }

    ret = isula_do_logout(request->server);
    if (ret != 0) {
        ERROR("Logout failed");
    }

    return ret;
}

int isula_health_check(void)
{
    return isula_do_health_check();
}

int isula_sync_images(void)
{
    int ret = 0;
    size_t i = 0;
    im_list_request *im_request = NULL;
    imagetool_images_list *image_list = NULL;
    oci_image_t *oci_image = NULL;
    char *errmsg = NULL;

    im_request = (im_list_request *)util_common_calloc_s(sizeof(im_list_request));
    if (im_request == NULL) {
        ERROR("Out of memory");
        ret = -1;
        goto out;
    }

    ret = isula_list_images(im_request, &image_list);
    if (ret != 0) {
        ERROR("Get remote images list failed");
        goto out;
    }

    for (i = 0; i < image_list->images_len; i++) {
        oci_image = oci_images_store_get((image_list->images[i])->id);
        if (oci_image != NULL) {
            continue;
        }
        WARN("Cleanup surplus image: %s in remote", (image_list->images[i])->id);
        ret = isula_image_rmi((image_list->images[i])->id, true, &errmsg);
        if (ret != 0) {
            WARN("Remove image: %s failed: %s", (image_list->images[i])->id, errmsg);
        }
        free(errmsg);
        errmsg = NULL;
        oci_image_unref(oci_image);
    }

    ret = 0;
out:
    free_im_list_request(im_request);
    free_imagetool_images_list(image_list);
    return ret;
}

static inline void cleanup_container_rootfs(const char *name_id, bool mounted)
{
    if (mounted && isula_rootfs_umount(name_id, true) != 0) {
        WARN("Remove rootfs: %s failed", name_id);
    }

    if (isula_rootfs_remove(name_id) != 0) {
        WARN("Remove rootfs: %s failed", name_id);
    }
}

int isula_sync_containers(void)
{
    int ret = 0;
    size_t i = 0;
    json_map_string_bool *remote_containers_list = NULL;
    container_t *cont = NULL;

    ret = isula_list_containers(&remote_containers_list);
    if (ret != 0) {
        ERROR("Get remote containers list failed");
        goto out;
    }

    if (remote_containers_list == NULL) {
        goto out;
    }

    for (i = 0; i < remote_containers_list->len; i++) {
        cont = containers_store_get(remote_containers_list->keys[i]);
        // cannot found container in local map, then unmount and remove remote rootfs
        if (cont == NULL) {
            WARN("Cleanup surplus container: %s in remote", remote_containers_list->keys[i]);
            cleanup_container_rootfs(remote_containers_list->keys[i], remote_containers_list->values[i]);
            continue;
        }

        // local container is stopped, but remote container is mounted. So unmount it.
        if (!is_running(cont->state) && remote_containers_list->values[i]) {
            WARN("Unmount unstarted container: %s", remote_containers_list->keys[i]);
            ret = isula_rootfs_umount(remote_containers_list->keys[i], true);
            if (ret != 0) {
                WARN("Unmount rootfs: %s failed", remote_containers_list->keys[i]);
            }
        }
        container_unref(cont);
    }

    ret = 0;
out:
    free_json_map_string_bool(remote_containers_list);
    return ret;
}