Per sjg's suggestion, split filemon API into separate back ends.

By default we use the ktrace back end, but the /dev/filemon back end
is available as a compile-time option, by setting USE_FILEMON=dev in
make.  sjg raised concerns about ktrace performance and would like to
continue using /dev/filemon on FreeBSD (which has seen more
maintenance kernel-side) without forking make.
This commit is contained in:
riastradh 2020-01-19 19:49:36 +00:00
parent 1378959eea
commit bea0f8c176
5 changed files with 181 additions and 20 deletions

View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.66 2020/01/19 19:42:32 riastradh Exp $
# $NetBSD: Makefile,v 1.67 2020/01/19 19:49:36 riastradh Exp $
# @(#)Makefile 5.2 (Berkeley) 12/28/90
PROG= make
@ -17,9 +17,10 @@ USE_META ?= yes
.if ${USE_META:tl} != "no"
SRCS+= meta.c
CPPFLAGS+= -DUSE_META
USE_FILEMON ?= yes
USE_FILEMON ?= ktrace
.if ${USE_FILEMON:tl} != "no"
SRCS+= filemon.c
.PATH: ${.CURDIR}/filemon
SRCS+= filemon_${USE_FILEMON}.c
CPPFLAGS+= -DUSE_FILEMON
.endif
.endif

View File

@ -1,4 +1,4 @@
/* $NetBSD: filemon.h,v 1.1 2020/01/19 19:42:32 riastradh Exp $ */
/* $NetBSD: filemon.h,v 1.1 2020/01/19 19:49:37 riastradh Exp $ */
/*-
* Copyright (c) 2019 The NetBSD Foundation, Inc.
@ -36,6 +36,9 @@
struct filemon;
const char *
filemon_path(void);
struct filemon *
filemon_open(void);
int filemon_close(struct filemon *);

View File

@ -0,0 +1,151 @@
/* $NetBSD: filemon_dev.c,v 1.1 2020/01/19 19:49:37 riastradh Exp $ */
/*-
* Copyright (c) 2020 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Taylor R. Campbell.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#include "filemon.h"
#include <sys/ioctl.h>
#include <errno.h>
#include <fcntl.h>
#include <stdlib.h>
#include <unistd.h>
#ifdef HAVE_FILEMON_H
# include <filemon.h>
#endif
#ifndef _PATH_FILEMON
#define _PATH_FILEMON "/dev/filemon"
#endif
struct filemon {
int fd;
};
const char *
filemon_path(void)
{
return _PATH_FILEMON;
}
struct filemon *
filemon_open(void)
{
struct filemon *F;
unsigned i;
int error;
/* Allocate and zero a struct filemon object. */
F = calloc(1, sizeof(*F));
if (F == NULL)
return NULL;
/* Try opening /dev/filemon, up to six times (cargo cult!). */
for (i = 0; (F->fd = open(_PATH_FILEMON, O_RDWR)) == -1; i++) {
if (i == 5) {
error = errno;
goto fail0;
}
}
/* Success! */
return F;
fail0: free(F);
errno = error;
return NULL;
}
int
filemon_setfd(struct filemon *F, int fd)
{
/* Point the kernel at this file descriptor. */
if (ioctl(F->fd, FILEMON_SET_FD, &fd) == -1)
return -1;
/* No need for it in userland any more; close it. */
(void)close(fd);
/* Success! */
return 0;
}
void
filemon_setpid_parent(struct filemon *F, pid_t pid)
{
/* Nothing to do! */
}
int
filemon_setpid_child(const struct filemon *F, pid_t pid)
{
/* Just pass it on to the kernel. */
return ioctl(F->fd, FILEMON_SET_PID, &pid);
}
int
filemon_close(struct filemon *F)
{
int error = 0;
/* Close the filemon device fd. */
if (close(F->fd) == -1 && error == 0)
error = errno;
/* Free the filemon descriptor. */
free(F);
/* Set errno and return -1 if anything went wrong. */
if (error) {
errno = error;
return -1;
}
/* Success! */
return 0;
}
int
filemon_readfd(const struct filemon *F)
{
return -1;
}
int
filemon_process(struct filemon *F)
{
return 0;
}

View File

@ -1,4 +1,4 @@
/* $NetBSD: filemon.c,v 1.1 2020/01/19 19:42:32 riastradh Exp $ */
/* $NetBSD: filemon_ktrace.c,v 1.1 2020/01/19 19:49:37 riastradh Exp $ */
/*-
* Copyright (c) 2019 The NetBSD Foundation, Inc.
@ -29,8 +29,6 @@
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifdef USE_FILEMON
#include "filemon.h"
#include <sys/param.h>
@ -52,8 +50,7 @@
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "make.h"
#include <unistd.h>
#ifndef AT_CWD
#define AT_CWD -1
@ -132,8 +129,7 @@ struct filemon_state {
};
static int
compare_filemon_states(void *cookie MAKE_ATTR_UNUSED, const void *na,
const void *nb)
compare_filemon_states(void *cookie, const void *na, const void *nb)
{
const struct filemon_state *Sa = na;
const struct filemon_state *Sb = nb;
@ -150,8 +146,7 @@ compare_filemon_states(void *cookie MAKE_ATTR_UNUSED, const void *na,
}
static int
compare_filemon_key(void *cookie MAKE_ATTR_UNUSED, const void *n,
const void *k)
compare_filemon_key(void *cookie, const void *n, const void *k)
{
const struct filemon_state *S = n;
const struct filemon_key *key = k;
@ -174,6 +169,19 @@ static const rb_tree_ops_t filemon_rb_ops = {
.rbto_context = NULL,
};
/*
* filemon_path()
*
* Return a pointer to a constant string denoting the `path' of
* the filemon.
*/
const char *
filemon_path(void)
{
return "ktrace";
}
/*
* filemon_open()
*
@ -572,7 +580,7 @@ top: /* If the child has exited, nothing to do. */
}
static struct filemon_state *
syscall_enter(struct filemon *F MAKE_ATTR_UNUSED,
syscall_enter(struct filemon *F,
const struct filemon_key *key, const struct ktr_syscall *call,
unsigned npath,
void (*show)(struct filemon *, const struct filemon_state *,
@ -866,5 +874,3 @@ filemon_sys_rename(struct filemon *F, const struct filemon_key *key,
{
return syscall_enter(F, key, call, 2, &show_rename);
}
#endif /* USE_META */

View File

@ -1,4 +1,4 @@
/* $NetBSD: meta.c,v 1.74 2020/01/19 19:42:32 riastradh Exp $ */
/* $NetBSD: meta.c,v 1.75 2020/01/19 19:49:37 riastradh Exp $ */
/*
* Implement 'meta' mode.
@ -46,7 +46,7 @@
#include "job.h"
#ifdef USE_FILEMON
#include "filemon.h"
#include "filemon/filemon.h"
#endif
static BuildMon Mybm; /* for compat */
@ -130,7 +130,7 @@ meta_open_filemon(BuildMon *pbm)
pbm->filemon = filemon_open();
if (pbm->filemon == NULL) {
useFilemon = FALSE;
warn("Could not open filemon");
warn("Could not open filemon %s", filemon_path());
return;
}
@ -563,7 +563,7 @@ meta_init(void)
{
#ifdef USE_FILEMON
/* this allows makefiles to test if we have filemon support */
Var_Set(".MAKE.PATH_FILEMON", "ktrace", VAR_GLOBAL, 0); /* XXX */
Var_Set(".MAKE.PATH_FILEMON", filemon_path(), VAR_GLOBAL, 0);
#endif
}