main: move olsr_create_lock_file into its own file
[olsrd.git] / src / lock_file.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #include "lock_file.h"
42
43 #include <stdio.h>
44 #include <string.h>
45 #include <fcntl.h>
46 #include <stdlib.h>
47 #include <unistd.h>
48 #include <sys/stat.h>
49
50 #if defined __ANDROID__
51   #define DEFAULT_LOCKFILE_PREFIX "/data/local/olsrd"
52 #elif defined linux || defined __FreeBSD__ || defined __NetBSD__ || defined __OpenBSD__
53   #define DEFAULT_LOCKFILE_PREFIX "/var/run/olsrd"
54 #elif defined _WIN32
55   #define DEFAULT_LOCKFILE_PREFIX "C:\\olsrd"
56 #else /* defined _WIN32 */
57   #define DEFAULT_LOCKFILE_PREFIX "olsrd"
58 #endif /* defined _WIN32 */
59
60 #ifdef _WIN32
61   static HANDLE lck = INVALID_HANDLE_VALUE;
62 #else
63   static int lock_fd = -1;
64 #endif
65
66 /**
67  * @param cnf the olsrd configuration
68  * @param ip_version the ip version
69  * @return a malloc-ed string for the default lock file name
70  */
71 char * olsrd_get_default_lockfile(struct olsrd_config *cnf) {
72   char buf[FILENAME_MAX];
73   int ipv = (cnf->ip_version == AF_INET) ? 4 : 6;
74
75 #ifndef DEFAULT_LOCKFILE_PREFIX
76   snprintf(buf, sizeof(buf), "%s-ipv%d.lock", cnf->configuration_file ? cnf->configuration_file : "olsrd", ipv);
77 #else
78   snprintf(buf, sizeof(buf), "%s-ipv%d.lock", DEFAULT_LOCKFILE_PREFIX, ipv);
79 #endif /* DEFAULT_LOCKFILE_PREFIX */
80
81   return strdup(buf);
82 }
83
84 /*
85  * Creates a zero-length locking file and use fcntl to
86  * place an exclusive lock over it. The lock will be
87  * automatically erased when the olsrd process ends,
88  * so it will even work well with a SIGKILL.
89  *
90  * Additionally the lock can be killed by removing the
91  * locking file.
92  */
93 bool olsr_create_lock_file(void) {
94 #ifdef _WIN32
95   bool success;
96
97   lck = CreateFile(olsr_cnf->lock_file,
98       GENERIC_READ | GENERIC_WRITE,
99       FILE_SHARE_READ | FILE_SHARE_WRITE,
100       NULL,
101       OPEN_ALWAYS,
102       FILE_ATTRIBUTE_NORMAL |
103       FILE_FLAG_DELETE_ON_CLOSE,
104       NULL);
105   CreateEvent(NULL, TRUE, FALSE, olsr_cnf->lock_file);
106   if ((INVALID_HANDLE_VALUE == lck) || (ERROR_ALREADY_EXISTS == GetLastError())) {
107     if (INVALID_HANDLE_VALUE != lck) {
108       CloseHandle(lck);
109       lck = INVALID_HANDLE_VALUE;
110     }
111     return false;
112   }
113
114   success = LockFile( lck, 0, 0, 0, 0);
115
116   if (!success) {
117     CloseHandle(lck);
118     lck = INVALID_HANDLE_VALUE;
119     return false;
120   }
121
122 #else /* _WIN32 */
123   struct flock lck;
124
125   /* create file for lock */
126   lock_fd = open(olsr_cnf->lock_file, O_WRONLY | O_CREAT, S_IRWXU);
127   if (lock_fd < 0) {
128     return false;
129   }
130
131   /* create exclusive lock for the whole file */
132   lck.l_type = F_WRLCK;
133   lck.l_whence = SEEK_SET;
134   lck.l_start = 0;
135   lck.l_len = 0;
136   lck.l_pid = 0;
137
138   if (fcntl(lock_fd, F_SETLK, &lck) == -1) {
139     close(lock_fd);
140     lock_fd = -1;
141     return false;
142   }
143 #endif /* _WIN32 */
144
145   return true;
146 }