/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.system;

import static android.annotation.SystemApi.Client.MODULE_LIBRARIES;

import android.annotation.SystemApi;

import libcore.util.Objects;

/**
 * Corresponds to Linux' __user_cap_header_struct for capget and capset.
 * Used in {@link Os.capget(StructCapUserHeader)} and
 * {@link Os.capset(StructCapUserHeader, StructCapUserData[])}.
 *
 * Capabilities defined in <a href="https://man7.org/linux/man-pages/man7/capabilities.7.html">capabilities(7)</a>
 * @hide
 */
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public final class StructCapUserHeader {
    /**
     * Version of the header. Note this is not final as capget() may mutate the field when an
     * invalid version is provided.
     *
     * See <a href="http://man7.org/linux/man-pages/man2/capget.2.html">capget(2)</a>.
     *
     * @see {@link OsConstants._LINUX_CAPABILITY_VERSION_3}.
     *
     * @hide
     */
    public int version; /* __u32 */

    /**
     * Pid of the header. The pid a call applies to.
     *
     * @hide
     */
    public final int pid;

    /**
     * Constructs an instance with the given field values.
     *
     * @param version linux capability version
     * @param pid     process id
     *
     * @hide
     */
    @SystemApi(client = MODULE_LIBRARIES)
    @libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
    public StructCapUserHeader(int version, int pid) {
        this.version = version;
        this.pid = pid;
    }

    /**
     * @hide
     */
    @Override public String toString() {
        return Objects.toString(this);
    }
}