Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

#!/usr/bin/python 

# 

# Copyright (C) Citrix Systems Inc. 

# 

# This program is free software; you can redistribute it and/or modify 

# it under the terms of the GNU Lesser General Public License as published 

# by the Free Software Foundation; version 2.1 only. 

# 

# This program 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 Lesser General Public License for more details. 

# 

# You should have received a copy of the GNU Lesser General Public License 

# along with this program; if not, write to the Free Software Foundation, Inc., 

# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA 

# 

# SRCommand: parse SR command-line objects 

# 

 

from __future__ import print_function 

import XenAPI 

import sys 

import xs_errors 

import xmlrpclib 

import SR 

import util 

import blktap2 

import resetvdis 

import os 

 

NEEDS_VDI_OBJECT = [ 

        "vdi_update", "vdi_create", "vdi_delete", "vdi_snapshot", "vdi_clone", 

        "vdi_resize", "vdi_resize_online", "vdi_attach", "vdi_detach", 

        "vdi_activate", "vdi_deactivate", "vdi_attach_from_config", "vdi_detach_from_config", 

        "vdi_generate_config", "vdi_compose", "vdi_epoch_begin", 

        "vdi_epoch_end", "vdi_enable_cbt", "vdi_disable_cbt", "vdi_data_destroy", 

        "vdi_list_changed_blocks"] 

 

# don't log the commands that spam the log file too much 

NO_LOGGING = { 

        "iso": ["sr_scan"], 

        "nfs_iso": ["sr_scan"] 

} 

 

EXCEPTION_TYPE = { 

        "sr_scan": "SRScan", 

        "vdi_init": "VDILoad", 

        "vdi_create": "VDICreate", 

        "vdi_delete": "VDIDelete", 

        "vdi_attach": "VDIUnavailable", 

        "vdi_detach": "VDIUnavailable", 

        "vdi_activate": "VDIUnavailable", 

        "vdi_deactivate": "VDIUnavailable", 

        "vdi_resize": "VDIResize", 

        "vdi_resize_online": "VDIResize", 

        "vdi_snapshot": "VDISnapshot", 

        "vdi_clone": "VDIClone" 

} 

 

 

class SRCommand: 

    def __init__(self, driver_info): 

        self.dconf = '' 

        self.type = '' 

        self.sr_uuid = '' 

        self.cmdname = '' 

        self.cmdtype = '' 

        self.cmd = None 

        self.args = None 

        self.driver_info = driver_info 

 

    def parse(self): 

75        if len(sys.argv) != 2: 

            util.SMlog("Failed to parse commandline; wrong number of arguments; argv = %s" % (repr(sys.argv))) 

            raise xs_errors.XenError('BadRequest') 

 

        # Debug logging of the actual incoming command from the caller. 

        # util.SMlog( "" ) 

        # util.SMlog( "SM.parse: DEBUG: args = %s,\n%s" % \ 

        #             ( sys.argv[0], \ 

        #               util.splitXmlText( util.hideMemberValuesInXmlParams( \ 

        #                                  sys.argv[1] ), showContd=True ) ), \ 

        #                                  priority=util.LOG_DEBUG ) 

 

        try: 

            params, methodname = xmlrpclib.loads(sys.argv[1]) 

            self.cmd = methodname 

            params = params[0]  # expect a single struct 

            self.params = params 

 

            # params is a dictionary 

            self.dconf = params['device_config'] 

95            if 'sr_uuid' in params: 

                self.sr_uuid = params['sr_uuid'] 

97            if 'vdi_uuid' in params: 

                self.vdi_uuid = params['vdi_uuid'] 

