vasum-client.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
 *
 *  Contact: Mateusz Malicki <m.malicki2@samsung.com>
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License
 */


#ifndef VASUM_CLIENT_H
#define VASUM_CLIENT_H

#include <stdint.h>
#include <sys/stat.h>
#include <netinet/ip.h>
#include <linux/if_link.h>

#ifdef __cplusplus
extern "C"
{
#endif

typedef void* VsmClient;

typedef char* VsmString;

typedef VsmString* VsmArrayString;

typedef void *VsmAddrList;
typedef enum {
    VSMCLIENT_CUSTOM_ERROR,     
    VSMCLIENT_IO_ERROR,         
    VSMCLIENT_OPERATION_FAILED, 
    VSMCLIENT_INVALID_ARGUMENT, 
    VSMCLIENT_OTHER_ERROR,      
    VSMCLIENT_SUCCESS           
} VsmStatus;

typedef unsigned int VsmSubscriptionId;

typedef enum {
    STOPPED,
    STARTING,
    RUNNING,
    STOPPING,
    ABORTING,
    FREEZING,
    FROZEN,
    THAWED,
    LOCKED,
    MAX_STATE,
    ACTIVATING = 128
} VsmZoneState;

typedef void* VsmZone;

typedef enum {
    VSMNETDEV_VETH,
    VSMNETDEV_PHYS,
    VSMNETDEV_MACVLAN
} VsmNetdevType;

typedef void* VsmNetdev;

typedef enum {
    VSMFILE_DIRECTORY,
    VSMFILE_FIFO,
    VSMFILE_REGULAR
} VsmFileType;

typedef enum {
    VSMDISPATCHER_EXTERNAL,         
    VSMDISPATCHER_INTERNAL          
} VsmDispacherType;

VsmStatus vsm_get_poll_fd(VsmClient client, int* fd);

VsmStatus vsm_enter_eventloop(VsmClient client, int flags, int timeout);

VsmStatus vsm_set_dispatcher_type(VsmClient client, VsmDispacherType dispacher);

VsmStatus vsm_get_dispatcher_type(VsmClient client, VsmDispacherType* dispacher);

VsmClient vsm_client_create();

void vsm_client_free(VsmClient client);

VsmStatus vsm_get_status(VsmClient client);

const char* vsm_get_status_message(VsmClient client);

VsmStatus vsm_connect(VsmClient client);

VsmStatus vsm_connect_custom(VsmClient client, const char* address);

VsmStatus vsm_disconnect(VsmClient client);

void vsm_array_string_free(VsmArrayString astring);

void vsm_string_free(VsmString string);

VsmString vsm_zone_get_id(VsmZone zone);

int vsm_zone_get_terminal(VsmZone zone);

VsmZoneState vsm_zone_get_state(VsmZone zone);

VsmString vsm_zone_get_rootfs(VsmZone zone);

void vsm_zone_free(VsmZone zone);

VsmString vsm_netdev_get_name(VsmNetdev netdev);

VsmNetdevType vsm_netdev_get_type(VsmNetdev netdev);

void vsm_netdev_free(VsmNetdev netdev);

typedef void (*VsmZoneDbusStateCallback)(const char* zoneId,
                                             const char* address,
                                             void* data);

VsmStatus vsm_lock_queue(VsmClient client);

VsmStatus vsm_unlock_queue(VsmClient client);

VsmStatus vsm_get_zone_dbuses(VsmClient client, VsmArrayString* keys, VsmArrayString* values);

VsmStatus vsm_get_zone_ids(VsmClient client, VsmArrayString* array);

VsmStatus vsm_get_active_zone_id(VsmClient client, VsmString* id);

VsmStatus vsm_lookup_zone_by_pid(VsmClient client, int pid, VsmString* id);

VsmStatus vsm_lookup_zone_by_id(VsmClient client, const char* id, VsmZone* zone);

VsmStatus vsm_lookup_zone_by_terminal_id(VsmClient client, int terminal, VsmString* id);

VsmStatus vsm_set_active_zone(VsmClient client, const char* id);

VsmStatus vsm_create_zone(VsmClient client, const char* id, const char* tname);

VsmStatus vsm_destroy_zone(VsmClient client, const char* id, int force);

VsmStatus vsm_shutdown_zone(VsmClient client, const char* id);

VsmStatus vsm_start_zone(VsmClient client, const char* id);

VsmStatus vsm_lock_zone(VsmClient client, const char* id);

VsmStatus vsm_unlock_zone(VsmClient client, const char* id);

VsmStatus vsm_add_state_callback(VsmClient client,
                                 VsmZoneDbusStateCallback zoneDbusStateCallback,
                                 void* data,
                                 VsmSubscriptionId* subscriptionId);

VsmStatus vsm_del_state_callback(VsmClient client, VsmSubscriptionId subscriptionId);

VsmStatus vsm_grant_device(VsmClient client,
                           const char* zone,
                           const char* device,
                           uint32_t flags);

VsmStatus vsm_revoke_device(VsmClient client, const char* zone, const char* device);

VsmStatus vsm_zone_get_netdevs(VsmClient client, const char* zone, VsmArrayString* netdevIds);


VsmStatus vsm_netdev_get_ip_addr(VsmClient client,
                                 const char* zone,
                                 const char* netdevId,
                                 VsmAddrList *addrs);

void vsm_addrlist_free(VsmAddrList addrs);

VsmStatus vsm_netdev_get_ipv4_addr(VsmClient client,
                                   const char* zone,
                                   const char* netdevId,
                                   struct in_addr *addr);

VsmStatus vsm_netdev_get_ipv6_addr(VsmClient client,
                                   const char* zone,
                                   const char* netdevId,
                                   struct in6_addr *addr);

VsmStatus vsm_netdev_add_ipv4_addr(VsmClient client,
                                   const char* zone,
                                   const char* netdevId,
                                   struct in_addr *addr,
                                   int prefix);

VsmStatus vsm_netdev_add_ipv6_addr(VsmClient client,
                                   const char* zone,
                                   const char* netdevId,
                                   struct in6_addr *addr,
                                   int prefix);

VsmStatus vsm_netdev_del_ipv4_addr(VsmClient client,
                                   const char* zone,
                                   const char* netdevId,
                                   struct in_addr* addr,
                                   int prefix);

VsmStatus vsm_netdev_del_ipv6_addr(VsmClient client,
                                   const char* zone,
                                   const char* netdevId,
                                   struct in6_addr* addr,
                                   int prefix);

VsmStatus vsm_netdev_up(VsmClient client,
                        const char* zone,
                        const char* netdevId);

VsmStatus vsm_netdev_down(VsmClient client,
                          const char* zone,
                          const char* netdevId);


VsmStatus vsm_create_netdev_veth(VsmClient client,
                                 const char* zone,
                                 const char* zoneDev,
                                 const char* hostDev);
VsmStatus vsm_create_netdev_macvlan(VsmClient client,
                                    const char* zone,
                                    const char* zoneDev,
                                    const char* hostDev,
                                    enum macvlan_mode mode);
VsmStatus vsm_create_netdev_phys(VsmClient client, const char* zone, const char* devId);

VsmStatus vsm_lookup_netdev_by_name(VsmClient client,
                                    const char* zone,
                                    const char* netdevId,
                                    VsmNetdev* netdev);

VsmStatus vsm_destroy_netdev(VsmClient client, const char* zone, const char* devId);

VsmStatus vsm_declare_file(VsmClient client,
                           const char* zone,
                           VsmFileType type,
                           const char* path,
                           int32_t flags,
                           mode_t mode);

VsmStatus vsm_declare_mount(VsmClient client,
                            const char* source,
                            const char* zone,
                            const char* target,
                            const char* type,
                            uint64_t flags,
                            const char* data);

VsmStatus vsm_declare_link(VsmClient client,
                           const char *source,
                           const char* zone,
                           const char *target);

VsmStatus vsm_list_declarations(VsmClient client,
                                const char* zone,
                                VsmArrayString* declarations);

VsmStatus vsm_remove_declaration(VsmClient client,
                                 const char* zone,
                                 VsmString declaration);

VsmStatus vsm_clean_up_zones_root(VsmClient client);

unsigned int vsm_addrlist_size(VsmAddrList addrs);

int vsm_addrlist_get_type(VsmAddrList addrs, unsigned int i);

const void *vsm_addrlist_get_addr(VsmAddrList addrs, unsigned int i);

unsigned int vsm_addrlist_get_prefix(VsmAddrList addrs, unsigned int i);

#ifdef __cplusplus
}
#endif

#endif /* VASUM_CLIENT_H */