forked from open-iscsi/rtslib-fb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
target.py
1590 lines (1321 loc) · 54.2 KB
/
target.py
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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
'''
Implements the RTS generic Target fabric classes.
This file is part of RTSLib.
Copyright (c) 2011-2013 by Datera, Inc.
Copyright (c) 2011-2014 by Red Hat, Inc.
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.
'''
import os
from glob import iglob as glob
from functools import partial
from six.moves import range
import uuid
from .node import CFSNode
from .utils import RTSLibBrokenLink, RTSLibError
from .utils import fread, fwrite, normalize_wwn, generate_wwn
from .utils import dict_remove, set_attributes, set_parameters, ignored
from .utils import _get_auth_attr, _set_auth_attr
from . import tcm
import six
auth_params = ('userid', 'password', 'mutual_userid', 'mutual_password')
class Target(CFSNode):
'''
This is an interface to Targets in configFS.
A Target is identified by its wwn.
To a Target is attached a list of TPG objects.
'''
# Target private stuff
def __repr__(self):
return "<Target %s/%s>" % (self.fabric_module.name, self.wwn)
def __init__(self, fabric_module, wwn=None, mode='any'):
'''
@param fabric_module: The target's fabric module.
@type fabric_module: FabricModule
@param wwn: The optional Target's wwn.
If no wwn is specified, one will be generated.
@type wwn: string
@param mode:An optionnal string containing the object creation mode:
- I{'any'} means the configFS object will be either looked up
or created.
- I{'lookup'} means the object MUST already exist configFS.
- I{'create'} means the object must NOT already exist in configFS.
@type mode:string
@return: A Target object.
'''
super(Target, self).__init__()
self.fabric_module = fabric_module
fabric_module._check_self()
if wwn is not None:
# old versions used wrong NAA prefix, fixup
if wwn.startswith("naa.6"):
wwn = "naa.5" + wwn[5:]
self.wwn, self.wwn_type = fabric_module.to_normalized_wwn(wwn)
elif not fabric_module.wwns:
self.wwn = generate_wwn(fabric_module.wwn_types[0])
self.wwn_type = fabric_module.wwn_types[0]
else:
raise RTSLibError("Fabric cannot generate WWN but it was not given")
# Checking is done, convert to format the fabric wants
fabric_wwn = fabric_module.to_fabric_wwn(self.wwn)
self._path = "%s/%s" % (self.fabric_module.path, fabric_wwn)
self._create_in_cfs_ine(mode)
def _list_tpgs(self):
self._check_self()
for tpg_dir in glob("%s/tpgt*" % self.path):
tag = os.path.basename(tpg_dir).split('_')[1]
tag = int(tag)
yield TPG(self, tag, 'lookup')
# Target public stuff
def has_feature(self, feature):
'''
Whether or not this Target has a certain feature.
'''
return self.fabric_module.has_feature(feature)
def delete(self):
'''
Recursively deletes a Target object.
This will delete all attached TPG objects and then the Target itself.
'''
self._check_self()
for tpg in self.tpgs:
tpg.delete()
super(Target, self).delete()
tpgs = property(_list_tpgs, doc="Get the list of TPG for the Target.")
@classmethod
def setup(cls, fm_obj, t, err_func):
'''
Set up target objects based upon t dict, from saved config.
Guard against missing or bad dict items, but keep going.
Call 'err_func' for each error.
'''
if 'wwn' not in t:
err_func("'wwn' not defined for Target")
return
try:
t_obj = Target(fm_obj, t['wwn'])
except RTSLibError as e:
err_func("Could not create Target object: %s" % e)
return
for tpg in t.get('tpgs', []):
TPG.setup(t_obj, tpg, err_func)
def dump(self):
d = super(Target, self).dump()
d['wwn'] = self.wwn
d['fabric'] = self.fabric_module.name
d['tpgs'] = [tpg.dump() for tpg in self.tpgs]
return d
class TPG(CFSNode):
'''
This is a an interface to Target Portal Groups in configFS.
A TPG is identified by its parent Target object and its TPG Tag.
To a TPG object is attached a list of NetworkPortals. Targets without
the 'tpgts' feature cannot have more than a single TPG, so attempts
to create more will raise an exception.
'''
# TPG private stuff
def __repr__(self):
return "<TPG %d>" % self.tag
def __init__(self, parent_target, tag=None, mode='any'):
'''
@param parent_target: The parent Target object of the TPG.
@type parent_target: Target
@param tag: The TPG Tag (TPGT).
@type tag: int > 0
@param mode:An optionnal string containing the object creation mode:
- I{'any'} means the configFS object will be either looked up or
created.
- I{'lookup'} means the object MUST already exist configFS.
- I{'create'} means the object must NOT already exist in configFS.
@type mode:string
@return: A TPG object.
'''
super(TPG, self).__init__()
if tag is None:
tags = [tpg.tag for tpg in parent_target.tpgs]
for index in range(1048576):
if index not in tags and index > 0:
tag = index
break
if tag is None:
raise RTSLibError("Cannot find an available TPG Tag")
else:
tag = int(tag)
if not tag > 0:
raise RTSLibError("The TPG Tag must be >0")
self._tag = tag
if isinstance(parent_target, Target):
self._parent_target = parent_target
else:
raise RTSLibError("Invalid parent Target")
self._path = "%s/tpgt_%d" % (self.parent_target.path, self.tag)
target_path = self.parent_target.path
if not self.has_feature('tpgts') and not os.path.isdir(self._path):
for filename in os.listdir(target_path):
if filename.startswith("tpgt_") \
and os.path.isdir("%s/%s" % (target_path, filename)) \
and filename != "tpgt_%d" % self.tag:
raise RTSLibError("Target cannot have multiple TPGs")
self._create_in_cfs_ine(mode)
if self.has_feature('nexus') and not self._get_nexus():
self._set_nexus()
def _get_tag(self):
return self._tag
def _get_parent_target(self):
return self._parent_target
def _list_network_portals(self):
self._check_self()
if not self.has_feature('nps'):
return
for network_portal_dir in os.listdir("%s/np" % self.path):
(ip_address, port) = \
os.path.basename(network_portal_dir).rsplit(":", 1)
port = int(port)
yield NetworkPortal(self, ip_address, port, 'lookup')
def _get_enable(self):
self._check_self()
path = "%s/enable" % self.path
# If the TPG does not have the enable attribute, then it is always
# enabled.
if os.path.isfile(path):
return bool(int(fread(path)))
else:
return True
def _set_enable(self, boolean):
'''
Enables or disables the TPG. If the TPG doesn't support the enable
attribute, do nothing.
'''
self._check_self()
path = "%s/enable" % self.path
if os.path.isfile(path) and (boolean != self._get_enable()):
try:
fwrite(path, str(int(boolean)))
except IOError as e:
raise RTSLibError("Cannot change enable state: %s" % e)
def _get_nexus(self):
'''
Gets the nexus initiator WWN, or None if the TPG does not have one.
'''
self._check_self()
if self.has_feature('nexus'):
try:
nexus_wwn = fread("%s/nexus" % self.path)
except IOError:
nexus_wwn = ''
return nexus_wwn
else:
return None
def _set_nexus(self, nexus_wwn=None):
'''
Sets the nexus initiator WWN. Raises an exception if the nexus is
already set or if the TPG does not use a nexus.
'''
self._check_self()
if not self.has_feature('nexus'):
raise RTSLibError("The TPG does not use a nexus")
if self._get_nexus():
raise RTSLibError("The TPG's nexus initiator WWN is already set")
fm = self.parent_target.fabric_module
if nexus_wwn:
nexus_wwn = fm.to_normalized_wwn(nexus_wwn)[0]
else:
# Nexus wwn type should match parent target
nexus_wwn = generate_wwn(self.parent_target.wwn_type)
fwrite("%s/nexus" % self.path, fm.to_fabric_wwn(nexus_wwn))
def _list_node_acls(self):
self._check_self()
if not self.has_feature('acls'):
return
node_acl_dirs = [os.path.basename(path)
for path in os.listdir("%s/acls" % self.path)]
for node_acl_dir in node_acl_dirs:
fm = self.parent_target.fabric_module
yield NodeACL(self, fm.from_fabric_wwn(node_acl_dir), 'lookup')
def _list_node_acl_groups(self):
self._check_self()
if not self.has_feature('acls'):
return
names = set([])
for na in self.node_acls:
tag = na.tag
if tag:
names.add(tag)
return (NodeACLGroup(self, n) for n in names)
def _list_luns(self):
self._check_self()
lun_dirs = [os.path.basename(path)
for path in os.listdir("%s/lun" % self.path)]
for lun_dir in lun_dirs:
lun = lun_dir.split('_')[1]
lun = int(lun)
yield LUN(self, lun)
def _control(self, command):
self._check_self()
path = "%s/control" % self.path
fwrite(path, "%s\n" % str(command))
# TPG public stuff
def has_feature(self, feature):
'''
Whether or not this TPG has a certain feature.
'''
return self.parent_target.has_feature(feature)
def delete(self):
'''
Recursively deletes a TPG object.
This will delete all attached LUN, NetworkPortal and Node ACL objects
and then the TPG itself. Before starting the actual deletion process,
all sessions will be disconnected.
'''
self._check_self()
self.enable = False
for acl in self.node_acls:
acl.delete()
for lun in self.luns:
lun.delete()
for portal in self.network_portals:
portal.delete()
super(TPG, self).delete()
def node_acl(self, node_wwn, mode='any'):
'''
Same as NodeACL() but without specifying the parent_tpg.
'''
self._check_self()
return NodeACL(self, node_wwn=node_wwn, mode=mode)
def network_portal(self, ip_address, port, mode='any'):
'''
Same as NetworkPortal() but without specifying the parent_tpg.
'''
self._check_self()
return NetworkPortal(self, ip_address=ip_address, port=port, mode=mode)
def lun(self, lun, storage_object=None, alias=None):
'''
Same as LUN() but without specifying the parent_tpg.
'''
self._check_self()
return LUN(self, lun=lun, storage_object=storage_object, alias=alias)
tag = property(_get_tag,
doc="Get the TPG Tag as an int.")
parent_target = property(_get_parent_target,
doc="Get the parent Target object to which the " \
+ "TPG is attached.")
enable = property(_get_enable, _set_enable,
doc="Get or set a boolean value representing the " \
+ "enable status of the TPG. " \
+ "True means the TPG is enabled, False means it is " \
+ "disabled.")
network_portals = property(_list_network_portals,
doc="Get the list of NetworkPortal objects currently attached " \
+ "to the TPG.")
node_acls = property(_list_node_acls,
doc="Get the list of NodeACL objects currently " \
+ "attached to the TPG.")
node_acl_groups = property(_list_node_acl_groups,
doc="Get the list of NodeACL groups currently " \
+ "attached to the TPG.")
luns = property(_list_luns,
doc="Get the list of LUN objects currently attached " \
+ "to the TPG.")
nexus = property(_get_nexus, _set_nexus,
doc="Get or set (once) the TPG's Nexus is used.")
chap_userid = property(partial(_get_auth_attr, attribute='auth/userid', ignore=True),
partial(_set_auth_attr, attribute='auth/userid', ignore=True),
doc="Set or get the initiator CHAP auth userid.")
chap_password = property(partial(_get_auth_attr, attribute='auth/password', ignore=True),
partial(_set_auth_attr, attribute='auth/password', ignore=True),
doc="Set or get the initiator CHAP auth password.")
chap_mutual_userid = property(partial(_get_auth_attr, attribute='auth/userid_mutual', ignore=True),
partial(_set_auth_attr, attribute='auth/userid_mutual', ignore=True),
doc="Set or get the initiator CHAP auth userid.")
chap_mutual_password = property(partial(_get_auth_attr, attribute='auth/password_mutual', ignore=True),
partial(_set_auth_attr, attribute='auth/password_mutual', ignore=True),
doc="Set or get the initiator CHAP auth password.")
def _get_authenticate_target(self):
self._check_self()
path = "%s/auth/authenticate_target" % self.path
try:
return bool(int(fread(path)))
except:
return None
authenticate_target = property(_get_authenticate_target,
doc="Get the boolean authenticate target flag.")
@classmethod
def setup(cls, t_obj, tpg, err_func):
tpg_obj = cls(t_obj, tag=tpg.get("tag", None))
set_attributes(tpg_obj, tpg.get('attributes', {}), err_func)
set_parameters(tpg_obj, tpg.get('parameters', {}), err_func)
for lun in tpg.get('luns', []):
LUN.setup(tpg_obj, lun, err_func)
for p in tpg.get('portals', []):
NetworkPortal.setup(tpg_obj, p, err_func)
for acl in tpg.get('node_acls', []):
NodeACL.setup(tpg_obj, acl, err_func)
tpg_obj.enable = tpg.get('enable', True)
dict_remove(tpg, ('luns', 'portals', 'node_acls', 'tag',
'attributes', 'parameters', 'enable'))
for name, value in six.iteritems(tpg):
if value:
try:
setattr(tpg_obj, name, value)
except:
err_func("Could not set tpg %s attribute '%s'" %
(tpg_obj.tag, name))
def dump(self):
d = super(TPG, self).dump()
d['tag'] = self.tag
d['enable'] = self.enable
d['luns'] = [lun.dump() for lun in self.luns]
d['portals'] = [portal.dump() for portal in self.network_portals]
d['node_acls'] = [acl.dump() for acl in self.node_acls]
if self.has_feature("auth"):
for attr in auth_params:
val = getattr(self, "chap_" + attr, None)
if val:
d["chap_" + attr] = val
return d
class LUN(CFSNode):
'''
This is an interface to RTS Target LUNs in configFS.
A LUN is identified by its parent TPG and LUN index.
'''
MAX_TARGET_LUN = 65535
# LUN private stuff
def __repr__(self):
return "<LUN %d (%s/%s)>" % (self.lun, self.storage_object.plugin,
self.storage_object.name)
def __init__(self, parent_tpg, lun=None, storage_object=None, alias=None):
'''
A LUN object can be instanciated in two ways:
- B{Creation mode}: If I{storage_object} is specified, the
underlying configFS object will be created with that parameter.
No LUN with the same I{lun} index can pre-exist in the parent TPG
in that mode, or instanciation will fail.
- B{Lookup mode}: If I{storage_object} is not set, then the LUN
will be bound to the existing configFS LUN object of the parent
TPG having the specified I{lun} index. The underlying configFS
object must already exist in that mode.
@param parent_tpg: The parent TPG object.
@type parent_tpg: TPG
@param lun: The LUN index.
@type lun: 0-65535
@param storage_object: The storage object to be exported as a LUN.
@type storage_object: StorageObject subclass
@param alias: An optional parameter to manually specify the LUN alias.
You probably do not need this.
@type alias: string
@return: A LUN object.
'''
super(LUN, self).__init__()
if isinstance(parent_tpg, TPG):
self._parent_tpg = parent_tpg
else:
raise RTSLibError("Invalid parent TPG")
if lun is None:
luns = [l.lun for l in self.parent_tpg.luns]
for index in range(self.MAX_TARGET_LUN+1):
if index not in luns:
lun = index
break
if lun is None:
raise RTSLibError("All LUNs 0-%d in use" % self.MAX_TARGET_LUN)
else:
lun = int(lun)
if lun < 0 or lun > self.MAX_TARGET_LUN:
raise RTSLibError("LUN must be 0 to %d" % self.MAX_TARGET_LUN)
self._lun = lun
self._path = "%s/lun/lun_%d" % (self.parent_tpg.path, self.lun)
if storage_object is None and alias is not None:
raise RTSLibError("The alias parameter has no meaning " \
+ "without the storage_object parameter")
if storage_object is not None:
self._create_in_cfs_ine('create')
try:
self._configure(storage_object, alias)
except:
self.delete()
raise
else:
self._create_in_cfs_ine('lookup')
def _configure(self, storage_object, alias):
self._check_self()
if alias is None:
alias = str(uuid.uuid4())[-10:]
else:
alias = str(alias).strip()
if '/' in alias:
raise RTSLibError("Invalid alias: %s", alias)
destination = "%s/%s" % (self.path, alias)
if storage_object.exists:
source = storage_object.path
else:
raise RTSLibError("storage_object does not exist in configFS")
os.symlink(source, destination)
def _get_alias(self):
self._check_self()
for path in os.listdir(self.path):
if os.path.islink("%s/%s" % (self.path, path)):
return os.path.basename(path)
raise RTSLibBrokenLink("Broken LUN in configFS, no storage object")
def _get_storage_object(self):
self._check_self()
alias_path = os.path.realpath("%s/%s" % (self.path, self.alias))
return tcm.StorageObject.so_from_path(alias_path)
def _get_parent_tpg(self):
return self._parent_tpg
def _get_lun(self):
return self._lun
def _list_mapped_luns(self):
self._check_self()
tpg = self.parent_tpg
if not tpg.has_feature('acls'):
return
for na in tpg.node_acls:
for mlun in na.mapped_luns:
if os.path.realpath("%s/%s" % (mlun.path, mlun.alias)) == self.path:
yield mlun
# pass through backends will not have setup all the default
# ALUA structs in the kernel. If the kernel has been setup,
# a user created group or default_tg_pt_gp will be returned.
# If the kernel was not properly setup an empty string is
# return in alua_tg_pt_gp. Writing to alua_tg_pt_gp will crash
# older kernels and will return a -Exyz code in newer ones.
def _get_alua_tg_pt_gp_name(self):
self._check_self()
storage_object = self._get_storage_object()
if storage_object.alua_supported is False:
return None
path = "%s/alua_tg_pt_gp" % self.path
try:
info = fread(path)
if not info:
return None
group_line = info.splitlines()[0]
return group_line.split(':')[1].strip()
except IOError as e:
return None
def _set_alua_tg_pt_gp_name(self, group_name):
self._check_self()
if not self._get_alua_tg_pt_gp_name():
return -1
path = "%s/alua_tg_pt_gp" % self.path
try:
fwrite(path, group_name)
except IOError as e:
return -1
return 0
# LUN public stuff
def delete(self):
'''
If the underlying configFS object does not exist, this method does
nothing. If the underlying configFS object exists, this method attempts
to delete it along with all MappedLUN objects referencing that LUN.
'''
self._check_self()
for mlun in self.mapped_luns:
mlun.delete()
try:
link = self.alias
except RTSLibBrokenLink:
pass
else:
if os.path.islink("%s/%s" % (self.path, link)):
os.unlink("%s/%s" % (self.path, link))
super(LUN, self).delete()
parent_tpg = property(_get_parent_tpg,
doc="Get the parent TPG object.")
lun = property(_get_lun,
doc="Get the LUN index as an int.")
storage_object = property(_get_storage_object,
doc="Get the storage object attached to the LUN.")
alias = property(_get_alias,
doc="Get the LUN alias.")
mapped_luns = property(_list_mapped_luns,
doc="List all MappedLUN objects referencing this LUN.")
alua_tg_pt_gp_name = property(_get_alua_tg_pt_gp_name, _set_alua_tg_pt_gp_name,
doc="Get and Set the LUN's ALUA Target Port Group")
@classmethod
def setup(cls, tpg_obj, lun, err_func):
if 'index' not in lun:
err_func("'index' missing from a LUN in TPG %d" % tpg_obj.tag)
return
try:
bs_name, so_name = lun['storage_object'].split('/')[2:]
except:
err_func("Malformed storage object field for LUN %d" % lun['index'])
return
for so in tcm.StorageObject.all():
if so_name == so.name and bs_name == so.plugin:
match_so = so
break
else:
err_func("Could not find matching StorageObject for LUN %d" % lun['index'])
return
try:
lun_obj = cls(tpg_obj, lun['index'], storage_object=match_so, alias=lun.get('alias'))
except (RTSLibError, KeyError):
err_func("Creating TPG %d LUN index %d failed" %
(tpg_obj.tag, lun['index']))
try:
lun_obj.alua_tg_pt_gp_name = lun['alua_tg_pt_gp_name']
except KeyError:
# alua_tg_pt_gp support not present in older versions
pass
def dump(self):
d = super(LUN, self).dump()
d['storage_object'] = "/backstores/%s/%s" % \
(self.storage_object.plugin, self.storage_object.name)
d['index'] = self.lun
d['alias'] = self.alias
d['alua_tg_pt_gp_name'] = self.alua_tg_pt_gp_name
return d
class NetworkPortal(CFSNode):
'''
This is an interface to NetworkPortals in configFS. A NetworkPortal is
identified by its IP and port, but here we also require the parent TPG, so
instance objects represent both the NetworkPortal and its association to a
TPG. This is necessary to get path information in order to create the
portal in the proper configFS hierarchy.
'''
# NetworkPortal private stuff
def __repr__(self):
return "<NetworkPortal %s port %s>" % (self.ip_address, self.port)
def __init__(self, parent_tpg, ip_address, port=3260, mode='any'):
'''
@param parent_tpg: The parent TPG object.
@type parent_tpg: TPG
@param ip_address: The ipv4/v6 IP address of the NetworkPortal. ipv6
addresses should be surrounded by '[]'.
@type ip_address: string
@param port: The optional (defaults to 3260) NetworkPortal TCP/IP port.
@type port: int
@param mode: An optionnal string containing the object creation mode:
- I{'any'} means the configFS object will be either looked up or
created.
- I{'lookup'} means the object MUST already exist configFS.
- I{'create'} means the object must NOT already exist in configFS.
@type mode:string
@return: A NetworkPortal object.
'''
super(NetworkPortal, self).__init__()
self._ip_address = str(ip_address)
try:
self._port = int(port)
except ValueError:
raise RTSLibError("Invalid port")
if isinstance(parent_tpg, TPG):
self._parent_tpg = parent_tpg
else:
raise RTSLibError("Invalid parent TPG")
self._path = "%s/np/%s:%d" \
% (self.parent_tpg.path, self.ip_address, self.port)
try:
self._create_in_cfs_ine(mode)
except OSError as msg:
raise RTSLibError(msg)
def _get_ip_address(self):
return self._ip_address
def _get_port(self):
return self._port
def _get_parent_tpg(self):
return self._parent_tpg
def _get_iser(self):
try:
return bool(int(fread("%s/iser" % self.path)))
except IOError:
return False
def _set_iser(self, boolean):
path = "%s/iser" % self.path
try:
fwrite(path, str(int(boolean)))
except IOError:
# b/w compat: don't complain if iser entry is missing
if os.path.isfile(path):
raise RTSLibError("Cannot change iser")
def _get_offload(self):
try:
# only offload at the moment is cxgbit
return bool(int(fread("%s/cxgbit" % self.path)))
except IOError:
return False
def _set_offload(self, boolean):
path = "%s/cxgbit" % self.path
try:
fwrite(path, str(int(boolean)))
except IOError:
# b/w compat: don't complain if cxgbit entry is missing
if os.path.isfile(path):
raise RTSLibError("Cannot change offload")
# NetworkPortal public stuff
def delete(self):
self.iser = False
self.offload = False
super(NetworkPortal, self).delete()
parent_tpg = property(_get_parent_tpg,
doc="Get the parent TPG object.")
port = property(_get_port,
doc="Get the NetworkPortal's TCP port as an int.")
ip_address = property(_get_ip_address,
doc="Get the NetworkPortal's IP address as a string.")
iser = property(_get_iser, _set_iser,
doc="Get or set a boolean value representing if this " \
+ "NetworkPortal supports iSER.")
offload = property(_get_offload, _set_offload,
doc="Get or set a boolean value representing if this " \
+ "NetworkPortal supports offload.")
@classmethod
def setup(cls, tpg_obj, p, err_func):
if 'ip_address' not in p:
err_func("'ip_address' field missing from a portal in TPG %d" % tpg_obj.tag)
return
if 'port' not in p:
err_func("'port' field missing from a portal in TPG %d" % tpg_obj.tag)
return
try:
np = cls(tpg_obj, p['ip_address'], p['port'])
np.iser = p.get('iser', False)
np.offload = p.get('offload', False)
except (RTSLibError, KeyError) as e:
err_func("Creating NetworkPortal object %s:%s failed: %s" %
(p['ip_address'], p['port'], e))
def dump(self):
d = super(NetworkPortal, self).dump()
d['port'] = self.port
d['ip_address'] = self.ip_address
d['iser'] = self.iser
d['offload'] = self.offload
return d
class NodeACL(CFSNode):
'''
This is an interface to node ACLs in configFS.
A NodeACL is identified by the initiator node wwn and parent TPG.
'''
# NodeACL private stuff
def __repr__(self):
return "<NodeACL %s>" % self.node_wwn
def __init__(self, parent_tpg, node_wwn, mode='any'):
'''
@param parent_tpg: The parent TPG object.
@type parent_tpg: TPG
@param node_wwn: The wwn of the initiator node for which the ACL is
created.
@type node_wwn: string
@param mode:An optionnal string containing the object creation mode:
- I{'any'} means the configFS object will be either looked up or
created.
- I{'lookup'} means the object MUST already exist configFS.
- I{'create'} means the object must NOT already exist in configFS.
@type mode:string
@return: A NodeACL object.
'''
super(NodeACL, self).__init__()
if isinstance(parent_tpg, TPG):
self._parent_tpg = parent_tpg
else:
raise RTSLibError("Invalid parent TPG")
fm = self.parent_tpg.parent_target.fabric_module
self._node_wwn, self.wwn_type = normalize_wwn(fm.wwn_types, node_wwn)
self._path = "%s/acls/%s" % (self.parent_tpg.path, fm.to_fabric_wwn(self.node_wwn))
self._create_in_cfs_ine(mode)
def _get_node_wwn(self):
return self._node_wwn
def _get_parent_tpg(self):
return self._parent_tpg
def _get_tcq_depth(self):
self._check_self()
path = "%s/cmdsn_depth" % self.path
return fread(path)
def _set_tcq_depth(self, depth):
self._check_self()
path = "%s/cmdsn_depth" % self.path
try:
fwrite(path, "%s" % depth)
except IOError as msg:
msg = msg[1]
raise RTSLibError("Cannot set tcq_depth: %s" % str(msg))
def _get_tag(self):
self._check_self()
try:
tag = fread("%s/tag" % self.path)
if tag:
return tag
return None
except IOError:
return None
def _set_tag(self, tag_str):
with ignored(IOError):
if tag_str is None:
fwrite("%s/tag" % self.path, 'NULL')
else:
fwrite("%s/tag" % self.path, tag_str)
def _list_mapped_luns(self):
self._check_self()
for mapped_lun_dir in glob("%s/lun_*" % self.path):
mapped_lun = int(os.path.basename(mapped_lun_dir).split("_")[1])
yield MappedLUN(self, mapped_lun)
def _get_session(self):
try:
lines = fread("%s/info" % self.path).splitlines()
except IOError:
return None
if lines[0].startswith("No active"):
return None
session = {}
for line in lines:
if line.startswith("InitiatorName:"):
session['parent_nodeacl'] = self
session['connections'] = []
elif line.startswith("InitiatorAlias:"):
session['alias'] = line.split(":")[1].strip()
elif line.startswith("LIO Session ID:"):
session['id'] = int(line.split(":")[1].split()[0])
session['type'] = line.split("SessionType:")[1].split()[0].strip()
elif "TARG_SESS_STATE_" in line:
session['state'] = line.split("_STATE_")[1].split()[0]
elif "TARG_CONN_STATE_" in line:
cid = int(line.split(":")[1].split()[0])
cstate = line.split("_STATE_")[1].split()[0]
session['connections'].append(dict(cid=cid, cstate=cstate))
elif "Address" in line:
session['connections'][-1]['address'] = line.split()[1]
session['connections'][-1]['transport'] = line.split()[2]
return session
# NodeACL public stuff
def has_feature(self, feature):
'''
Whether or not this NodeACL has a certain feature.
'''
return self.parent_tpg.has_feature(feature)
def delete(self):
'''
Delete the NodeACL, including all MappedLUN objects.
If the underlying configFS object does not exist, this method does
nothing.
'''
self._check_self()
for mapped_lun in self.mapped_luns:
mapped_lun.delete()
super(NodeACL, self).delete()
def mapped_lun(self, mapped_lun, tpg_lun=None, write_protect=None):
'''
Same as MappedLUN() but without the parent_nodeacl parameter.
'''
self._check_self()
return MappedLUN(self, mapped_lun=mapped_lun, tpg_lun=tpg_lun,
write_protect=write_protect)
tcq_depth = property(_get_tcq_depth, _set_tcq_depth,
doc="Set or get the TCQ depth for the initiator " \
+ "sessions matching this NodeACL.")
tag = property(_get_tag, _set_tag,
doc="Set or get the NodeACL tag. If not supported, return None")
parent_tpg = property(_get_parent_tpg,
doc="Get the parent TPG object.")
node_wwn = property(_get_node_wwn,
doc="Get the node wwn.")
mapped_luns = property(_list_mapped_luns,
doc="Get the list of all MappedLUN objects in this NodeACL.")
session = property(_get_session,
doc="Gives a snapshot of the current session or C{None}")
chap_userid = property(partial(_get_auth_attr, attribute='auth/userid'),
partial(_set_auth_attr, attribute='auth/userid'),
doc="Set or get the initiator CHAP auth userid.")
chap_password = property(partial(_get_auth_attr, attribute='auth/password'),
partial(_set_auth_attr, attribute='auth/password',),
doc="Set or get the initiator CHAP auth password.")
chap_mutual_userid = property(partial(_get_auth_attr, attribute='auth/userid_mutual'),