1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2003-2009 Silicon Graphics International Corp. 5 * Copyright (c) 2011 Spectra Logic Corporation 6 * Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org> 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions, and the following disclaimer, 14 * without modification. 15 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 16 * substantially similar to the "NO WARRANTY" disclaimer below 17 * ("Disclaimer") and any redistribution must be conditioned upon 18 * including a substantially similar Disclaimer requirement for further 19 * binary redistribution. 20 * 21 * NO WARRANTY 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 26 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGES. 33 * 34 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_ha.h#1 $ 35 */ 36 37 #ifndef _CTL_HA_H_ 38 #define _CTL_HA_H_ 39 40 /* 41 * CTL High Availability Modes: 42 * 43 * CTL_HA_MODE_ACT_STBY: Commands are serialized to the master side. 44 * No media access commands on slave side (Standby). 45 * CTL_HA_MODE_SER_ONLY: Commands are serialized to the master side. 46 * Media can be accessed on both sides. 47 * CTL_HA_MODE_XFER: Commands and data are forwarded to the 48 * master side for execution. 49 */ 50 typedef enum { 51 CTL_HA_MODE_ACT_STBY, 52 CTL_HA_MODE_SER_ONLY, 53 CTL_HA_MODE_XFER 54 } ctl_ha_mode; 55 56 /* 57 * Communication channel IDs for various system components. This is to 58 * make sure one CTL instance talks with another, one ZFS instance talks 59 * with another, etc. 60 */ 61 typedef enum { 62 CTL_HA_CHAN_CTL, 63 CTL_HA_CHAN_DATA, 64 CTL_HA_CHAN_MAX 65 } ctl_ha_channel; 66 67 /* 68 * HA communication event notification. These are events generated by the 69 * HA communication subsystem. 70 * 71 * CTL_HA_EVT_MSG_RECV: Message received by the other node. 72 * CTL_HA_EVT_LINK_CHANGE: Communication channel status changed. 73 */ 74 typedef enum { 75 CTL_HA_EVT_NONE, 76 CTL_HA_EVT_MSG_RECV, 77 CTL_HA_EVT_LINK_CHANGE, 78 CTL_HA_EVT_MAX 79 } ctl_ha_event; 80 81 typedef enum { 82 CTL_HA_STATUS_WAIT, 83 CTL_HA_STATUS_SUCCESS, 84 CTL_HA_STATUS_ERROR, 85 CTL_HA_STATUS_INVALID, 86 CTL_HA_STATUS_DISCONNECT, 87 CTL_HA_STATUS_BUSY, 88 CTL_HA_STATUS_MAX 89 } ctl_ha_status; 90 91 typedef enum { 92 CTL_HA_DT_CMD_READ, 93 CTL_HA_DT_CMD_WRITE, 94 } ctl_ha_dt_cmd; 95 96 struct ctl_ha_dt_req; 97 98 typedef void (*ctl_ha_dt_cb)(struct ctl_ha_dt_req *); 99 100 struct ctl_ha_dt_req { 101 ctl_ha_dt_cmd command; 102 void *context; 103 ctl_ha_dt_cb callback; 104 int ret; 105 uint32_t size; 106 uint8_t *local; 107 uint8_t *remote; 108 TAILQ_ENTRY(ctl_ha_dt_req) links; 109 }; 110 111 struct ctl_softc; 112 ctl_ha_status ctl_ha_msg_init(struct ctl_softc *softc); 113 void ctl_ha_msg_shutdown(struct ctl_softc *softc); 114 ctl_ha_status ctl_ha_msg_destroy(struct ctl_softc *softc); 115 116 typedef void (*ctl_evt_handler)(ctl_ha_channel channel, ctl_ha_event event, 117 int param); 118 void ctl_ha_register_evthandler(ctl_ha_channel channel, 119 ctl_evt_handler handler); 120 121 ctl_ha_status ctl_ha_msg_register(ctl_ha_channel channel, 122 ctl_evt_handler handler); 123 ctl_ha_status ctl_ha_msg_recv(ctl_ha_channel channel, void *addr, 124 size_t len, int wait); 125 ctl_ha_status ctl_ha_msg_send(ctl_ha_channel channel, const void *addr, 126 size_t len, int wait); 127 ctl_ha_status ctl_ha_msg_send2(ctl_ha_channel channel, const void *addr, 128 size_t len, const void *addr2, size_t len2, int wait); 129 ctl_ha_status ctl_ha_msg_abort(ctl_ha_channel channel); 130 ctl_ha_status ctl_ha_msg_deregister(ctl_ha_channel channel); 131 132 struct ctl_ha_dt_req * ctl_dt_req_alloc(void); 133 void ctl_dt_req_free(struct ctl_ha_dt_req *req); 134 ctl_ha_status ctl_dt_single(struct ctl_ha_dt_req *req); 135 136 typedef enum { 137 CTL_HA_LINK_OFFLINE = 0x00, 138 CTL_HA_LINK_UNKNOWN = 0x01, 139 CTL_HA_LINK_ONLINE = 0x02 140 } ctl_ha_link_state; 141 142 #endif /* _CTL_HA_H_ */ 143