99            elif self.cmd == "vdi_create": 

                self.vdi_uuid = util.gen_uuid() 

 

        except Exception as e: 

            util.SMlog("Failed to parse commandline; exception = %s argv = %s" % (str(e), repr(sys.argv))) 

            raise xs_errors.XenError('BadRequest') 

 

    def run_statics(self): 

        if self.params['command'] == 'sr_get_driver_info': 

            print(util.sr_get_driver_info(self.driver_info)) 

            sys.exit(0) 

 

    def run(self, sr): 

        try: 

            return self._run_locked(sr) 

        except (util.CommandException, util.SMException, XenAPI.Failure) as e: 

            util.logException(self.cmd) 

            msg = str(e) 

            if isinstance(e, util.CommandException): 

                msg = "Command %s failed (%s): %s" % \ 

                        (e.cmd, e.reason, os.strerror(abs(e.code))) 

            excType = EXCEPTION_TYPE.get(self.cmd) 

            if not excType: 

                excType = "SMGeneral" 

            raise xs_errors.XenError(excType, opterr=msg) 

 

        except blktap2.TapdiskFailed as e: 

            util.logException('tapdisk failed exception: %s' % e) 

            raise xs_errors.XenError('TapdiskFailed', 

                                     os.strerror( 

                                         e.get_error().get_error_code())) 

 

        except blktap2.TapdiskExists as e: 

            util.logException('tapdisk exists exception: %s' % e) 

            raise xs_errors.XenError('TapdiskAlreadyRunning', e.__str__()) 

 

        except: 

            util.logException('generic exception: %s' % self.cmd) 

            raise 

 

    def _run_locked(self, sr): 

        lockSR = False 

        lockInitOnly = False 

        rv = None 

        e = None 

145        if self.cmd in sr.ops_exclusive: 

            lockSR = True 

        elif self.cmd in NEEDS_VDI_OBJECT and "vdi_init" in sr.ops_exclusive: 

            lockInitOnly = True 

 

        target = None 

        acquired = False 

153        if lockSR or lockInitOnly: 

            sr.lock.acquire() 

            acquired = True 

        try: 

            try: 

156                if self.cmd in NEEDS_VDI_OBJECT: 

                    target = sr.vdi(self.vdi_uuid) 

            finally: 

159   166                if acquired and lockInitOnly: 

                    sr.lock.release() 

                    acquired = False 

            try: 

                rv = self._run(sr, target) 

            except Exception as e: 

                raise 

        finally: 

168            if acquired: 

                sr.lock.release() 

            try: 

                sr.cleanup() 

            except Exception as e1: 

                msg = 'failed to clean up SR: %s' % e1 

                if not e: 

                    util.SMlog(msg) 

                    raise e1 

                else: 

                    util.SMlog('WARNING: %s (error ignored)' % msg) 

        return rv 

 

    def _run(self, sr, target): 

        dconf_type = sr.dconf.get("type") 

190        if not dconf_type or not NO_LOGGING.get(dconf_type) or \ 

                self.cmd not in NO_LOGGING[dconf_type]: 

188            if 'device_config' in self.params: 

                util.SMlog("%s %s" % ( 

                    self.cmd, util.hidePasswdInParams( 

                        self.params, 'device_config'))) 

            else: 

                util.SMlog("%s %s" % (self.cmd, repr(self.params))) 

 

        caching_params = dict((k, self.params.get(k)) for k in 

                              [blktap2.VDI.CONF_KEY_ALLOW_CACHING, 

                               blktap2.VDI.CONF_KEY_MODE_ON_BOOT, 

                               blktap2.VDI.CONF_KEY_CACHE_SR, 

                               blktap2.VDI.CONF_KEY_O_DIRECT]) 

 

205        if self.cmd == 'vdi_create': 

            # These are the fields owned by the backend, passed on the 

            # commandline: 

 

            # LVM SRs store their metadata in XML format. XML does not support 

            # all unicode characters, so we must check if the label or the 

            # description contain such characters. We must enforce this 

            # restriction to other SRs as well (even if they do allow these 

            # characters) in order to be consistent. 

            target.label = self.params['args'][1] 

            target.description = self.params['args'][2] 

 

            if not util.isLegalXMLString(target.label) \ 

                    or not util.isLegalXMLString(target.description): 

                raise xs_errors.XenError('IllegalXMLChar', 

                                         opterr='The name and/or description you supplied contains one or more unsupported characters. The name and/or description must contain valid XML characters. See http://www.w3.org/TR/2004/REC-xml-20040204/#charsets for more information.') 

 

            target.ty = self.params['vdi_type'] 

            target.metadata_of_pool = self.params['args'][3] 

            target.is_a_snapshot = self.params['args'][4] == "true" 

            target.snapshot_time = self.params['args'][5] 

            target.snapshot_of = self.params['args'][6] 

            target.read_only = self.params['args'][7] == "true" 

 

            return target.create(self.params['sr_uuid'], self.vdi_uuid, long(self.params['args'][0])) 

 

