locking.py 30.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# 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
# General Public License for more details.
#
# You should have received a copy of the GNU 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.

"""Module implementing the Ganeti locking code."""

import threading
24

25
from ganeti import errors
26
from ganeti import utils
27
28


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def ssynchronized(lock, shared=0):
  """Shared Synchronization decorator.

  Calls the function holding the given lock, either in exclusive or shared
  mode. It requires the passed lock to be a SharedLock (or support its
  semantics).

  """
  def wrap(fn):
    def sync_function(*args, **kwargs):
      lock.acquire(shared=shared)
      try:
        return fn(*args, **kwargs)
      finally:
        lock.release()
    return sync_function
  return wrap


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
class _CountingCondition(object):
  """Wrapper for Python's built-in threading.Condition class.

  This wrapper keeps a count of active waiters. We can't access the internal
  "__waiters" attribute of threading.Condition because it's not thread-safe.

  """
  __slots__ = [
    "_cond",
    "_nwaiters",
    ]

  def __init__(self, lock):
    """Initializes this class.

    """
    object.__init__(self)
    self._cond = threading.Condition(lock=lock)
    self._nwaiters = 0

  def notifyAll(self):
    """Notifies the condition.

    """
    return self._cond.notifyAll()

  def wait(self, timeout=None):
    """Waits for the condition to be notified.

    @type timeout: float or None
    @param timeout: Timeout in seconds

    """
    assert self._nwaiters >= 0

    self._nwaiters += 1
    try:
      return self._cond.wait(timeout=timeout)
    finally:
      self._nwaiters -= 1

  def has_waiting(self):
    """Returns whether there are active waiters.

    """
    return bool(self._nwaiters)


class SharedLock(object):
97
98
99
100
101
102
103
104
105
106
107
  """Implements a shared lock.

  Multiple threads can acquire the lock in a shared way, calling
  acquire_shared().  In order to acquire the lock in an exclusive way threads
  can call acquire_exclusive().

  The lock prevents starvation but does not guarantee that threads will acquire
  the shared lock in the order they queued for it, just that they will
  eventually do so.

  """
108
109
110
111
112
113
114
115
116
117
118
119
  __slots__ = [
    "__active_shr_c",
    "__inactive_shr_c",
    "__deleted",
    "__exc",
    "__lock",
    "__pending",
    "__shr",
    ]

  __condition_class = _CountingCondition

120
  def __init__(self):
121
122
123
124
125
126
    """Construct a new SharedLock.

    """
    object.__init__(self)

    # Internal lock
127
128
    self.__lock = threading.Lock()

129
130
131
132
133
134
135
136
    # Queue containing waiting acquires
    self.__pending = []

    # Active and inactive conditions for shared locks
    self.__active_shr_c = self.__condition_class(self.__lock)
    self.__inactive_shr_c = self.__condition_class(self.__lock)

    # Current lock holders
137
138
139
    self.__shr = set()
    self.__exc = None

140
141
142
    # is this lock in the deleted state?
    self.__deleted = False

143
144
145
146
147
148
149
  def __check_deleted(self):
    """Raises an exception if the lock has been deleted.

    """
    if self.__deleted:
      raise errors.LockError("Deleted lock")

150
  def __is_sharer(self):
151
152
153
    """Is the current thread sharing the lock at this time?

    """
154
155
156
    return threading.currentThread() in self.__shr

  def __is_exclusive(self):
157
158
159
    """Is the current thread holding the lock exclusively at this time?

    """
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    return threading.currentThread() == self.__exc

  def __is_owned(self, shared=-1):
    """Is the current thread somehow owning the lock at this time?

    This is a private version of the function, which presumes you're holding
    the internal lock.

    """
    if shared < 0:
      return self.__is_sharer() or self.__is_exclusive()
    elif shared:
      return self.__is_sharer()
    else:
      return self.__is_exclusive()

  def _is_owned(self, shared=-1):
    """Is the current thread somehow owning the lock at this time?

Iustin Pop's avatar
Iustin Pop committed
179
180
181
182
    @param shared:
        - < 0: check for any type of ownership (default)
        - 0: check for exclusive ownership
        - > 0: check for shared ownership
183
184
185
186

    """
    self.__lock.acquire()
    try:
