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

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

#!/usr/bin/env 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 

 

import os, re 

import scsiutil, util 

import xml.dom.minidom 

import xs_errors 

import glob 

import fcoelib 

 

DEVPATH='/dev/disk/by-id' 

DMDEVPATH='/dev/mapper' 

SYSFS_PATH1='/sys/class/scsi_host' 

SYSFS_PATH2='/sys/class/scsi_disk' 

SYSFS_PATH3='/sys/class/fc_transport' 

 

DRIVER_BLACKLIST = ['^(s|p|)ata_.*', '^ahci$', '^pdc_adma$', '^iscsi_tcp$', '^usb-storage$'] 

 

INVALID_DEVICE_NAME = '' 

 

def getManufacturer(s): 

    (rc,stdout,stderr) = util.doexec(['/sbin/modinfo', '-d', s]) 

40    if stdout: 

        return stdout.strip() 

    else: 

        return "Unknown" 

 

def update_devs_dict(devs, dev, entry): 

    if dev != INVALID_DEVICE_NAME: 

        devs[dev] = entry 

 

 

def adapters(filterstr="any"): 

    dict = {} 

    devs = {} 

    adt = {} 

    fcoe_eth_info = {} 

    fcoe_port_info = [] 

 

    fcoe_port_info = fcoelib.parse_fcoe_port_name_info() 

56    if filterstr == "fcoe": 

        fcoe_eth_info = fcoelib.parse_fcoe_eth_info() 

 

    for a in os.listdir(SYSFS_PATH1): 

        proc = match_hbadevs(a, filterstr) 

61        if not proc: 

            continue 

 

        #Special casing for fcoe 

        port_name_path = os.path.join(SYSFS_PATH1,a,'device',\ 

                         'fc_host',a,'port_name') 

        port_name_path_exists = os.path.exists(port_name_path) 

        util.SMlog("Port name path exists %d" % port_name_path_exists) 

69        if filterstr == "fcoe" and not port_name_path_exists: 

            continue 

71        if port_name_path_exists: 

            port_name = _get_port_name(port_name_path) 

            #If we are probing for fcoe luns/ adapters and if the port name 

            #in /sys/class/scsi_host/a/device/fc_host/a/port_name does not match 

            #one in the output of 'fcoeadm -i', then we shouldn't display that 

            #lun/adapter. 

            #On the other hand, if we are probing for hba luns, and if the 

            #port name in /sys/class/scsi_host/a/device/fc_host/a/port_name 

            #matches one in the output of 'fcoeadm -i', then we shouldn't 

            #display that lun/adapter, because that would have been discovered 

            #via the FCoE protocol. 

            if (filterstr == "fcoe" and port_name not in fcoe_port_info) or \ 

                (filterstr != "fcoe" and port_name in fcoe_port_info): 

                continue 

 

        adt[a] = proc 

        id = a.replace("host","") 

        scsiutil.rescan([id]) 

        emulex = False 

        paths = [] 

        if proc == "lpfc": 

            emulex = True 

            paths.append(SYSFS_PATH3) 

        else: 

            for p in [os.path.join(SYSFS_PATH1,a,"device","session*"),os.path.join(SYSFS_PATH1,a,"device"),\ 

                          os.path.join(SYSFS_PATH2,"%s:*"%id)]: 

                paths += glob.glob(p) 

 

99        if not len(paths): 

            continue 

        for path in paths: 

            for i in filter(match_targets,os.listdir(path)): 

                tgt = i.replace('target','') 

106                if emulex: 

                    sysfs = os.path.join(SYSFS_PATH3,i,"device") 

                else: 

                    sysfs = SYSFS_PATH2 

                for lun in os.listdir(sysfs): 

109                    if not match_LUNs(lun,tgt): 

                        continue 

113                    if emulex: 

                        dir = os.path.join(sysfs,lun) 

                    else: 

                        dir = os.path.join(sysfs,lun,"device") 

                    (dev, entry) = _extract_dev(dir, proc, id, lun) 

                    update_devs_dict(devs, dev, entry) 

            # for new qlogic sysfs layout (rport under device, then target) 

