libvirt/src/util/virpidfile.h
Daniel P. Berrangé 568a417224 Enforce a standard header file guard symbol name
Require that all headers are guarded by a symbol named

  LIBVIRT_$FILENAME

where $FILENAME is the uppercased filename, with all characters
outside a-z changed into '_'.

Note we do not use a leading __ because that is technically a
namespace reserved for the toolchain.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2018-12-14 10:47:13 +00:00

80 lines
2.7 KiB
C

/*
* virpidfile.h: manipulation of pidfiles
*
* Copyright (C) 2010-2011, 2014 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, see
* <http://www.gnu.org/licenses/>.
*
*/
#ifndef LIBVIRT_VIRPIDFILE_H
# define LIBVIRT_VIRPIDFILE_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,
bool waitForLock,
pid_t pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileAcquire(const char *dir,
const char *name,
bool waitForLock,
pid_t pid) ATTRIBUTE_RETURN_CHECK;
int virPidFileReleasePath(const char *path,
int fd);
int virPidFileRelease(const char *dir,
const char *name,
int fd);
int virPidFileConstructPath(bool privileged,
const char *statedir,
const char *progname,
char **pidfile);
int virPidFileForceCleanupPath(const char *path) ATTRIBUTE_NONNULL(1);
#endif /* LIBVIRT_VIRPIDFILE_H */