187
      return self.__is_owned(shared=shared)
188
189
190
    finally:
      self.__lock.release()

191
192
  def _count_pending(self):
    """Returns the number of pending acquires.
193

194
    @rtype: int
195
196

    """
197
198
199
200
201
    self.__lock.acquire()
    try:
      return len(self.__pending)
    finally:
      self.__lock.release()
202

203
204
205
206
207
208
209
210
  def __do_acquire(self, shared):
    """Actually acquire the lock.

    """
    if shared:
      self.__shr.add(threading.currentThread())
    else:
      self.__exc = threading.currentThread()
211

212
213
  def __can_acquire(self, shared):
    """Determine whether lock can be acquired.
214
215

    """
216
217
218
219
    if shared:
      return self.__exc is None
    else:
      return len(self.__shr) == 0 and self.__exc is None
220

221
222
  def __is_on_top(self, cond):
    """Checks whether the passed condition is on top of the queue.
223

224
    The caller must make sure the queue isn't empty.
225

226
227
    """
    return self.__pending[0] == cond
Guido Trotter's avatar
Guido Trotter committed
228

229
230
  def __acquire_unlocked(self, shared=0, timeout=None):
    """Acquire a shared lock.
231

232
233
234
    @param shared: whether to acquire in shared mode; by default an
        exclusive lock will be acquired
    @param timeout: maximum waiting time before giving up
235
236

    """
237
    self.__check_deleted()
238

239
240
241
242
243
244
245
246
    # We cannot acquire the lock if we already have it
    assert not self.__is_owned(), "double acquire() on a non-recursive lock"

    # Check whether someone else holds the lock or there are pending acquires.
    if not self.__pending and self.__can_acquire(shared):
      # Apparently not, can acquire lock directly.
      self.__do_acquire(shared)
      return True
247

248
249
    if shared:
      wait_condition = self.__active_shr_c
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
      # Check if we're not yet in the queue
      if wait_condition not in self.__pending:
        self.__pending.append(wait_condition)
    else:
      wait_condition = self.__condition_class(self.__lock)
      # Always add to queue
      self.__pending.append(wait_condition)

    try:
      # Wait until we become the topmost acquire in the queue or the timeout
      # expires.
      while not (self.__is_on_top(wait_condition) and
                 self.__can_acquire(shared)):
        # Wait for notification
        wait_condition.wait(timeout)
        self.__check_deleted()

        # A lot of code assumes blocking acquires always succeed. Loop
        # internally for that case.
        if timeout is not None:
          break

      if self.__is_on_top(wait_condition) and self.__can_acquire(shared):
        self.__do_acquire(shared)
        return True
276
    finally:
277
278
279
      # Remove condition from queue if there are no more waiters
      if not wait_condition.has_waiting() and not self.__deleted:
        self.__pending.remove(wait_condition)
280

281
    return False
282

283
  def acquire(self, shared=0, timeout=None):
284
285
    """Acquire a shared lock.

286
    @type shared: int
Iustin Pop's avatar
Iustin Pop committed
287
288
    @param shared: whether to acquire in shared mode; by default an
        exclusive lock will be acquired
289
290
    @type timeout: float
    @param timeout: maximum waiting time before giving up
291
292
293
294

    """
    self.__lock.acquire()
    try:
295
      return self.__acquire_unlocked(shared, timeout)
296
297
298
299
300
301
302
303
304
305
306
307
    finally:
      self.__lock.release()

  def release(self):
    """Release a Shared Lock.

    You must have acquired the lock, either in shared or in exclusive mode,
    before calling this function.

    """
    self.__lock.acquire()
    try:
308
309
310
      assert self.__is_exclusive() or self.__is_sharer(), \
        "Cannot release non-owned lock"

311
312
313
      # Autodetect release type
      if self.__is_exclusive():
        self.__exc = None
314
      else:
