boot.h File Reference

#include "client_credentials.hpp"
#include "es_common.h"
#include "porting.h"
#include "storage_common.h"
#include <stdio.h>

Include dependency graph for boot.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	boot_db_path_info
struct	boot_server_credential

Macros
#define	BOOT_NORMAL_CLIENT_TYPE(client_type)
#define	BOOT_READ_ONLY_CLIENT_TYPE(client_type)
#define	BOOT_ADMIN_CLIENT_TYPE(client_type)
#define	BOOT_LOG_REPLICATOR_TYPE(client_type)
#define	BOOT_CSQL_CLIENT_TYPE(client_type)
#define	BOOT_BROKER_AND_DEFAULT_CLIENT_TYPE(client_type)
#define	BOOT_REPLICA_ONLY_BROKER_CLIENT_TYPE(client_type)
#define	BOOT_WRITE_ON_STANDY_CLIENT_TYPE(client_type)
#define	BOOT_IS_ALLOWED_CLIENT_TYPE_IN_MT_MODE(host1, host2, client_type)
#define	BOOT_IS_PREFERRED_HOSTS_SET(credential)
#define	HA_SERVER_STATE_IDLE_STR   "idle"
#define	HA_SERVER_STATE_ACTIVE_STR   "active"
#define	HA_SERVER_STATE_TO_BE_ACTIVE_STR   "to-be-active"
#define	HA_SERVER_STATE_STANDBY_STR   "standby"
#define	HA_SERVER_STATE_TO_BE_STANDBY_STR   "to-be-standby"
#define	HA_SERVER_STATE_MAINTENANCE_STR   "maintenance"
#define	HA_SERVER_STATE_DEAD_STR   "dead"
#define	LOB_PATH_PREFIX_MAX   ES_URI_PREFIX_MAX
#define	LOB_PATH_DEFAULT_PREFIX   ES_POSIX_PATH_PREFIX

Typedefs
typedef struct boot_db_path_info	BOOT_DB_PATH_INFO
typedef enum ha_server_state	HA_SERVER_STATE
typedef struct boot_server_credential	BOOT_SERVER_CREDENTIAL

Enumerations
enum	ha_server_state {   HA_SERVER_STATE_NA = -1, HA_SERVER_STATE_IDLE = 0, HA_SERVER_STATE_ACTIVE = 1, HA_SERVER_STATE_TO_BE_ACTIVE = 2,   HA_SERVER_STATE_STANDBY = 3, HA_SERVER_STATE_TO_BE_STANDBY = 4, HA_SERVER_STATE_MAINTENANCE = 5, HA_SERVER_STATE_DEAD = 6 }

Functions
void	COMPOSE_FULL_NAME (char *buf, size_t buf_size, const char *path, const char *name)

Variables
char	boot_Host_name [CUB_MAXHOSTNAMELEN]

Macro Definition Documentation

#define BOOT_ADMIN_CLIENT_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_ADMIN_UTILITY \
         || (client_type) == DB_CLIENT_TYPE_ADMIN_COMPACTDB_WOS \
         || (client_type) == DB_CLIENT_TYPE_ADMIN_CSQL \
         || (client_type) == DB_CLIENT_TYPE_ADMIN_CSQL_WOS \
         || (client_type) == DB_CLIENT_TYPE_SKIP_VACUUM_ADMIN_CSQL)

Definition at line 50 of file boot.h.

Referenced by boot_restart_client(), and css_is_admin_client().

#define BOOT_BROKER_AND_DEFAULT_CLIENT_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_DEFAULT \
         || (client_type) == DB_CLIENT_TYPE_BROKER \
         || (client_type) == DB_CLIENT_TYPE_READ_ONLY_BROKER \
         || (client_type) == DB_CLIENT_TYPE_SLAVE_ONLY_BROKER \
         || BOOT_REPLICA_ONLY_BROKER_CLIENT_TYPE(client_type))

Definition at line 69 of file boot.h.

Referenced by boot_restart_client(), and xtran_lock_rep_read().

