lib/guarded-list.h

   1 /*
   2  * Copyright (c) 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef GUARDED_LIST_H
  18 #define GUARDED_LIST_H 1
  19
  20 #include <stddef.h>
  21 #include "compiler.h"
  22 #include "list.h"
  23 #include "ovs-thread.h"
  24
  25 struct guarded_list {
  26     struct ovs_mutex mutex;
  27     struct ovs_list list;
  28     size_t n;
  29 };
  30
  31 #define GUARDED_OVS_LIST_INITIALIZER(LIST) { \
  32     .mutex = OVS_MUTEX_INITIALIZER, \
  33     .list = OVS_LIST_INITIALIZER(&((LIST)->list)), \
  34     .n = 0 }
  35
  36 void guarded_list_init(struct guarded_list *);
  37 void guarded_list_destroy(struct guarded_list *);
  38
  39 bool guarded_list_is_empty(const struct guarded_list *);
  40
  41 size_t guarded_list_push_back(struct guarded_list *, struct ovs_list *,
  42                               size_t max);
  43 struct ovs_list *guarded_list_pop_front(struct guarded_list *);
  44 size_t guarded_list_pop_all(struct guarded_list *, struct ovs_list *);
  45
  46 #endif /* guarded-list.h */