315
316
        self.__shr.remove(threading.currentThread())

317
318
319
320
      # Notify topmost condition in queue
      if self.__pending:
        first_condition = self.__pending[0]
        first_condition.notifyAll()
Guido Trotter's avatar
Guido Trotter committed
321

322
323
324
        if first_condition == self.__active_shr_c:
          self.__active_shr_c = self.__inactive_shr_c
          self.__inactive_shr_c = first_condition
325
326
327
328

    finally:
      self.__lock.release()

329
  def delete(self, timeout=None):
330
331
332
333
334
335
    """Delete a Shared Lock.

    This operation will declare the lock for removal. First the lock will be
    acquired in exclusive mode if you don't already own it, then the lock
    will be put in a state where any future and pending acquire() fail.

336
337
    @type timeout: float
    @param timeout: maximum waiting time before giving up
338
339
340
341

    """
    self.__lock.acquire()
    try:
342
343
344
      assert not self.__is_sharer(), "Cannot delete() a lock while sharing it"

      self.__check_deleted()
345

346
347
      # The caller is allowed to hold the lock exclusively already.
      acquired = self.__is_exclusive()
348

349
350
351
352
353
354
      if not acquired:
        acquired = self.__acquire_unlocked(timeout)

      if acquired:
        self.__deleted = True
        self.__exc = None
355

356
357
358
        # Notify all acquires. They'll throw an error.
        while self.__pending:
          self.__pending.pop().notifyAll()
359

360
      return acquired
361
362
363
    finally:
      self.__lock.release()

364

365
# Whenever we want to acquire a full LockSet we pass None as the value
Michael Hanselmann's avatar
Michael Hanselmann committed
366
# to acquire.  Hide this behind this nicely named constant.
367
368
369
ALL_SET = None


370
371
372
373
374
375
376
377
378
379
380
381
382
383
class LockSet:
  """Implements a set of locks.

  This abstraction implements a set of shared locks for the same resource type,
  distinguished by name. The user can lock a subset of the resources and the
  LockSet will take care of acquiring the locks always in the same order, thus
  preventing deadlock.

  All the locks needed in the same set must be acquired together, though.

  """
  def __init__(self, members=None):
    """Constructs a new LockSet.

Iustin Pop's avatar
Iustin Pop committed
384
    @param members: initial members of the set
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

    """
    # Used internally to guarantee coherency.
    self.__lock = SharedLock()

    # The lockdict indexes the relationship name -> lock
    # The order-of-locking is implied by the alphabetical order of names
    self.__lockdict = {}

    if members is not None:
      for name in members:
        self.__lockdict[name] = SharedLock()

    # The owner dict contains the set of locks each thread owns. For
    # performance each thread can access its own key without a global lock on
    # this structure. It is paramount though that *no* other type of access is
    # done to this structure (eg. no looping over its keys). *_owner helper
    # function are defined to guarantee access is correct, but in general never
    # do anything different than __owners[threading.currentThread()], or there
    # will be trouble.
    self.__owners = {}

  def _is_owned(self):
    """Is the current thread a current level owner?"""
    return threading.currentThread() in self.__owners

Guido Trotter's avatar
Guido Trotter committed
411
  def _add_owned(self, name=None):
412
    """Note the current thread owns the given lock"""
Guido Trotter's avatar
Guido Trotter committed
413
414
415
    if name is None:
      if not self._is_owned():
        self.__owners[threading.currentThread()] = set()
416
    else:
Guido Trotter's avatar
Guido Trotter committed
417
418
419
420
421
422
      if self._is_owned():
        self.__owners[threading.currentThread()].add(name)
      else:
        self.__owners[threading.currentThread()] = set([name])

  def _del_owned(self, name=None):
423
424
    """Note the current thread owns the given lock"""