118            for i in filter(match_rport,os.listdir(path)): 

                newpath = os.path.join(path, i) 

                for j in filter(match_targets,os.listdir(newpath)): 

                    tgt = j.replace('target','') 

                    sysfs = SYSFS_PATH2 

                    for lun in os.listdir(sysfs): 

                        if not match_LUNs(lun,tgt): 

                            continue 

                        #Special casing for fcoe, populating eth information 

                        eth = "" 

                        if i in fcoe_eth_info.keys(): 

                            eth = fcoe_eth_info[i] 

                        dir = os.path.join(sysfs,lun,"device") 

                        (dev, entry) = _extract_dev(dir, proc, id, lun, eth) 

                        update_devs_dict(devs, dev, entry) 

 

            # for new mptsas sysfs entries, check for phy* node 

135            for i in filter(match_phy,os.listdir(path)): 

                (target,lunid) = i.replace('phy-','').split(':') 

                tgt = "%s:0:0:%s" % (target,lunid) 

                sysfs = SYSFS_PATH2 

                for lun in os.listdir(sysfs): 

                    if not match_LUNs(lun,tgt): 

                        continue 

                    dir = os.path.join(sysfs,lun,"device") 

                    (dev, entry) = _extract_dev(dir, proc, id, lun) 

                    update_devs_dict(devs, dev, entry) 

            if path.startswith(SYSFS_PATH2): 

                os.path.join(path,"device","block:*") 

                dev = _extract_dev_name(os.path.join(path, 'device')) 

148                if devs.has_key(dev): 

                    continue 

                hbtl = os.path.basename(path) 

                (h,b,t,l) = hbtl.split(':') 

                entry = {'procname':proc, 'host':id, 'target':l} 

                update_devs_dict(devs, dev, entry) 

 

    dict['devs'] = devs 

    dict['adt'] = adt 

    return dict 

 

def _get_port_name(port_name_path): 

    port_name = 0 

    try: 

        f = open(port_name_path, 'r') 

        try: 

            line = f.readline()[:-1] 

            if not line in ['<NULL>', '(NULL)', '']: 

                port_name = int(line,16) 

            util.SMlog("Port Name in sysfs is %d" % port_name) 

        finally: 

            f.close() 

    except IOError: 

        pass 

    return port_name 

 

def _get_driver_name(scsihost): 

    driver_name = 'Unknown' 

176    if os.path.exists(os.path.join(SYSFS_PATH1, scsihost, 'fnic_state')): 

        driver_name = 'fnic' 

178    if os.path.exists(os.path.join(SYSFS_PATH1, scsihost, 'lpfc_fcp_class')): 

        driver_name = 'lpfc' 

180    if os.path.exists(os.path.join(SYSFS_PATH1, scsihost, '84xx_fw_version')): 

        driver_name = 'qla2xxx' 

194    if 'Unknown' == driver_name: 

        namepath = os.path.join(SYSFS_PATH1, scsihost, 'driver_name') 

185        if not os.path.exists(namepath): 

            namepath = os.path.join(SYSFS_PATH1, scsihost, 'proc_name') 

186        if os.path.exists(namepath): 

            try: 

                f = open(namepath, 'r') 

                line = f.readline()[:-1] 

                f.close() 

                if not line in ['<NULL>', '(NULL)', '']: 

                    driver_name = line 

            except IOError: 

                pass 

205    if 'Unknown' == driver_name: 

        ueventpath = os.path.join(SYSFS_PATH1, scsihost, 'uevent') 

197        if os.path.exists(ueventpath): 

            try: 

                f = open(ueventpath, 'r') 

                for line in f: 

                    if line.startswith('PHYSDEVDRIVER='): 

                        driver_name = line.replace('PHYSDEVDRIVER=','').strip() 

                f.close() 

            except IOError: 

                pass 

    return driver_name 

 

def _parseHostId(str): 

    id = str.split() 

    val = "%s:%s:%s" % (id[1],id[3],id[5]) 

    return val.replace(',','') 

 

