locking.py 29.7 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
24
25
#
#

# 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."""

# pylint: disable-msg=W0613,W0201

import threading
26
27
28
# Wouldn't it be better to define LockingError in the locking module?
# Well, for now that's how the rest of the code does it...
from ganeti import errors
29
from ganeti import utils
30
31


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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


51
52
53
54
55
56
57
58
59
60
61
62
63
class SharedLock:
  """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.

  """
  def __init__(self):
64
    """Construct a new SharedLock"""
65
66
67
68
69
70
71
72
73
74
75
76
    # we have two conditions, c_shr and c_exc, sharing the same lock.
    self.__lock = threading.Lock()
    self.__turn_shr = threading.Condition(self.__lock)
    self.__turn_exc = threading.Condition(self.__lock)

    # current lock holders
    self.__shr = set()
    self.__exc = None

    # lock waiters
    self.__nwait_exc = 0
    self.__nwait_shr = 0
Guido Trotter's avatar
Guido Trotter committed
77
    self.__npass_shr = 0
78

79
80
81
    # is this lock in the deleted state?
    self.__deleted = False

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
  def __is_sharer(self):
    """Is the current thread sharing the lock at this time?"""
    return threading.currentThread() in self.__shr

  def __is_exclusive(self):
    """Is the current thread holding the lock exclusively at this time?"""
    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
107
108
109
110
    @param shared:
        - < 0: check for any type of ownership (default)
        - 0: check for exclusive ownership
        - > 0: check for shared ownership
111
112
113
114

    """
    self.__lock.acquire()
    try:
115
      result = self.__is_owned(shared=shared)
116
117
118
119
120
    finally:
      self.__lock.release()

    return result

121
  def __wait(self, c):
122
123
124
    """Wait on the given condition, and raise an exception if the current lock
    is declared deleted in the meantime.

Iustin Pop's avatar
Iustin Pop committed
125
    @param c: the condition to wait on
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

    """
    c.wait()
    if self.__deleted:
      raise errors.LockError('deleted lock')

  def __exclusive_acquire(self):
    """Acquire the lock exclusively.

    This is a private function that presumes you are already holding the
    internal lock. It's defined separately to avoid code duplication between
    acquire() and delete()

    """
    self.__nwait_exc += 1
    try:
      # This is to save ourselves from a nasty race condition that could
      # theoretically make the sharers starve.
      if self.__nwait_shr > 0 or self.__nwait_exc > 1:
        self.__wait(self.__turn_exc)

      while len(self.__shr) > 0 or self.__exc is not None:
        self.__wait(self.__turn_exc)

      self.__exc = threading.currentThread()
    finally:
      self.__nwait_exc -= 1

Guido Trotter's avatar
Guido Trotter committed
154
155
    assert self.__npass_shr == 0, "SharedLock: internal fairness violation"

156
157
158
  def acquire(self, blocking=1, shared=0):
    """Acquire a shared lock.

Iustin Pop's avatar
Iustin Pop committed
159
160
161
162
    @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)
163
164
165
166
167
168
169
170

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

    self.__lock.acquire()
    try:
171
172
173
      if self.__deleted:
        raise errors.LockError('deleted lock')

174
175
      # We cannot acquire the lock if we already have it
      assert not self.__is_owned(), "double acquire() on a non-recursive lock"
Guido Trotter's avatar
Guido Trotter committed
176
      assert self.__npass_shr >= 0, "Internal fairness condition weirdness"
177
178
179
180

      if shared:
        self.__nwait_shr += 1
        try:
Guido Trotter's avatar
Guido Trotter committed
181
          wait = False
182
183
184
185
186
          # If there is an exclusive holder waiting we have to wait.  We'll
          # only do this once, though, when we start waiting for the lock. Then
          # we'll just wait while there are no exclusive holders.
          if self.__nwait_exc > 0:
            # TODO: if !blocking...
Guido Trotter's avatar
Guido Trotter committed
187
            wait = True
188
            self.__wait(self.__turn_shr)
189
190

          while self.__exc is not None:
Guido Trotter's avatar
Guido Trotter committed
191
            wait = True
192
            # TODO: if !blocking...
193
            self.__wait(self.__turn_shr)
194
195

          self.__shr.add(threading.currentThread())
Guido Trotter's avatar
Guido Trotter committed
196
197
198
199
200

          # If we were waiting note that we passed
          if wait:
            self.__npass_shr -= 1

201
202
203
        finally:
          self.__nwait_shr -= 1

Guido Trotter's avatar
Guido Trotter committed
204
        assert self.__npass_shr >= 0, "Internal fairness condition weirdness"
205
      else:
206
207
208
        # TODO: if !blocking...
        # (or modify __exclusive_acquire for non-blocking mode)
        self.__exclusive_acquire()
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

    finally:
      self.__lock.release()

    return True

  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:
Guido Trotter's avatar
Guido Trotter committed
224
      assert self.__npass_shr >= 0, "Internal fairness condition weirdness"
