modules/core/src/single_instance.cpp

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /*
  17  * @file        single_instance.cpp
  18  * @author      Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  19  * @version     1.0
  20  * @brief       This file is the implementation file of single instance
  21  */
  22 #include <stddef.h>
  23 #include <dpl/single_instance.h>
  24 #include <dpl/log/log.h>
  25 #include <unistd.h>
  26 #include <fcntl.h>
  27 #include <errno.h>
  28 #include <dpl/assert.h>
  29
  30 namespace DPL
  31 {
  32 namespace // anonumous
  33 {
  34 const char *LOCK_PREFIX_PATH = "/tmp/dpl_single_instance_";
  35 }
  36 SingleInstance::SingleInstance()
  37     : m_locked(false),
  38       m_fdLock(-1)
  39 {
  40 }
  41
  42 SingleInstance::~SingleInstance()
  43 {
  44     Assert(!m_locked && "Single instance must be released before exit!");
  45 }
  46
  47 bool SingleInstance::TryLock(const std::string &lockName)
  48 {
  49     LogPedantic("Locking single instance: " << lockName);
  50
  51     struct flock lock;
  52
  53     lock.l_type = F_WRLCK;
  54     lock.l_whence = SEEK_SET;
  55     lock.l_start = 0;
  56     lock.l_len = 1;
  57
  58     // Open lock file
  59     m_fdLock = TEMP_FAILURE_RETRY(open((std::string(LOCK_PREFIX_PATH) + lockName).c_str(), O_WRONLY | O_CREAT, 0666));
  60
  61     if (m_fdLock == -1)
  62         ThrowMsg(Exception::LockError, "Cannot open single instance lock file!");
  63
  64     // Lock file
  65     int result = TEMP_FAILURE_RETRY(fcntl(m_fdLock, F_SETLK, &lock));
  66
  67     // Was the instance successfuly locked ?
  68     if (result == 0)
  69     {
  70         LogPedantic("Instance locked: " << lockName);
  71
  72         // It is locked now
  73         m_locked = true;
  74
  75         // Done
  76         return true;
  77     }
  78
  79     if (errno == EACCES || errno == EAGAIN)
  80     {
  81         LogPedantic("Instance is already running: " << lockName);
  82         return false;
  83     }
  84
  85     // This is lock error
  86     ThrowMsg(Exception::LockError, "Cannot lock single instance lock file!");
  87 }
  88
  89 void SingleInstance::Release()
  90 {
  91     if (!m_locked)
  92         return;
  93
  94     LogPedantic("Unlocking single instance");
  95
  96     // Unlock file
  97     struct flock lock;
  98
  99     lock.l_type = F_UNLCK;
 100     lock.l_whence = SEEK_SET;
 101     lock.l_start = 0;
 102     lock.l_len = 1;
 103
 104     int result = TEMP_FAILURE_RETRY(fcntl(m_fdLock, F_SETLK, &lock));
 105
 106     // Was the instance successfuly unlocked ?
 107     if (result == -1)
 108         ThrowMsg(Exception::LockError, "Cannot unlock single instance lock file!");
 109
 110     // Close lock file
 111     if (TEMP_FAILURE_RETRY(close(m_fdLock)) == -1)
 112         ThrowMsg(Exception::LockError, "Cannot close single instance lock file!");
 113
 114     m_fdLock = -1;
 115
 116     // Done
 117     m_locked = false;
 118     LogPedantic("Instance unlocked");
 119 }
 120 } // namespace DPL