Guido Trotter's avatar
Guido Trotter committed
425
426
427
428
429
430
    if name is not None:
      self.__owners[threading.currentThread()].remove(name)

    # Only remove the key if we don't hold the set-lock as well
    if (not self.__lock._is_owned() and
        not self.__owners[threading.currentThread()]):
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
      del self.__owners[threading.currentThread()]

  def _list_owned(self):
    """Get the set of resource names owned by the current thread"""
    if self._is_owned():
      return self.__owners[threading.currentThread()].copy()
    else:
      return set()

  def __names(self):
    """Return the current set of names.

    Only call this function while holding __lock and don't iterate on the
    result after releasing the lock.

    """
447
    return self.__lockdict.keys()
448
449
450
451
452

  def _names(self):
    """Return a copy of the current set of elements.

    Used only for debugging purposes.
453

454
    """
455
456
457
458
459
460
    # If we don't already own the set-level lock acquired
    # we'll get it and note we need to release it later.
    release_lock = False
    if not self.__lock._is_owned():
      release_lock = True
      self.__lock.acquire(shared=1)
461
462
463
    try:
      result = self.__names()
    finally:
464
465
      if release_lock:
        self.__lock.release()
466
    return set(result)
467
468
469
470

  def acquire(self, names, blocking=1, shared=0):
    """Acquire a set of resource locks.

Iustin Pop's avatar
Iustin Pop committed
471
472
473
474
475
476
    @param names: the names of the locks which shall be acquired
        (special lock names, or instance/node names)
    @param shared: whether to acquire in shared mode; by default an
        exclusive lock will be acquired
    @param blocking: whether to block while trying to acquire or to
        operate in try-lock mode (this locking mode is not supported yet)
477

Iustin Pop's avatar
Iustin Pop committed
478
    @return: True when all the locks are successfully acquired
479

Iustin Pop's avatar
Iustin Pop committed
480
481
482
    @raise errors.LockError: when any lock we try to acquire has
        been deleted before we succeed. In this case none of the
        locks requested will be acquired.
483
484
485
486
487
488
489
490
491

    """
    if not blocking:
      # We don't have non-blocking mode for now
      raise NotImplementedError

    # Check we don't already own locks at this level
    assert not self._is_owned(), "Cannot acquire locks in the same set twice"

492
493
494
495
496
497
498
499
500
501
502
    if names is None:
      # If no names are given acquire the whole set by not letting new names
      # being added before we release, and getting the current list of names.
      # Some of them may then be deleted later, but we'll cope with this.
      #
      # We'd like to acquire this lock in a shared way, as it's nice if
      # everybody else can use the instances at the same time. If are acquiring
      # them exclusively though they won't be able to do this anyway, though,
      # so we'll get the list lock exclusively as well in order to be able to
      # do add() on the set while owning it.
      self.__lock.acquire(shared=shared)
Guido Trotter's avatar
Guido Trotter committed
503
504
505
506
507
508
509
510
511
512
      try:
        # note we own the set-lock
        self._add_owned()
        names = self.__names()
      except:
        # We shouldn't have problems adding the lock to the owners list, but
        # if we did we'll try to release this lock and re-raise exception.
        # Of course something is going to be really wrong, after this.
        self.__lock.release()
        raise
513

514
515
516
517
518
    try:
      # Support passing in a single resource to acquire rather than many
      if isinstance(names, basestring):
        names = [names]
      else:
519
        names = sorted(names)
520
521
522
523
524

      acquire_list = []
      # First we look the locks up on __lockdict. We have no way of being sure
      # they will still be there after, but this makes it a lot faster should
      # just one of them be the already wrong
525
      for lname in utils.UniqueSequence(names):
526
        try:
527
          lock = self.__lockdict[lname] # raises KeyError if lock is not there
528
529
          acquire_list.append((lname, lock))
        except (KeyError):
530
          if self.__lock._is_owned():
531
532
            # We are acquiring all the set, it doesn't matter if this
            # particular element is not there anymore.
533
534
535
            continue
          else:
            raise errors.LockError('non-existing lock in set (%s)' % lname)
536
537
538
539
540
541
542
543

      # This will hold the locknames we effectively acquired.
      acquired = set()
      # Now acquire_list contains a sorted list of resources and locks we want.
      # In order to get them we loop on this (private) list and acquire() them.
      # We gave no real guarantee they will still exist till this is done but
      # .acquire() itself is safe and will alert us if the lock gets deleted.
      for (lname, lock) in acquire_list:
544
        try:
545
          lock.acquire(shared=shared) # raises LockError if the lock is deleted
546
          # now the lock cannot be deleted, we have it!
Guido Trotter's avatar
Guido Trotter committed
547
          self._add_owned(name=lname)
548
          acquired.add(lname)
549
        except (errors.LockError):
550
          if self.__lock._is_owned():
551
552
            # We are acquiring all the set, it doesn't matter if this
            # particular element is not there anymore.
553
554
555
556
557
            continue
          else:
            name_fail = lname
            for lname in self._list_owned():
              self.__lockdict[lname].release()
Guido Trotter's avatar
Guido Trotter committed
558
              self._del_owned(name=lname)
559
            raise errors.LockError('non-existing lock in set (%s)' % name_fail)
560
561
562
563
564
565
        except:
          # We shouldn't have problems adding the lock to the owners list, but
          # if we did we'll try to release this lock and re-raise exception.
          # Of course something is going to be really wrong, after this.
          if lock._is_owned():
            lock.release()
566
          raise
567
568

    except:
569
570
571
      # If something went wrong and we had the set-lock let's release it...
      if self.__lock._is_owned():
        self.__lock.release()
572
      raise
573

574
    return acquired
575
576
577
578
579
580
581

  def release(self, names=None):
    """Release a set of resource locks, at the same level.

    You must have acquired the locks, either in shared or in exclusive mode,
    before releasing them.

Iustin Pop's avatar
Iustin Pop committed
582
583
    @param names: the names of the locks which shall be released
        (defaults to all the locks acquired at that level).
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599

    """
    assert self._is_owned(), "release() on lock set while not owner"

    # Support passing in a single resource to release rather than many
    if isinstance(names, basestring):
      names = [names]

    if names is None:
      names = self._list_owned()
    else:
      names = set(names)
      assert self._list_owned().issuperset(names), (
               "release() on unheld resources %s" %
               names.difference(self._list_owned()))

600
601
602
603
    # First of all let's release the "all elements" lock, if set.
    # After this 'add' can work again
    if self.__lock._is_owned():
      self.__lock.release()
Guido Trotter's avatar
Guido Trotter committed
604
      self._del_owned()
605

606
607
608
609
    for lockname in names:
      # If we are sure the lock doesn't leave __lockdict without being
      # exclusively held we can do this...
      self.__lockdict[lockname].release()
Guido Trotter's avatar
Guido Trotter committed
610
      self._del_owned(name=lockname)
611
612
613
614

  def add(self, names, acquired=0, shared=0):
    """Add a new set of elements to the set

Iustin Pop's avatar
Iustin Pop committed
615
616
617
    @param names: names of the new elements to add
    @param acquired: pre-acquire the new resource?
    @param shared: is the pre-acquisition shared?
618
619

    """
620
621
622
    # Check we don't already own locks at this level
    assert not self._is_owned() or self.__lock._is_owned(shared=0), \
      "Cannot add locks if the set is only partially owned, or shared"
623

624
625
626
627
    # Support passing in a single resource to add rather than many
    if isinstance(names, basestring):
      names = [names]

628
    # If we don't already own the set-level lock acquired in an exclusive way
629
630
631
632
633
634
    # we'll get it and note we need to release it later.
    release_lock = False
    if not self.__lock._is_owned():
      release_lock = True
      self.__lock.acquire()

635
    try:
636
      invalid_names = set(self.__names()).intersection(names)
637
638
639
640
641
642
643
644
645
646
647
648
649
      if invalid_names:
        # This must be an explicit raise, not an assert, because assert is
        # turned off when using optimization, and this can happen because of
        # concurrency even if the user doesn't want it.
        raise errors.LockError("duplicate add() (%s)" % invalid_names)

      for lockname in names:
        lock = SharedLock()

        if acquired:
          lock.acquire(shared=shared)
          # now the lock cannot be deleted, we have it!
          try:
Guido Trotter's avatar
Guido Trotter committed
650
            self._add_owned(name=lockname)
651
652
653
654
655
656
657
658
659
660
661
662
663
          except:
            # We shouldn't have problems adding the lock to the owners list,
            # but if we did we'll try to release this lock and re-raise
            # exception.  Of course something is going to be really wrong,
            # after this.  On the other hand the lock hasn't been added to the
            # __lockdict yet so no other threads should be pending on it. This
            # release is just a safety measure.
            lock.release()
            raise

        self.__lockdict[lockname] = lock

    finally:
664
665
666
      # Only release __lock if we were not holding it previously.
      if release_lock:
        self.__lock.release()
667
668
669
670
671
672
673
674
675

    return True

  def remove(self, names, blocking=1):
    """Remove elements from the lock set.

    You can either not hold anything in the lockset or already hold a superset
    of the elements you want to delete, exclusively.

Iustin Pop's avatar
Iustin Pop committed
676
677
678
679
    @param names: names of the resource to remove.
    @param blocking: whether to block while trying to acquire or to
        operate in try-lock mode (this locking mode is not supported
        yet unless you are already holding exclusively the locks)
680

Iustin Pop's avatar
Iustin Pop committed
681
682
683
    @return:: a list of locks which we removed; the list is always
        equal to the names list if we were holding all the locks
        exclusively
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699

    """
    if not blocking and not self._is_owned():
      # We don't have non-blocking mode for now
      raise NotImplementedError

    # Support passing in a single resource to remove rather than many
    if isinstance(names, basestring):
      names = [names]

    # If we own any subset of this lock it must be a superset of what we want
    # to delete. The ownership must also be exclusive, but that will be checked
    # by the lock itself.
    assert not self._is_owned() or self._list_owned().issuperset(names), (
      "remove() on acquired lockset while not owning all elements")

Guido Trotter's avatar
Guido Trotter committed
700
    removed = []
701
702
703
704
705
706
707
708
709

    for lname in names:
      # Calling delete() acquires the lock exclusively if we don't already own
      # it, and causes all pending and subsequent lock acquires to fail. It's
      # fine to call it out of order because delete() also implies release(),
      # and the assertion above guarantees that if we either already hold
      # everything we want to delete, or we hold none.
      try:
        self.__lockdict[lname].delete()
Guido Trotter's avatar
Guido Trotter committed
710
        removed.append(lname)
711
712
713
714
715
716
717
718
719
720
721
722
723
724
      except (KeyError, errors.LockError):
        # This cannot happen if we were already holding it, verify:
        assert not self._is_owned(), "remove failed while holding lockset"
      else:
        # If no LockError was raised we are the ones who deleted the lock.
        # This means we can safely remove it from lockdict, as any further or
        # pending delete() or acquire() will fail (and nobody can have the lock
        # since before our call to delete()).
        #
        # This is done in an else clause because if the exception was thrown
        # it's the job of the one who actually deleted it.
        del self.__lockdict[lname]
        # And let's remove it from our private list if we owned it.
        if self._is_owned():
Guido Trotter's avatar
Guido Trotter committed
725
          self._del_owned(name=lname)
726

Guido Trotter's avatar
Guido Trotter committed
727
    return removed
728

729
730
731
732
733
734
735
736
737
738
739

# Locking levels, must be acquired in increasing order.
# Current rules are:
#   - at level LEVEL_CLUSTER resides the Big Ganeti Lock (BGL) which must be
#   acquired before performing any operation, either in shared or in exclusive
#   mode. acquiring the BGL in exclusive mode is discouraged and should be
#   avoided.
#   - at levels LEVEL_NODE and LEVEL_INSTANCE reside node and instance locks.
#   If you need more than one node, or more than one instance, acquire them at
#   the same time.
LEVEL_CLUSTER = 0
740
741
LEVEL_INSTANCE = 1
LEVEL_NODE = 2
742
743

LEVELS = [LEVEL_CLUSTER,
744
745
          LEVEL_INSTANCE,
          LEVEL_NODE]