225
226
227
228
229
230
231
232
      # Autodetect release type
      if self.__is_exclusive():
        self.__exc = None

        # An exclusive holder has just had the lock, time to put it in shared
        # mode if there are shared holders waiting. Otherwise wake up the next
        # exclusive holder.
        if self.__nwait_shr > 0:
Guido Trotter's avatar
Guido Trotter committed
233
234
          # Make sure at least the ones which were blocked pass.
          self.__npass_shr = self.__nwait_shr
235
236
          self.__turn_shr.notifyAll()
        elif self.__nwait_exc > 0:
237
          self.__turn_exc.notify()
238
239
240
241

      elif self.__is_sharer():
        self.__shr.remove(threading.currentThread())

Guido Trotter's avatar
Guido Trotter committed
242
243
244
        # If there are shared holders waiting (and not just scheduled to pass)
        # there *must* be an exclusive holder waiting as well; otherwise what
        # were they waiting for?
245
        assert (self.__nwait_exc > 0 or self.__npass_shr == self.__nwait_shr), \
Guido Trotter's avatar
Guido Trotter committed
246
247
248
249
250
251
252
               "Lock sharers waiting while no exclusive is queueing"

        # If there are no more shared holders either in or scheduled to pass,
        # and some exclusive holders are waiting let's wake one up.
        if (len(self.__shr) == 0 and
            self.__nwait_exc > 0 and
            not self.__npass_shr > 0):
253
254
255
256
257
258
259
260
          self.__turn_exc.notify()

      else:
        assert False, "Cannot release non-owned lock"

    finally:
      self.__lock.release()

261
262
263
264
265
266
267
  def delete(self, blocking=1):
    """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.

Iustin Pop's avatar
Iustin Pop committed
268
269
270
    @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 lock.
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

    """
    self.__lock.acquire()
    try:
      assert not self.__is_sharer(), "cannot delete() a lock while sharing it"

      if self.__deleted:
        raise errors.LockError('deleted lock')

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

      self.__deleted = True
      self.__exc = None
      # Wake up everybody, they will fail acquiring the lock and
      # raise an exception instead.
      self.__turn_exc.notifyAll()
      self.__turn_shr.notifyAll()

    finally:
      self.__lock.release()

296

297
298
299
300
301
# Whenever we want to acquire a full LockSet we pass None as the value to acquire.
# Hide this behing this nicely named constant.
ALL_SET = None


302
303
304
305
306
307
308
309
310
311
312
313
314
315
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
316
    @param members: initial members of the set
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

    """
    # 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
343
  def _add_owned(self, name=None):
344
    """Note the current thread owns the given lock"""
Guido Trotter's avatar
Guido Trotter committed
345
346
347
    if name is None:
      if not self._is_owned():
        self.__owners[threading.currentThread()] = set()
348
    else:
Guido Trotter's avatar
Guido Trotter committed
349
350
351
352
353
      if self._is_owned():
        self.__owners[threading.currentThread()].add(name)
      else:
        self.__owners[threading.currentThread()] = set([name])

354

Guido Trotter's avatar
Guido Trotter committed
355
  def _del_owned(self, name=None):
356
357
    """Note the current thread owns the given lock"""

Guido Trotter's avatar
Guido Trotter committed
358
359
360
361
362
363
    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()]):
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
      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.

    """
380
    return self.__lockdict.keys()
381
382
383
384
385

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

    Used only for debugging purposes.
386

387
    """
388
389
390
391
392
393
    # 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)
394
395
396
    try:
      result = self.__names()
    finally:
397
398
      if release_lock:
        self.__lock.release()
399
    return set(result)
400
401
402
403

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

Iustin Pop's avatar
Iustin Pop committed
404
405
406
407
408
409
    @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)
410

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

Iustin Pop's avatar
Iustin Pop committed
413
414
415
    @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.
416
417
418
419
420
421
422
423
424

    """
    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"

425
426
427
428
429
430
431
432
433
434
435
    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
436
437
438
439
440
441
442
443
444
445
      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
446

447
448
449
450
451
452
453
454
455
456
457
    try:
      # Support passing in a single resource to acquire rather than many
      if isinstance(names, basestring):
        names = [names]
      else:
        names.sort()

      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
458
      for lname in utils.UniqueSequence(names):
459
        try:
460
          lock = self.__lockdict[lname] # raises KeyError if lock is not there
461
462
          acquire_list.append((lname, lock))
        except (KeyError):
463
464
465
466
467
468
          if self.__lock._is_owned():
            # We are acquiring all the set, it doesn't matter if this particular
            # element is not there anymore.
            continue
          else:
            raise errors.LockError('non-existing lock in set (%s)' % lname)
469
470
471
472
473
474
475
476

      # 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:
477
        try:
478
          lock.acquire(shared=shared) # raises LockError if the lock is deleted
479
          # now the lock cannot be deleted, we have it!
Guido Trotter's avatar
Guido Trotter committed
480
          self._add_owned(name=lname)
481
          acquired.add(lname)
482
        except (errors.LockError):