226        elif self.cmd == 'vdi_update': 

            # Check for invalid XML characters, similar to VDI.create right 

            # above. 

 

            vdi_ref = sr.session.xenapi.VDI.get_by_uuid(self.vdi_uuid) 

            name_label = sr.session.xenapi.VDI.get_name_label(vdi_ref) 

            description = sr.session.xenapi.VDI.get_name_description(vdi_ref) 

 

            if not util.isLegalXMLString(name_label) \ 

                    or not util.isLegalXMLString(description): 

                raise xs_errors.XenError('IllegalXMLChar', 

                                         opterr='The name and/or description you supplied contains one or more unsupported characters. The name and/or description must contain valid XML characters. See http://www.w3.org/TR/2004/REC-xml-20040204/#charsets for more information.') 

 

            return target.update(self.params['sr_uuid'], self.vdi_uuid) 

 

238        elif self.cmd == 'vdi_introduce': 

            target = sr.vdi(self.params['new_uuid']) 

            return target.introduce(self.params['sr_uuid'], self.params['new_uuid']) 

 

242        elif self.cmd == 'vdi_delete': 

            if 'VDI_CONFIG_CBT' in util.sr_get_capability( 

                                        self.params['sr_uuid']): 

                return target.delete(self.params['sr_uuid'], 

                                     self.vdi_uuid, data_only=False) 

            else: 

                return target.delete(self.params['sr_uuid'], self.vdi_uuid) 

 

250        elif self.cmd == 'vdi_attach': 

            target = blktap2.VDI(self.vdi_uuid, target, self.driver_info) 

            writable = self.params['args'][0] == 'true' 

            return target.attach(self.params['sr_uuid'], self.vdi_uuid, 

                                 writable, caching_params=caching_params) 

 

256        elif self.cmd == 'vdi_detach': 

            target = blktap2.VDI(self.vdi_uuid, target, self.driver_info) 

            return target.detach(self.params['sr_uuid'], self.vdi_uuid) 

 

260        elif self.cmd == 'vdi_snapshot': 

            return target.snapshot(self.params['sr_uuid'], self.vdi_uuid) 

 

263        elif self.cmd == 'vdi_clone': 

            return target.clone(self.params['sr_uuid'], self.vdi_uuid) 

 

266        elif self.cmd == 'vdi_resize': 

            return target.resize(self.params['sr_uuid'], self.vdi_uuid, long(self.params['args'][0])) 

 

269        elif self.cmd == 'vdi_resize_online': 

            return target.resize_online(self.params['sr_uuid'], self.vdi_uuid, long(self.params['args'][0])) 

 

272        elif self.cmd == 'vdi_activate': 

            target = blktap2.VDI(self.vdi_uuid, target, self.driver_info) 

            writable = self.params['args'][0] == 'true' 

            return target.activate(self.params['sr_uuid'], self.vdi_uuid, 

                                   writable, caching_params) 

 

278        elif self.cmd == 'vdi_deactivate': 

            target = blktap2.VDI(self.vdi_uuid, target, self.driver_info) 

            return target.deactivate(self.params['sr_uuid'], self.vdi_uuid, 

                                     caching_params) 

 

283        elif self.cmd == 'vdi_epoch_begin': 

            if caching_params.get(blktap2.VDI.CONF_KEY_MODE_ON_BOOT) != "reset": 

                return 

            if "VDI_RESET_ON_BOOT/2" not in self.driver_info['capabilities']: 

                raise xs_errors.XenError('Unimplemented') 

            return target.reset_leaf(self.params['sr_uuid'], self.vdi_uuid) 

 

290        elif self.cmd == 'vdi_epoch_end': 

            return 

 

293        elif self.cmd == 'vdi_generate_config': 

            return target.generate_config(self.params['sr_uuid'], self.vdi_uuid) 

 

296        elif self.cmd == 'vdi_compose': 

            vdi1_uuid = sr.session.xenapi.VDI.get_uuid(self.params['args'][0]) 

            return target.compose(self.params['sr_uuid'], vdi1_uuid, self.vdi_uuid) 

 

