/usr/lib/python3/dist-packages/os_brick/initiator/connectors/storpool.py is in python3-os-brick 2.3.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | # Copyright (c) 2015 - 2017 StorPool
# All Rights Reserved.
#
# 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.
from __future__ import absolute_import
import os
import six
from oslo_log import log as logging
from oslo_utils import importutils
from os_brick import exception
from os_brick.initiator.connectors import base
LOG = logging.getLogger(__name__)
spopenstack = importutils.try_import('storpool.spopenstack')
class StorPoolConnector(base.BaseLinuxConnector):
""""Connector class to attach/detach StorPool volumes."""
def __init__(self, root_helper, driver=None,
*args, **kwargs):
super(StorPoolConnector, self).__init__(root_helper, driver=driver,
*args, **kwargs)
if spopenstack is not None:
try:
self._attach = spopenstack.AttachDB(log=LOG)
except Exception as e:
raise exception.BrickException(
'Could not initialize the StorPool API bindings: %s' % (e))
else:
self._attach = None
@staticmethod
def get_connector_properties(root_helper, *args, **kwargs):
"""The StorPool connector properties."""
return {}
def connect_volume(self, connection_properties):
"""Connect to a volume.
:param connection_properties: The dictionary that describes all
of the target volume attributes;
it needs to contain the StorPool
'client_id' and the common 'volume' and
'access_mode' values.
:type connection_properties: dict
:returns: dict
"""
client_id = connection_properties.get('client_id', None)
if client_id is None:
raise exception.BrickException(
'Invalid StorPool connection data, no client ID specified.')
volume_id = connection_properties.get('volume', None)
if volume_id is None:
raise exception.BrickException(
'Invalid StorPool connection data, no volume ID specified.')
volume = self._attach.volumeName(volume_id)
mode = connection_properties.get('access_mode', None)
if mode is None or mode not in ('rw', 'ro'):
raise exception.BrickException(
'Invalid access_mode specified in the connection data.')
req_id = 'brick-%s-%s' % (client_id, volume_id)
self._attach.add(req_id, {
'volume': volume,
'type': 'brick',
'id': req_id,
'rights': 1 if mode == 'ro' else 2,
'volsnap': False
})
self._attach.sync(req_id, None)
return {'type': 'block', 'path': '/dev/storpool/' + volume}
def disconnect_volume(self, connection_properties, device_info,
force=False, ignore_errors=False):
"""Disconnect a volume from the local host.
The connection_properties are the same as from connect_volume.
The device_info is returned from connect_volume.
:param connection_properties: The dictionary that describes all
of the target volume attributes;
it needs to contain the StorPool
'client_id' and the common 'volume'
values.
:type connection_properties: dict
:param device_info: historical difference, but same as connection_props
:type device_info: dict
:param force: Whether to forcefully disconnect even if flush fails.
For StorPool, this parameter is ignored, the volume is
always detached.
:type force: bool
:param ignore_errors: When force is True, this will decide whether to
ignore errors or raise an exception once finished
the operation. Default is False.
For StorPool, this parameter is ignored,
no exception is raised except on
unexpected errors.
:type ignore_errors: bool
"""
client_id = connection_properties.get('client_id', None)
if client_id is None:
raise exception.BrickException(
'Invalid StorPool connection data, no client ID specified.')
volume_id = connection_properties.get('volume', None)
if volume_id is None:
raise exception.BrickException(
'Invalid StorPool connection data, no volume ID specified.')
volume = self._attach.volumeName(volume_id)
req_id = 'brick-%s-%s' % (client_id, volume_id)
self._attach.sync(req_id, volume)
self._attach.remove(req_id)
def get_search_path(self):
return '/dev/storpool'
def get_volume_paths(self, connection_properties):
"""Return the list of existing paths for a volume.
The job of this method is to find out what paths in
the system are associated with a volume as described
by the connection_properties.
:param connection_properties: The dictionary that describes all
of the target volume attributes;
it needs to contain 'volume' and
'device_path' values.
:type connection_properties: dict
"""
volume_id = connection_properties.get('volume', None)
if volume_id is None:
raise exception.BrickException(
'Invalid StorPool connection data, no volume ID specified.')
volume = self._attach.volumeName(volume_id)
path = '/dev/storpool/' + volume
dpath = connection_properties.get('device_path', None)
if dpath is not None and dpath != path:
raise exception.BrickException(
'Internal error: StorPool volume path {path} does not '
'match device path {dpath}',
{path: path, dpath: dpath})
return [path]
def get_all_available_volumes(self, connection_properties=None):
"""Return all volumes that exist in the search directory.
At connect_volume time, a Connector looks in a specific
directory to discover a volume's paths showing up.
This method's job is to return all paths in the directory
that connect_volume uses to find a volume.
This method is used in coordination with get_volume_paths()
to verify that volumes have gone away after disconnect_volume
has been called.
:param connection_properties: The dictionary that describes all
of the target volume attributes.
Unused for the StorPool connector.
:type connection_properties: dict
"""
names = []
prefix = self._attach.volumeName('')
prefixlen = len(prefix)
if os.path.isdir('/dev/storpool'):
files = os.listdir('/dev/storpool')
for entry in files:
full = '/dev/storpool/' + entry
if entry.startswith(prefix) and os.path.islink(full) and \
not os.path.isdir(full):
names.append(entry[prefixlen:])
return names
def _get_device_size(self, device):
"""Get the size in bytes of a volume."""
(out, _err) = self._execute('blockdev', '--getsize64',
device, run_as_root=True,
root_helper=self._root_helper)
var = six.text_type(out)
if var.isnumeric():
return int(var)
else:
return None
def extend_volume(self, connection_properties):
"""Update the attached volume's size.
This method will attempt to update the local hosts's
volume after the volume has been extended on the remote
system. The new volume size in bytes will be returned.
If there is a failure to update, then None will be returned.
:param connection_properties: The volume connection properties.
:returns: new size of the volume.
"""
# The StorPool client (storpool_block service) running on this host
# should have picked up the change already, so it is enough to query
# the actual disk device to see if its size is correct.
#
# TODO(pp): query the API to see if this is really the case
volume_id = connection_properties.get('volume', None)
if volume_id is None:
raise exception.BrickException(
'Invalid StorPool connection data, no volume ID specified.')
volume = self._attach.volumeName(volume_id)
path = '/dev/storpool/' + volume
return self._get_device_size(path)
|