fib_entry_cover.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * 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.
 */

#ifndef __FIB_ENTRY_COVER_H__
#define __FIB_ENTRY_COVER_H__

#include "fib_entry.h"

/**
 * callback function used when walking the covered entries
 */
typedef int (*fib_entry_covered_walk_t)(fib_entry_t *cover,
                                        fib_node_index_t covered,
                                        void *ctx);

extern u32 fib_entry_cover_track(fib_entry_t *cover,
                                 fib_node_index_t covered);

extern void fib_entry_cover_untrack(fib_entry_t *cover,
                                    u32 tracked_index);

extern void fib_entry_cover_walk(fib_entry_t *cover,
                                 fib_entry_covered_walk_t walk,
                                 void *ctx);

extern void fib_entry_cover_change_notify(fib_node_index_t cover_index,
                                          fib_node_index_t covered_index);
extern void fib_entry_cover_update_notify(fib_entry_t *cover);

extern u32 fib_entry_cover_get_size(fib_entry_t *cover);

extern u8* fib_entry_cover_list_format(fib_entry_t *fib_entry,
                                       u8 *s);

#endif