300        elif self.cmd == 'vdi_attach_from_config': 

            ret = target.attach_from_config(self.params['sr_uuid'], self.vdi_uuid) 

            if not target.sr.driver_config.get("ATTACH_FROM_CONFIG_WITH_TAPDISK"): 

                return ret 

            target = blktap2.VDI(self.vdi_uuid, target, self.driver_info) 

            return target.attach(self.params['sr_uuid'], self.vdi_uuid, True, True) 

 

307        elif self.cmd == 'vdi_detach_from_config': 

            extras = {} 

            if target.sr.driver_config.get("ATTACH_FROM_CONFIG_WITH_TAPDISK"): 

                target = blktap2.VDI(self.vdi_uuid, target, self.driver_info) 

                extras['deactivate'] = True 

                extras['caching_params'] = caching_params 

            target.detach(self.params['sr_uuid'], self.vdi_uuid, ** extras) 

 

315        elif self.cmd == 'vdi_enable_cbt': 

            return target.configure_blocktracking(self.params['sr_uuid'], 

                                                  self.vdi_uuid, True) 

 

319        elif self.cmd == 'vdi_disable_cbt': 

            return target.configure_blocktracking(self.params['sr_uuid'], 

                                                  self.vdi_uuid, False) 

 

323        elif self.cmd == 'vdi_data_destroy': 

            return target.data_destroy(self.params['sr_uuid'], self.vdi_uuid) 

 

326        elif self.cmd == 'vdi_list_changed_blocks': 

            return target.list_changed_blocks() 

 

329        elif self.cmd == 'sr_create': 

            return sr.create(self.params['sr_uuid'], long(self.params['args'][0])) 

 

334        elif self.cmd == 'sr_delete': 

            return sr.delete(self.params['sr_uuid']) 

 

        elif self.cmd == 'sr_update': 

            return sr.update(self.params['sr_uuid']) 

 

        elif self.cmd == 'sr_probe': 

            txt = sr.probe() 

            util.SMlog("sr_probe result: %s" % util.splitXmlText(txt, showContd=True)) 

            # return the XML document as a string 

            return xmlrpclib.dumps((txt, ), "", True) 

 

        elif self.cmd == 'sr_attach': 

            is_master = False 

            if sr.dconf.get("SRmaster") == "true": 

                is_master = True 

 

            sr_uuid = self.params['sr_uuid'] 

 

            resetvdis.reset_sr(sr.session, util.get_this_host(), 

                               sr_uuid, is_master) 

 

            if is_master: 

                # Schedule a scan only when attaching on the SRmaster 

                util.set_dirty(sr.session, self.params["sr_ref"]) 

 

            try: 

                return sr.attach(sr_uuid) 

            finally: 

                if is_master: 

                    sr.after_master_attach(sr_uuid) 

 

        elif self.cmd == 'sr_detach': 

            return sr.detach(self.params['sr_uuid']) 

 

        elif self.cmd == 'sr_content_type': 

            return sr.content_type(self.params['sr_uuid']) 

 

        elif self.cmd == 'sr_scan': 

            return sr.scan(self.params['sr_uuid']) 

 

        else: 

            util.SMlog("Unknown command: %s" % self.cmd) 

            raise xs_errors.XenError('BadRequest') 

 

 

def run(driver, driver_info): 

    """Convenience method to run command on the given driver""" 

    cmd = SRCommand(driver_info) 

    try: 

        cmd.parse() 

        cmd.run_statics() 

        sr = driver(cmd, cmd.sr_uuid) 

        sr.direct = True 

        ret = cmd.run(sr) 

 

        if ret is None: 

            print(util.return_nil()) 

        else: 

            print(ret) 

 

    except (Exception, SR.SRException) as e: 

        try: 

            util.logException(driver_info['name']) 

        except KeyError: 

            util.SMlog('driver_info does not contain a \'name\' key.') 

        except: 

            pass 

 

        # If exception is of type SR.SRException, pass to Xapi. 

        # If generic python Exception, print a generic xmlrpclib 

        # dump and pass to XAPI. 

        if isinstance(e, SR.SRException): 

            print(e.toxml()) 

        else: 

            print(xmlrpclib.dumps(xmlrpclib.Fault(1200, str(e)), "", True)) 

 

    sys.exit(0)