746
747
748
749

# Lock levels which are modifiable
LEVELS_MOD = [LEVEL_NODE, LEVEL_INSTANCE]

750
751
752
753
754
755
LEVEL_NAMES = {
  LEVEL_CLUSTER: "cluster",
  LEVEL_INSTANCE: "instance",
  LEVEL_NODE: "node",
  }

756
# Constant for the big ganeti lock
757
758
759
760
761
762
BGL = 'BGL'


class GanetiLockManager:
  """The Ganeti Locking Library

Michael Hanselmann's avatar
Michael Hanselmann committed
763
  The purpose of this small library is to manage locking for ganeti clusters
764
765
766
767
768
769
770
771
772
773
  in a central place, while at the same time doing dynamic checks against
  possible deadlocks. It will also make it easier to transition to a different
  lock type should we migrate away from python threads.

  """
  _instance = None

  def __init__(self, nodes=None, instances=None):
    """Constructs a new GanetiLockManager object.

774
775
    There should be only a GanetiLockManager object at any time, so this
    function raises an error if this is not the case.
776

Iustin Pop's avatar
Iustin Pop committed
777
778
    @param nodes: list of node names
    @param instances: list of instance names
779
780

    """
Iustin Pop's avatar
Iustin Pop committed
781
782
783
    assert self.__class__._instance is None, \
           "double GanetiLockManager instance"

784
785
786
787
788
789
790
791
792
793
794
795
796
    self.__class__._instance = self

    # The keyring contains all the locks, at their level and in the correct
    # locking order.
    self.__keyring = {
      LEVEL_CLUSTER: LockSet([BGL]),
      LEVEL_NODE: LockSet(nodes),
      LEVEL_INSTANCE: LockSet(instances),
    }

  def _names(self, level):
    """List the lock names at the given level.

Iustin Pop's avatar
Iustin Pop committed
797
798
799
    This can be used for debugging/testing purposes.

    @param level: the level whose list of locks to get
800
801
802
803
804
805
806
807
808
809
810

    """
    assert level in LEVELS, "Invalid locking level %s" % level
    return self.__keyring[level]._names()

  def _is_owned(self, level):
    """Check whether we are owning locks at the given level

    """
    return self.__keyring[level]._is_owned()

811
812
  is_owned = _is_owned

813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
  def _list_owned(self, level):
    """Get the set of owned locks at the given level

    """
    return self.__keyring[level]._list_owned()

  def _upper_owned(self, level):
    """Check that we don't own any lock at a level greater than the given one.

    """
    # This way of checking only works if LEVELS[i] = i, which we check for in
    # the test cases.
    return utils.any((self._is_owned(l) for l in LEVELS[level + 1:]))

  def _BGL_owned(self):
    """Check if the current thread owns the BGL.

    Both an exclusive or a shared acquisition work.

    """
    return BGL in self.__keyring[LEVEL_CLUSTER]._list_owned()

  def _contains_BGL(self, level, names):
Iustin Pop's avatar
Iustin Pop committed
836
837
838
839
    """Check if the level contains the BGL.

    Check if acting on the given level and set of names will change
    the status of the Big Ganeti Lock.
840
841
842
843
844
845
846

    """
    return level == LEVEL_CLUSTER and (names is None or BGL in names)

  def acquire(self, level, names, blocking=1, shared=0):
    """Acquire a set of resource locks, at the same level.

Iustin Pop's avatar
Iustin Pop committed
847
    @param level: the level at which the locks shall be acquired;
Michael Hanselmann's avatar
Michael Hanselmann committed
848
        it must be a member of LEVELS.
Iustin Pop's avatar
Iustin Pop committed
849
850
851
852
853
854
    @param names: the names of the locks which shall be acquired
        (special lock names, or instance/node names)
    @param shared: whether to acquire in shared mode; by default
        an exclusive lock will be acquired
    @param blocking: whether to block while trying to acquire or to
        operate in try-lock mode (this locking mode is not supported yet)
855
856
857
858
859
860
861
862
863
864
865
866
867
868

    """
    assert level in LEVELS, "Invalid locking level %s" % level

    # Check that we are either acquiring the Big Ganeti Lock or we already own
    # it. Some "legacy" opcodes need to be sure they are run non-concurrently
    # so even if we've migrated we need to at least share the BGL to be
    # compatible with them. Of course if we own the BGL exclusively there's no
    # point in acquiring any other lock, unless perhaps we are half way through
    # the migration of the current opcode.
    assert (self._contains_BGL(level, names) or self._BGL_owned()), (
            "You must own the Big Ganeti Lock before acquiring any other")

    # Check we don't own locks at the same or upper levels.