def _genMPPHBA(id): 

    devs = scsiutil.cacheSCSIidentifiers() 

    mppdict = {} 

    for dev in devs: 

        item = devs[dev] 

        if item[1] == id: 

            arr = scsiutil._genArrayIdentifier(dev) 

            if not len(arr): 

                continue 

            try: 

                cmd = ['/usr/sbin/mppUtil', '-a'] 

                for line in util.doexec(cmd)[1].split('\n'): 

                    if line.find(arr) != -1: 

                        rec = line.split()[0] 

                        cmd2 = ['/usr/sbin/mppUtil', '-g',rec] 

                        li = [] 

                        for newline in util.doexec(cmd2)[1].split('\n'): 

                            if newline.find('hostId') != -1: 

                                li.append(_parseHostId(newline)) 

                        mppdict[dev.split('/')[-1]] = li 

            except: 

                continue 

    return mppdict 

 

def match_hbadevs(s, filterstr): 

    driver_name = _get_driver_name(s) 

243   243    if match_host(s) and not match_blacklist(driver_name) \ 

                and (filterstr == "any" or filterstr == "fcoe" or \ 

                match_filterstr(filterstr, driver_name) ): 

        return driver_name 

    else: 

        return "" 

 

def match_blacklist(driver_name): 

    return re.search("(" + ")|(".join(DRIVER_BLACKLIST) + ")", driver_name) 

 

def match_filterstr(filterstr, driver_name): 

    return re.search("^%s" % filterstr, driver_name) 

 

def match_host(s): 

    return re.search("^host[0-9]", s) 

 

def match_rport(s): 

    regex = re.compile("^rport-*") 

    return regex.search(s, 0) 

 

def match_targets(s): 

    regex = re.compile("^target[0-9]") 

    return regex.search(s, 0) 

 

def match_phy(s): 

    regex = re.compile("^phy-*") 

    return regex.search(s, 0) 

 

def match_LUNs(s, prefix): 

    regex = re.compile("^%s" % prefix) 

    return regex.search(s, 0) 

 

def match_dev(s): 

    regex = re.compile("^block:") 

    return regex.search(s, 0) 

 

def _extract_dev_name(device_dir): 

    """Returns the name of the block device from sysfs e.g. 'sda'""" 

    kernel_version = os.uname()[2] 

 

    if kernel_version.startswith('2.6'): 

        # sub-directory of form block:sdx/ 

        dev = filter(match_dev, os.listdir(device_dir))[0] 

        # remove 'block:' from entry and return 

        return dev.lstrip('block:') 

    else: 

        # Anything 3.0 and later should have the same ABI. 

        return _get_block_device_name_with_kernel_3x(device_dir) 

 

def _get_block_device_name_with_kernel_3x(device_dir): 

    devs = glob.glob(os.path.join(device_dir, 'block/*')) 

    if len(devs): 

        # prune path to extract the device name 

        return os.path.basename(devs[0]) 

    else: 

        return INVALID_DEVICE_NAME 

 

def _extract_dev(device_dir, procname, host, target, eths=""): 

    """Returns device name and creates dictionary entry for it""" 

    dev = _extract_dev_name(device_dir) 

    entry = {} 

    entry['procname'] = procname 

    entry['host'] = host 

    entry['target'] = target 

    entry['eth'] = eths 

    return (dev, entry) 

 

def _add_host_parameters_to_adapter(dom, adapter, host_class, host_id, 

                                    parameters): 

    """Adds additional information about the adapter to the the adapter node""" 

    host_path = os.path.join('/sys/class/', host_class, 'host%s' % (host_id)) 

    if os.path.exists(host_path): 

        host_entry = dom.createElement(host_class) 

        adapter.appendChild(host_entry) 

        for parameter in parameters: 

            try: 

                filehandle = open(os.path.join(host_path, parameter)) 

                parameter_value = filehandle.read(512).strip() 

                filehandle.close() 

312                if parameter_value: 

                    entry = dom.createElement(parameter) 

                    host_entry.appendChild(entry) 

                    text_node = dom.createTextNode(parameter_value) 

                    entry.appendChild(text_node) 

            except IOError: 

                pass 

 