483
484
485
486
487
488
489
490
          if self.__lock._is_owned():
            # We are acquiring all the set, it doesn't matter if this particular
            # element is not there anymore.
            continue
          else:
            name_fail = lname
            for lname in self._list_owned():
              self.__lockdict[lname].release()
Guido Trotter's avatar
Guido Trotter committed
491
              self._del_owned(name=lname)
492
            raise errors.LockError('non-existing lock in set (%s)' % name_fail)
493
494
495
496
497
498
499
        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()
            raise
500
501

    except:
502
503
504
      # If something went wrong and we had the set-lock let's release it...
      if self.__lock._is_owned():
        self.__lock.release()
505
      raise
506

507
    return acquired
508
509
510
511
512
513
514

  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
515
516
    @param names: the names of the locks which shall be released
        (defaults to all the locks acquired at that level).
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532

    """
    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()))

533
534
535
536
    # 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
537
      self._del_owned()
538

539
540
541
542
    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
543
      self._del_owned(name=lockname)
544
545
546
547

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

Iustin Pop's avatar
Iustin Pop committed
548
549
550
    @param names: names of the new elements to add
    @param acquired: pre-acquire the new resource?
    @param shared: is the pre-acquisition shared?
551
552

    """
553
554
555
    # 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"
556

557
558
559
560
    # Support passing in a single resource to add rather than many
    if isinstance(names, basestring):
      names = [names]

561
    # If we don't already own the set-level lock acquired in an exclusive way
562
563
564
565
566
567
    # 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()

568
    try:
569
      invalid_names = set(self.__names()).intersection(names)
570
571
572
573
574
575
576
577
578
579
580
581
582
      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
583
            self._add_owned(name=lockname)
584
585
586
587
588
589
590
591
592
593
594
595
596
          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:
597
598
599
      # Only release __lock if we were not holding it previously.
      if release_lock:
        self.__lock.release()
600
601
602
603
604
605
606
607
608

    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
609
610
611
612
    @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)
613

Iustin Pop's avatar
Iustin Pop committed
614
615
616
    @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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632

    """
    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
633
    removed = []
634
635
636
637
638
639
640
641
642

    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
643
        removed.append(lname)
644
645
646
647
648
649
650
651
652
653
654
655
656
657
      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
658
          self._del_owned(name=lname)
659

Guido Trotter's avatar
Guido Trotter committed
660
    return removed
661

662
663
664
665
666
667
668
669
670
671
672

# 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
673
674
LEVEL_INSTANCE = 1
LEVEL_NODE = 2
675
676

LEVELS = [LEVEL_CLUSTER,
677
678
          LEVEL_INSTANCE,
          LEVEL_NODE]
679
680
681
682

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

683
# Constant for the big ganeti lock
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
BGL = 'BGL'


class GanetiLockManager:
  """The Ganeti Locking Library

  The purpouse of this small library is to manage locking for ganeti clusters
  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.

701
702
    There should be only a GanetiLockManager object at any time, so this
    function raises an error if this is not the case.
703

Iustin Pop's avatar
Iustin Pop committed
704
705
    @param nodes: list of node names
    @param instances: list of instance names
706
707

    """
Iustin Pop's avatar
Iustin Pop committed
708
709
710
    assert self.__class__._instance is None, \
           "double GanetiLockManager instance"

711
712
713
714
715
716
717
718
719
720
721
722
723
    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
724
725
726
    This can be used for debugging/testing purposes.

    @param level: the level whose list of locks to get
727
728
729
730
731
732
733
734
735
736
737

    """
    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()

738
739
  is_owned = _is_owned

740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
  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
763
764
765
766
    """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.
767
768
769
770
771
772
773

    """
    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
774
775
776
777
778
779
780
781
    @param level: the level at which the locks shall be acquired;
        it must be a memmber of LEVELS.
    @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)
782
783
784
785
786
787
788
789
790
791
792
793
794
795

    """
    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.
796
    assert not self._upper_owned(level), ("Cannot acquire locks at a level"
797
798
799
800
801
802
803
804
805
           " 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
806
807
    You must have acquired the locks, either in shared or in exclusive
    mode, before releasing them.
808

Iustin Pop's avatar
Iustin Pop committed
809
810
811
812
    @param level: the level at which the locks shall be released;
        it must be a memmber of LEVELS
    @param names: the names of the locks which shall be released
        (defaults to all the locks acquired at that level)
813
814
815
816
817
818
819
820
821
822
823
824
825
826

    """
    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
827
828
829
830
831
832
    @param level: the level at which the locks shall be added;
        it must be a memmber of LEVELS_MOD.
    @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

833
834
835
836
837
838
839
840
841
842
843
    """
    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
844
845
    You must either already own the locks you are trying to remove
    exclusively or not own any lock at an upper level.
846

Iustin Pop's avatar
Iustin Pop committed
847
848
849
850
851
852
    @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)
853
854
855
856
857
858
859
860
861
862
863

    """
    assert level in LEVELS_MOD, "Invalid or immutable level %s" % level
    assert self._BGL_owned(), ("You must own the BGL before performing other"
           " operations")
    # 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.
    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")
864
    return self.__keyring[level].remove(names, blocking=blocking)