libvirt/src/util/virpidfile.h
Daniel P. Berrange e1da464d88 Add some APIs which use locking for crashsafe pidfile handling
In daemons using pidfiles to protect against concurrent
execution there is a possibility that a crash may leave a stale
pidfile on disk, which then prevents later restart of the daemon.

To avoid this problem, introduce a pair of APIs which make
use of virFileLock to ensure crash-safe & race condition-safe
pidfile acquisition & releae

* src/libvirt_private.syms, src/util/virpidfile.c,
  src/util/virpidfile.h: Add virPidFileAcquire and virPidFileRelease
2011-08-12 20:37:00 +01:00

71 lines
2.5 KiB
C

/*
* virpidfile.h: manipulation of pidfiles
*
* Copyright (C) 2010-2011 Red Hat, Inc.
* Copyright (C) 2006, 2007 Binary Karma
* Copyright (C) 2006 Shuveb Hussain
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef __VIR_PIDFILE_H__
# define __VIR_PIDFILE_H__
# include <sys/types.h>
# include "internal.h"
char *virPidFileBuildPath(const char *dir,
const char *name);
int virPidFileWritePath(const char *path,
pid_t pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileWrite(const char *dir,
const char *name,
pid_t pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileReadPath(const char *path,
pid_t *pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileRead(const char *dir,
const char *name,
pid_t *pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileReadPathIfAlive(const char *path,
pid_t *pid,
const char *binpath) ATTRIBUTE_RETURN_CHECK;
int virPidFileReadIfAlive(const char *dir,
const char *name,
pid_t *pid,
const char *binpath) ATTRIBUTE_RETURN_CHECK;
int virPidFileDeletePath(const char *path);
int virPidFileDelete(const char *dir,
const char *name);
int virPidFileAcquirePath(const char *path,
pid_t pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileAcquire(const char *dir,
const char *name,
pid_t pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileReleasePath(const char *path,
int fd);
int virPidFileRelease(const char *dir,
const char *name,
int fd);
#endif /* __VIR_PIDFILE_H__ */