docker_system.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) 2018-2022 Abhishek Mishra
 *
 * This file is part of clibdocker.
 *
 * clibdocker is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation, 
 * either version 3 of the License, or (at your option) 
 * any later version.
 *
 * clibdocker is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty 
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 * See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public 
 * License along with clibdocker. 
 * If not, see <https://www.gnu.org/licenses/>.
 *
 */
 
#ifndef SRC_DOCKER_SYSTEM_H_
#define SRC_DOCKER_SYSTEM_H_
 
#ifdef __cplusplus  
extern "C" {
#endif
 
//TODO: specific API headers should not include docker_all
#include "docker_all.h"
 
#include <json-c/json_object.h>
 
MODULE_API d_err_t docker_ping(docker_context* ctx);
 
typedef json_object                                 docker_version;
 
#define free_docker_version(version)                json_object_put((json_object*) version)
 
#define docker_version_version_get(version)         get_attr_str((json_object*)version, "Version")
 
#define docker_version_os_get(version)              get_attr_str((json_object*)version, "Os")
 
#define docker_version_kernel_version_get(version)  get_attr_str((json_object*)version, "KernelVersion")
 
#define docker_version_go_version_get(version)      get_attr_str((json_object*)version, "GoVersion")
 
#define docker_version_git_commit_get(version)      get_attr_str((json_object*)version, "GitCommit")
 
#define docker_version_arch_get(version)            get_attr_str((json_object*)version, "Arch")
 
#define docker_version_api_version_get(version)     get_attr_str((json_object*)version, "ApiVersion")
 
#define docker_version_min_api_version_get(version) get_attr_str((json_object*)version, "MinAPIVersion")
 
#define docker_version_build_time_get(version)      get_attr_str((json_object*)version, "BuildTime")
 
#define docker_version_experimental_get(version)    get_attr_boolean((json_object*)version, "Experimental")
 
MODULE_API d_err_t docker_system_version(docker_context* ctx,
        docker_version** version);
 
typedef json_object                                 docker_info;
 
#define free_docker_info(info)                      json_object_put((json_object*) info)
 
#define docker_info_containers_get(info)            get_attr_unsigned_long((json_object*)info, "Containers")
 
#define docker_info_containers_running_get(info)    get_attr_unsigned_long((json_object*)info, "ContainersRunning")
 
#define docker_info_containers_paused_get(info)     get_attr_unsigned_long((json_object*)info, "ContainersPaused")
 
#define docker_info_containers_stopped_get(info)    get_attr_unsigned_long((json_object*)info, "ContainersStopped")
 
#define docker_info_images_get(info)                get_attr_unsigned_long((json_object*)info, "Images")
 
#define docker_info_name_get(info)                  get_attr_str((json_object*)info, "Name")
 
#define docker_info_ncpu_get(info)                  get_attr_int((json_object*)info, "NCPU")
 
#define docker_info_mem_total_get(info)             get_attr_unsigned_long((json_object*)info, "MemTotal")
 
MODULE_API d_err_t docker_system_info(docker_context* ctx,
        docker_info** info);
 
// Docker System Events API
 
typedef arraylist                                   docker_event_list;
 
#define free_docker_event_list(event_ls)            arraylist_free(event_ls)
 
#define docker_event_list_length(event_ls)          arraylist_length(event_ls)
 
#define docker_event_list_get_idx(event_ls, i)      arraylist_get(event_ls, i)
 
typedef json_object                                 docker_event;
 
#define free_docker_event(event)                    json_object_put((json_object*) event)
 
#define docker_event_type_get(event)                get_attr_str((json_object*)event, "Type")
 
#define docker_event_action_get(event)              get_attr_str((json_object*)event, "Action")
 
#define docker_event_time_get(event)                get_attr_unsigned_long((json_object*)event, "time")
 
#define docker_event_actor_id_get(event)            get_attr_str(get_attr_json_object((json_object*)event, "Actor"), "ID")
 
 
#define docker_event_attributes_get(event)          get_attr_json_object(get_attr_json_object((json_object*)event, "Actor"), "Attributes")
 
#define docker_event_attributes_foreach(event)      json_object_object_foreach(docker_event_attributes_get(event), key, val)
 
MODULE_API d_err_t docker_system_events(docker_context* ctx,
        arraylist** events, time_t start_time, time_t end_time);
 
MODULE_API d_err_t docker_system_events_cb(docker_context* ctx,
        void (*docker_events_cb)(docker_event* evt, void* cbargs), void* cbargs,
        arraylist** events, time_t start_time, time_t end_time);
 
//Docker df
 
typedef json_object                                     docker_df;
 
typedef json_object                                     docker_df_image;
 
typedef json_object                                     docker_df_container;
 
typedef json_object                                     docker_df_volume;
 
typedef json_object                                     docker_df_volume_usage_data;
 
#define docker_df_image_id_get(img)                     get_attr_str((json_object*)img, "Id")
 
#define docker_df_image_parent_id_get(img)              get_attr_str((json_object*)img, "ParentId")
 
#define docker_df_image_created_get(img)                get_attr_unsigned_long((json_object*)img, "Created")
 
#define docker_df_image_size_get(img)                   get_attr_unsigned_long((json_object*)img, "Size")
 
#define docker_df_image_shared_size_get(img)            get_attr_unsigned_long((json_object*)img, "SharedSize")
 
#define docker_df_image_virtual_size_get(img)           get_attr_unsigned_long((json_object*)img, "VirtualSize")
 
#define docker_df_image_containers_get(img)             get_attr_unsigned_long((json_object*)img, "Containers")
 
#define docker_df_image_repo_tags_get(img)              get_attr_json_object((json_object*)img, "RepoTags")
 
#define docker_df_image_repo_tags_length(img)           json_object_array_length(docker_df_image_repo_tags_get(img))
 
#define docker_df_image_repo_tags_get_idx(img, i)       (const char*)json_object_array_get_idx(docker_df_image_repo_tags_get(img), i)
 
#define docker_df_image_repo_digests_get(img)           get_attr_json_object((json_object*)img, "RepoDigests")
 
#define docker_df_image_repo_digests_length(img)        json_object_array_length(docker_df_image_repo_digests_get(img))
 
#define docker_df_image_repo_digests_get_idx(img, i)    (const char*)json_object_array_get_idx(docker_df_image_repo_digests_get(img), i)
 
#define docker_df_container_id_get(ctr)                 get_attr_str((json_object*)ctr, "Id")
 
#define docker_df_container_image_get(ctr)              get_attr_str((json_object*)ctr, "Image")
 
#define docker_df_container_image_id_get(ctr)           get_attr_str((json_object*)ctr, "ImageID")
 
#define docker_df_container_command_get(ctr)            get_attr_str((json_object*)ctr, "Command")
 
#define docker_df_container_created_get(ctr)            get_attr_unsigned_long((json_object*)ctr, "Created")
 
#define docker_df_container_size_rootfs_get(ctr)        get_attr_unsigned_long((json_object*)ctr, "SizeRootFs")
 
#define docker_df_container_state_get(ctr)              get_attr_str((json_object*)ctr, "State")
 
#define docker_df_container_status_get(ctr)             get_attr_str((json_object*)ctr, "Status")
 
#define docker_df_volume_name_get(vol)                  get_attr_str((json_object*)vol, "Name")
 
#define docker_df_volume_driver_get(vol)                get_attr_str((json_object*)vol, "Driver")
 
#define docker_df_volume_mountpoint_get(vol)            get_attr_str((json_object*)vol, "Mountpoint")
 
#define docker_df_volume_scope_get(vol)                 get_attr_str((json_object*)vol, "Scope")
 
#define docker_df_volume_usage_data_get(vol)            (docker_df_volume_usage_data*)get_attr_json_object((json_object*)vol, "UsageData")
 
#define docker_df_volume_usage_data_size_get(ud)        get_attr_unsigned_long((json_object*)ud, "Size")
 
#define docker_df_volume_usage_data_ref_count_get(ud)   get_attr_unsigned_long((json_object*)ud, "RefCount")
 
#define docker_df_container_names_get(ctr)              get_attr_json_object((json_object*)ctr, "Names")
 
#define docker_df_container_names_length(ctr)           json_object_array_length(docker_df_container_names_get(ctr))
 
#define docker_df_container_names_get_idx(ctr, i)       (const char*)json_object_array_get_idx(docker_df_container_names_get(ctr), i)
 
#define docker_df_container_mounts_get(ctr)             get_attr_json_object((json_object*)ctr, "Mounts")
 
#define docker_df_container_mounts_length(ctr)          json_object_array_length(docker_df_container_mounts_get(ctr))
 
#define docker_df_container_mounts_get_idx(ctr, i)      (const char*)json_object_array_get_idx(docker_df_container_mounts_get(ctr), i)
 
#define free_docker_df(df)                              json_object_put((json_object*) df)
 
#define docker_df_layers_size_get(df)                   get_attr_unsigned_long((json_object*)df, "LayersSize")
 
#define docker_df_images_get(df)                        get_attr_json_object((json_object*)df, "Images")
 
#define docker_df_images_length(df)                     json_object_array_length(docker_df_images_get(df))
 
#define docker_df_images_get_idx(df, i)                 (docker_df_image*)json_object_array_get_idx(docker_df_images_get(df), i)
 
#define docker_df_containers_get(df)                    get_attr_json_object((json_object*)df, "Containers")
 
#define docker_df_containers_length(df)                 json_object_array_length(docker_df_containers_get(df))
 
#define docker_df_containers_get_idx(df, i)             (docker_df_container*)json_object_array_get_idx(docker_df_containers_get(df), i)
 
#define docker_df_volumes_get(df)                       get_attr_json_object((json_object*)df, "Volumes")
 
#define docker_df_volumes_length(df)                    json_object_array_length(docker_df_volumes_get(df))
 
#define docker_df_volumes_get_idx(df, i)                (docker_df_volume*)json_object_array_get_idx(docker_df_volumes_get(df), i)
 
MODULE_API d_err_t docker_system_df(docker_context* ctx, docker_df** df);
 
#ifdef __cplusplus 
}
#endif
 
#endif /* SRC_DOCKER_SYSTEM_H_ */