869
    assert not self._upper_owned(level), ("Cannot acquire locks at a level"
870
871
872
873
874
875
876
877
878
           " while owning some at a greater one")

    # Acquire the locks in the set.
    return self.__keyring[level].acquire(names, shared=shared,
                                         blocking=blocking)

  def release(self, level, names=None):
    """Release a set of resource locks, at the same level.

Iustin Pop's avatar
Iustin Pop committed
879
880
    You must have acquired the locks, either in shared or in exclusive
    mode, before releasing them.
881

Iustin Pop's avatar
Iustin Pop committed
882
    @param level: the level at which the locks shall be released;
Michael Hanselmann's avatar
Michael Hanselmann committed
883
        it must be a member of LEVELS
Iustin Pop's avatar
Iustin Pop committed
884
885
    @param names: the names of the locks which shall be released
        (defaults to all the locks acquired at that level)
886
887
888
889
890
891
892
893
894
895
896
897
898
899

    """
    assert level in LEVELS, "Invalid locking level %s" % level
    assert (not self._contains_BGL(level, names) or
            not self._upper_owned(LEVEL_CLUSTER)), (
            "Cannot release the Big Ganeti Lock while holding something"
            " at upper levels")

    # Release will complain if we don't own the locks already
    return self.__keyring[level].release(names)

  def add(self, level, names, acquired=0, shared=0):
    """Add locks at the specified level.

Iustin Pop's avatar
Iustin Pop committed
900
    @param level: the level at which the locks shall be added;
Michael Hanselmann's avatar
Michael Hanselmann committed
901
        it must be a member of LEVELS_MOD.
Iustin Pop's avatar
Iustin Pop committed
902
903
904
905
    @param names: names of the locks to acquire
    @param acquired: whether to acquire the newly added locks
    @param shared: whether the acquisition will be shared

906
907
908
909
910
911
912
913
914
915
916
    """
    assert level in LEVELS_MOD, "Invalid or immutable level %s" % level
    assert self._BGL_owned(), ("You must own the BGL before performing other"
           " operations")
    assert not self._upper_owned(level), ("Cannot add locks at a level"
           " while owning some at a greater one")
    return self.__keyring[level].add(names, acquired=acquired, shared=shared)

  def remove(self, level, names, blocking=1):
    """Remove locks from the specified level.

Iustin Pop's avatar
Iustin Pop committed
917
918
    You must either already own the locks you are trying to remove
    exclusively or not own any lock at an upper level.
919

Iustin Pop's avatar
Iustin Pop committed
920
921
922
923
924
925
    @param level: the level at which the locks shall be removed;
        it must be a member of LEVELS_MOD
    @param names: the names of the locks which shall be removed
        (special lock names, or instance/node names)
    @param blocking: whether to block while trying to operate in
        try-lock mode (this locking mode is not supported yet)
926
927
928
929
930

    """
    assert level in LEVELS_MOD, "Invalid or immutable level %s" % level
    assert self._BGL_owned(), ("You must own the BGL before performing other"
           " operations")
931
932
933
    # Check we either own the level or don't own anything from here
    # up. LockSet.remove() will check the case in which we don't own
    # all the needed resources, or we have a shared ownership.
934
935
936
    assert self._is_owned(level) or not self._upper_owned(level), (
           "Cannot remove locks at a level while not owning it or"
           " owning some at a greater one")
937
    return self.__keyring[level].remove(names, blocking=blocking)