#define BOOT_CSQL_CLIENT_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_CSQL \
        || (client_type) == DB_CLIENT_TYPE_READ_ONLY_CSQL \
        || (client_type) == DB_CLIENT_TYPE_SKIP_VACUUM_CSQL \
        || (client_type) == DB_CLIENT_TYPE_SKIP_VACUUM_ADMIN_CSQL \
        || (client_type) == DB_CLIENT_TYPE_ADMIN_CSQL \
        || (client_type) == DB_CLIENT_TYPE_ADMIN_CSQL_WOS)

Definition at line 61 of file boot.h.

Referenced by boot_restart_client(), and xtran_lock_rep_read().

#define BOOT_IS_ALLOWED_CLIENT_TYPE_IN_MT_MODE	(		host1,
			host2,
			client_type
	)

Value:

((BOOT_BROKER_AND_DEFAULT_CLIENT_TYPE(client_type) || \
          ((host1 != NULL && strcmp (host1, host2)) && \
           (BOOT_CSQL_CLIENT_TYPE(client_type) \
            || BOOT_BROKER_AND_DEFAULT_CLIENT_TYPE(client_type)))) ? 0 : 1)

Definition at line 91 of file boot.h.

Referenced by check_server_capabilities(), css_change_ha_server_state(), logtb_count_not_allowed_clients_in_maintenance_mode(), and xtran_lock_rep_read().

#define BOOT_IS_PREFERRED_HOSTS_SET

(

credential

)

Value:

((credential)->preferred_hosts != NULL \
        && (credential)->preferred_hosts[0] != '\0')

Definition at line 97 of file boot.h.

Referenced by boot_restart_client().

#define BOOT_LOG_REPLICATOR_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_LOG_COPIER \
         || (client_type) == DB_CLIENT_TYPE_LOG_APPLIER)

Definition at line 57 of file boot.h.

Referenced by boot_restart_client(), and css_is_ha_client().

#define BOOT_NORMAL_CLIENT_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_DEFAULT \
         || (client_type) == DB_CLIENT_TYPE_CSQL \
         || (client_type) == DB_CLIENT_TYPE_READ_ONLY_CSQL \
         || (client_type) == DB_CLIENT_TYPE_SKIP_VACUUM_CSQL \
         || (client_type) == DB_CLIENT_TYPE_BROKER \
         || (client_type) == DB_CLIENT_TYPE_READ_ONLY_BROKER \
         || (client_type) == DB_CLIENT_TYPE_RW_BROKER_REPLICA_ONLY \
         || (client_type) == DB_CLIENT_TYPE_RO_BROKER_REPLICA_ONLY)

Definition at line 33 of file boot.h.

Referenced by boot_restart_client(), logtb_count_clients(), xboot_register_client(), xboot_unregister_client(), and xtran_lock_rep_read().

#define BOOT_READ_ONLY_CLIENT_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_READ_ONLY_CSQL \
         || (client_type) == DB_CLIENT_TYPE_READ_ONLY_BROKER \
         || (client_type) == DB_CLIENT_TYPE_SLAVE_ONLY_BROKER \
         || (client_type) == DB_CLIENT_TYPE_RO_BROKER_REPLICA_ONLY \
         || (client_type) == DB_CLIENT_TYPE_SO_BROKER_REPLICA_ONLY)

Definition at line 43 of file boot.h.

Referenced by boot_restart_client().

#define BOOT_REPLICA_ONLY_BROKER_CLIENT_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_RW_BROKER_REPLICA_ONLY \
        || (client_type) == DB_CLIENT_TYPE_RO_BROKER_REPLICA_ONLY \
        || (client_type) == DB_CLIENT_TYPE_SO_BROKER_REPLICA_ONLY)

Definition at line 76 of file boot.h.

Referenced by boot_restart_client(), and check_server_capabilities().

#define BOOT_WRITE_ON_STANDY_CLIENT_TYPE

(

client_type

)

Value:

((client_type) == DB_CLIENT_TYPE_LOG_APPLIER \
      || (client_type) == DB_CLIENT_TYPE_RW_BROKER_REPLICA_ONLY \
      || (client_type) == DB_CLIENT_TYPE_ADMIN_CSQL_WOS \
      || (client_type) == DB_CLIENT_TYPE_ADMIN_COMPACTDB_WOS)

Definition at line 81 of file boot.h.

Referenced by logtb_clear_tdes().

#define HA_SERVER_STATE_ACTIVE_STR   "active"

Definition at line 128 of file boot.h.

Referenced by changemode_keyword(), css_ha_server_state_string(), and sysprm_final().

#define HA_SERVER_STATE_DEAD_STR   "dead"

Definition at line 133 of file boot.h.

Referenced by changemode_keyword(), and css_ha_server_state_string().

#define HA_SERVER_STATE_IDLE_STR   "idle"

Definition at line 127 of file boot.h.

Referenced by changemode_keyword(), and css_ha_server_state_string().

#define HA_SERVER_STATE_MAINTENANCE_STR   "maintenance"

Definition at line 132 of file boot.h.

Referenced by changemode_keyword(), and css_ha_server_state_string().

#define HA_SERVER_STATE_STANDBY_STR   "standby"

Definition at line 130 of file boot.h.

Referenced by changemode_keyword(), css_ha_server_state_string(), and sysprm_final().

#define HA_SERVER_STATE_TO_BE_ACTIVE_STR   "to-be-active"

Definition at line 129 of file boot.h.

Referenced by changemode_keyword(), and css_ha_server_state_string().

#define HA_SERVER_STATE_TO_BE_STANDBY_STR   "to-be-standby"

Definition at line 131 of file boot.h.

Referenced by changemode_keyword(), and css_ha_server_state_string().

#define LOB_PATH_DEFAULT_PREFIX   ES_POSIX_PATH_PREFIX

Definition at line 156 of file boot.h.

Referenced by boot_initialize_client(), installdb(), xboot_copy(), and xboot_initialize_server().

#define LOB_PATH_PREFIX_MAX   ES_URI_PREFIX_MAX

Definition at line 155 of file boot.h.

Referenced by xboot_initialize_server().

Typedef Documentation

typedef struct boot_db_path_info BOOT_DB_PATH_INFO

Definition at line 101 of file boot.h.

typedef struct boot_server_credential BOOT_SERVER_CREDENTIAL

Definition at line 135 of file boot.h.

typedef enum ha_server_state HA_SERVER_STATE

Definition at line 126 of file boot.h.

Enumeration Type Documentation

enum ha_server_state

Enumerator
HA_SERVER_STATE_NA
HA_SERVER_STATE_IDLE
HA_SERVER_STATE_ACTIVE
HA_SERVER_STATE_TO_BE_ACTIVE
HA_SERVER_STATE_STANDBY
HA_SERVER_STATE_TO_BE_STANDBY
HA_SERVER_STATE_MAINTENANCE
HA_SERVER_STATE_DEAD

Definition at line 115 of file boot.h.

Function Documentation

void COMPOSE_FULL_NAME ( char *  buf, size_t  buf_size, const char *  path, const char *  name  )

inline

Definition at line 161 of file boot.h.

References PATH_SEPARATOR, and strlen.

Referenced by alterdbhost(), boot_initialize_client(), boot_restart_server(), get_db_path(), print_backup_info(), xboot_copy(), xboot_delete(), xboot_emergency_patch(), and xboot_soft_rename().

Here is the caller graph for this function:

Variable Documentation

char boot_Host_name[CUB_MAXHOSTNAMELEN]

Definition at line 158 of file boot_cl.c.

Referenced by boot_get_host_name(), boot_make_session_server_key(), boot_restart_server(), check_client_capabilities(), check_server_capabilities(), css_change_ha_server_state(), logtb_collect_local_clients(), logtb_count_not_allowed_clients_in_maintenance_mode(), net_client_ping_server_with_handshake(), server_ping_with_handshake(), xboot_register_client(), and xtran_lock_rep_read().