xref: /aosp_15_r20/hardware/interfaces/atrace/1.0/IAtraceDevice.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright (C) 2018 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 [email protected];

interface IAtraceDevice {
    /**
     * Get vendor extended atrace points.
     *
     *
     * @return categories of tracing points the device extended.
     */
    listCategories() generates (vec<TracingCategory> categories);

    /**
     * A hook when atrace set to enable specific categories, so HAL
     * can enable kernel tracing points and/or notify other things
     * for userspace tracing turning on.
     *
     * @param categories A vector of strings of categories (corresponding to
     *        TracingCategory.name) atrace needs to be enabled.
     *
     * @return status SUCCESS on success,
     *         ERROR_TRACING_POINT on error with enabling categories,
     *         ERROR_INVALID_ARGUMENT on invalid argument passed.
     */
    enableCategories(vec<string> categories) generates (Status status);

    /**
     * A hook when atrace set to clean up tracing categories, so HAL
     * can disable all kernel tracing points and/or notify other things
     * for userspace tracing turning off.
     *
     * @return status SUCCESS on success,
     *         ERROR_TRACING_POINT on error with disabling categories.
     */
    disableAllCategories() generates (Status status);
};