/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2014 Garrett D'Amore <garrett@damore.org>
 *
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * Copyright (c) 2011 by Delphix. All rights reserved.
 */

#ifndef _SPAWN_H
#define _SPAWN_H

#include <sys/feature_tests.h>
#include <sys/types.h>
#include <signal.h>
#include <sched.h>

#ifdef  __cplusplus
extern "C" {
#endif

/*
 * flags for posix_spawnattr_setflags()
 */
#define POSIX_SPAWN_RESETIDS            0x0001
#define POSIX_SPAWN_SETPGROUP           0x0002
#define POSIX_SPAWN_SETSIGDEF           0x0004
#define POSIX_SPAWN_SETSIGMASK          0x0008
#define POSIX_SPAWN_SETSCHEDPARAM       0x0010
#define POSIX_SPAWN_SETSCHEDULER        0x0020
#define POSIX_SPAWN_SETSID              0x0040
/*
 * non-portable extensions
 */
#if !defined(_STRICT_POSIX)
#define POSIX_SPAWN_SETSIGIGN_NP        0x0800
#define POSIX_SPAWN_NOSIGCHLD_NP        0x1000
#define POSIX_SPAWN_WAITPID_NP          0x2000
#define POSIX_SPAWN_NOEXECERR_NP        0x4000
#endif  /* !_STRICT_POSIX */

typedef struct {
        void *__spawn_attrp;    /* implementation-private */
} posix_spawnattr_t;

typedef struct {
        void *__file_attrp;     /* implementation-private */
} posix_spawn_file_actions_t;

extern int posix_spawn(
        pid_t *_RESTRICT_KYWD pid,
        const char *_RESTRICT_KYWD path,
        const posix_spawn_file_actions_t *file_actions,
        const posix_spawnattr_t *_RESTRICT_KYWD attrp,
        char *const *_RESTRICT_KYWD argv,
        char *const *_RESTRICT_KYWD envp);

extern int posix_spawnp(
        pid_t *_RESTRICT_KYWD pid,
        const char *_RESTRICT_KYWD file,
        const posix_spawn_file_actions_t *file_actions,
        const posix_spawnattr_t *_RESTRICT_KYWD attrp,
        char *const *_RESTRICT_KYWD argv,
        char *const *_RESTRICT_KYWD envp);

extern int posix_spawn_file_actions_init(
        posix_spawn_file_actions_t *file_actions);

extern int posix_spawn_file_actions_destroy(
        posix_spawn_file_actions_t *file_actions);

extern int posix_spawn_file_actions_addchdir(
        posix_spawn_file_actions_t *_RESTRICT_KYWD file_actions,
        const char *_RESTRICT_KYWD path);

extern int posix_spawn_file_actions_addopen(
        posix_spawn_file_actions_t *_RESTRICT_KYWD file_actions,
        int filedes,
        const char *_RESTRICT_KYWD path,
        int oflag,
        mode_t mode);

extern int posix_spawn_file_actions_addclose(
        posix_spawn_file_actions_t *file_actions,
        int filedes);

extern int posix_spawn_file_actions_adddup2(
        posix_spawn_file_actions_t *file_actions,
        int filedes,
        int newfiledes);

extern int posix_spawn_file_actions_addfchdir(
        posix_spawn_file_actions_t *_RESTRICT_KYWD file_actions,
        int fd);

extern int posix_spawnattr_init(
        posix_spawnattr_t *attr);

extern int posix_spawnattr_destroy(
        posix_spawnattr_t *attr);

extern int posix_spawnattr_setflags(
        posix_spawnattr_t *attr,
        short flags);

extern int posix_spawnattr_getflags(
        const posix_spawnattr_t *_RESTRICT_KYWD attr,
        short *_RESTRICT_KYWD flags);

extern int posix_spawnattr_setpgroup(
        posix_spawnattr_t *attr,
        pid_t pgroup);

extern int posix_spawnattr_getpgroup(
        const posix_spawnattr_t *_RESTRICT_KYWD attr,
        pid_t *_RESTRICT_KYWD pgroup);

extern int posix_spawnattr_setschedparam(
        posix_spawnattr_t *_RESTRICT_KYWD attr,
        const struct sched_param *_RESTRICT_KYWD schedparam);

extern int posix_spawnattr_getschedparam(
        const posix_spawnattr_t *_RESTRICT_KYWD attr,
        struct sched_param *_RESTRICT_KYWD schedparam);

extern int posix_spawnattr_setschedpolicy(
        posix_spawnattr_t *attr,
        int schedpolicy);

extern int posix_spawnattr_getschedpolicy(
        const posix_spawnattr_t *_RESTRICT_KYWD attr,
        int *_RESTRICT_KYWD schedpolicy);

extern int posix_spawnattr_setsigdefault(
        posix_spawnattr_t *_RESTRICT_KYWD attr,
        const sigset_t *_RESTRICT_KYWD sigdefault);

extern int posix_spawnattr_getsigdefault(
        const posix_spawnattr_t *_RESTRICT_KYWD attr,
        sigset_t *_RESTRICT_KYWD sigdefault);

/*
 * non-portable extensions
 */
#if !defined(_STRICT_POSIX)

extern int posix_spawn_pipe_np(
        pid_t *_RESTRICT_KYWD pidp,
        int *_RESTRICT_KYWD fdp,
        const char *_RESTRICT_KYWD cmd,
        boolean_t write,
        posix_spawn_file_actions_t *_RESTRICT_KYWD fact,
        posix_spawnattr_t *_RESTRICT_KYWD attr);

extern int posix_spawn_file_actions_addclosefrom_np(
        posix_spawn_file_actions_t *file_actions,
        int lowfiledes);

extern int posix_spawnattr_setsigignore_np(
        posix_spawnattr_t *_RESTRICT_KYWD attr,
        const sigset_t *_RESTRICT_KYWD sigignore);

extern int posix_spawnattr_getsigignore_np(
        const posix_spawnattr_t *_RESTRICT_KYWD attr,
        sigset_t *_RESTRICT_KYWD sigignore);

/*
 * These _np variants are not documented in the manual, but are provided for
 * compatibility purposes with folks who have implemented this prior to
 * standardization in POSIX 2024.
 */
extern int posix_spawn_file_actions_addchdir_np(
        posix_spawn_file_actions_t *_RESTRICT_KYWD file_actions,
        const char *_RESTRICT_KYWD path);

extern int posix_spawn_file_actions_addfchdir_np(
        posix_spawn_file_actions_t *_RESTRICT_KYWD file_actions,
        int fd);

#endif  /* !_STRICT_POSIX */

extern int posix_spawnattr_setsigmask(
        posix_spawnattr_t *_RESTRICT_KYWD attr,
        const sigset_t *_RESTRICT_KYWD sigmask);

extern int posix_spawnattr_getsigmask(
        const posix_spawnattr_t *_RESTRICT_KYWD attr,
        sigset_t *_RESTRICT_KYWD sigmask);

#ifdef  __cplusplus
}
#endif

#endif  /* _SPAWN_H */