def scan(srobj): 

    systemrootID = util.getrootdevID() 

    hbadict = srobj.hbadict 

    hbas = srobj.hbas 

    dom = xml.dom.minidom.Document() 

    e = dom.createElement("Devlist") 

    dom.appendChild(e) 

 

    if not os.path.exists(DEVPATH): 

        return dom.toprettyxml() 

 

    devs = srobj.devs 

    vdis = {} 

 

    for key in hbadict: 

        hba = hbadict[key] 

        path = os.path.join("/dev",key) 

        realpath = path 

 

        obj = srobj.vdi("") 

        try: 

            obj._query(realpath, devs[realpath][4]) 

        except: 

            continue 

 

        # Test for root dev or existing PBD 

        if len(obj.SCSIid) and len(systemrootID) and util.match_scsiID(obj.SCSIid, systemrootID): 

            util.SMlog("Ignoring root device %s" % realpath) 

            continue 

        elif util.test_SCSIid(srobj.session, None, obj.SCSIid): 

            util.SMlog("SCSIid in use, ignoring (%s)" % obj.SCSIid) 

            continue 

        elif not devs.has_key(realpath): 

            continue 

 

        ids = devs[realpath] 

        obj.adapter = ids[1] 

        obj.channel = ids[2] 

        obj.id = ids[3] 

        obj.lun = ids[4] 

        obj.hba = hba['procname'] 

        if hba.has_key('eth') and hba['eth']: 

            obj.eth = hba['eth'] 

        obj.numpaths = 1 

        if vdis.has_key(obj.SCSIid): 

            vdis[obj.SCSIid].numpaths += 1 

            vdis[obj.SCSIid].path += " [%s]" % key 

        elif obj.hba == 'mpp': 

            mppdict = _genMPPHBA(obj.adapter) 

            if mppdict.has_key(key): 

                item = mppdict[key] 

                adapters = '' 

                for i in item: 

                    if len(adapters): 

                        adapters += ', ' 

                        obj.numpaths += 1 

                    adapters += i 

                if len(adapters): 

                    obj.mpp = adapters 

            vdis[obj.SCSIid] = obj 

        else: 

            vdis[obj.SCSIid] = obj 

 

389    for key in vdis: 

        obj = vdis[key] 

        d = dom.createElement("BlockDevice") 

        e.appendChild(d) 

 

        for attr in ['path','numpaths','SCSIid','vendor','serial','size','adapter','channel','id','lun','hba','mpp','eth']: 

            try: 

                aval = getattr(obj, attr) 

            except AttributeError: 

                if attr in ['mpp'] or attr in ['eth']: 

                    continue 

                raise xs_errors.XenError('InvalidArg', \ 

                      opterr='Missing required field [%s]' % attr) 

            entry = dom.createElement(attr) 

            d.appendChild(entry) 

            textnode = dom.createTextNode(str(aval)) 

            entry.appendChild(textnode) 

 

    for key in hbas.iterkeys(): 

        a = dom.createElement("Adapter") 

        e.appendChild(a) 

        entry = dom.createElement('host') 

        a.appendChild(entry) 

        textnode = dom.createTextNode(key) 

        entry.appendChild(textnode) 

 

        entry = dom.createElement('name') 

        a.appendChild(entry) 

        textnode = dom.createTextNode(hbas[key]) 

        entry.appendChild(textnode) 

 

        entry = dom.createElement('manufacturer') 

        a.appendChild(entry) 

        textnode = dom.createTextNode(getManufacturer(hbas[key])) 

        entry.appendChild(textnode) 

 

        id = key.replace("host","") 

        entry = dom.createElement('id') 

        a.appendChild(entry) 

        textnode = dom.createTextNode(id) 

        entry.appendChild(textnode) 

 

        _add_host_parameters_to_adapter(dom, a, 'fc_host', id, 

                                        ['node_name', 'port_name', 

                                         'port_state', 'speed', 

                                         'supported_speeds']) 

        _add_host_parameters_to_adapter(dom, a, 'iscsi_host', id, 

                                        ['hwaddress', 'initiatorname', 

                                         'ipaddress', 'port_speed', 

                                         'port_state']) 

 

    return dom.toprettyxml() 

 

def check_iscsi(adapter): 

    ret = False 

    str = "host%s" % adapter 

    try: 

        filename = os.path.join('/sys/class/scsi_host',str,'proc_name') 

        f = open(filename, 'r') 

        if f.readline().find("iscsi_tcp") != -1: 

            ret = True 

    except: 

        pass 

    return ret 

 

def match_nonpartitions(s): 

    regex = re.compile("-part[0-9]") 

    if not regex.search(s, 0): 

        return True