libnl 3.7.0
object.h
1/* SPDX-License-Identifier: LGPL-2.1-only */
2/*
3 * Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch>
4 */
5
6#ifndef NETLINK_OBJECT_H_
7#define NETLINK_OBJECT_H_
8
9#include <netlink/netlink.h>
10#include <netlink/utils.h>
11
12#ifdef __cplusplus
13extern "C" {
14#endif
15
16struct nl_cache;
17struct nl_object;
18struct nl_object_ops;
19
20#define OBJ_CAST(ptr) ((struct nl_object *) (ptr))
21
22/* General */
23extern struct nl_object * nl_object_alloc(struct nl_object_ops *);
24extern int nl_object_alloc_name(const char *,
25 struct nl_object **);
26extern void nl_object_free(struct nl_object *);
27extern struct nl_object * nl_object_clone(struct nl_object *obj);
28extern int nl_object_update(struct nl_object *dst,
29 struct nl_object *src);
30extern void nl_object_get(struct nl_object *);
31extern void nl_object_put(struct nl_object *);
32extern int nl_object_shared(struct nl_object *);
33extern void nl_object_dump(struct nl_object *,
34 struct nl_dump_params *);
35extern void nl_object_dump_buf(struct nl_object *, char *, size_t);
36extern int nl_object_identical(struct nl_object *,
37 struct nl_object *);
38extern uint32_t nl_object_diff(struct nl_object *,
39 struct nl_object *);
40extern uint64_t nl_object_diff64(struct nl_object *,
41 struct nl_object *);
42extern int nl_object_match_filter(struct nl_object *,
43 struct nl_object *);
44extern char * nl_object_attrs2str(struct nl_object *,
45 uint32_t attrs, char *buf,
46 size_t);
47extern char * nl_object_attr_list(struct nl_object *,
48 char *, size_t);
49extern void nl_object_keygen(struct nl_object *,
50 uint32_t *, uint32_t);
51
52/* Marks */
53extern void nl_object_mark(struct nl_object *);
54extern void nl_object_unmark(struct nl_object *);
55extern int nl_object_is_marked(struct nl_object *);
56
57/* Access Functions */
58extern int nl_object_get_refcnt(struct nl_object *);
59extern struct nl_cache * nl_object_get_cache(struct nl_object *);
60extern const char * nl_object_get_type(const struct nl_object *);
61extern int nl_object_get_msgtype(const struct nl_object *);
62struct nl_object_ops * nl_object_get_ops(const struct nl_object *);
63uint32_t nl_object_get_id_attrs(struct nl_object *obj);
64
65
66static inline void * nl_object_priv(struct nl_object *obj)
67{
68 return obj;
69}
70
71
72#ifdef __cplusplus
73}
74#endif
75
76#endif
nl_object_alloc_name
int nl_object_alloc_name(const char *, struct nl_object **)
Allocate new object of kind specified by the name.
Definition: object.c:78
nl_object_get_ops
struct nl_object_ops * nl_object_get_ops(const struct nl_object *)
Return object operations structure.
Definition: object.c:543
nl_object_diff
uint32_t nl_object_diff(struct nl_object *, struct nl_object *)
Compute 32-bit bitmask representing difference in attribute values.
Definition: object.c:388
nl_object_dump
void nl_object_dump(struct nl_object *, struct nl_dump_params *)
Dump this object according to the specified parameters.
Definition: object.c:287
nl_object_update
int nl_object_update(struct nl_object *dst, struct nl_object *src)
Merge a cacheable object.
Definition: object.c:153
nl_object_get_type
const char * nl_object_get_type(const struct nl_object *)
Return the object's type.
Definition: object.c:518
nl_object_clone
struct nl_object * nl_object_clone(struct nl_object *obj)
Allocate a new object and copy all data from an existing object.
Definition: object.c:104
nl_object_get_msgtype
int nl_object_get_msgtype(const struct nl_object *)
Return the netlink message type the object was derived from.
Definition: object.c:532
nl_object_attrs2str
char * nl_object_attrs2str(struct nl_object *, uint32_t attrs, char *buf, size_t)
Convert bitmask of attributes to a character string.
Definition: object.c:431
nl_object_diff64
uint64_t nl_object_diff64(struct nl_object *, struct nl_object *)
Compute bitmask representing difference in attribute values.
Definition: object.c:364
nl_object_get_id_attrs
uint32_t nl_object_get_id_attrs(struct nl_object *obj)
Return object id attribute mask.
Definition: object.c:554
nl_object_get_refcnt
int nl_object_get_refcnt(struct nl_object *)
Return number of references held.
Definition: object.c:491
nl_object_shared
int nl_object_shared(struct nl_object *)
Check whether this object is used by multiple users.
Definition: object.c:235
nl_object_unmark
void nl_object_unmark(struct nl_object *)
Remove mark from object.
Definition: object.c:260
nl_object_put
void nl_object_put(struct nl_object *)
Release a reference from an object.
Definition: object.c:214
nl_object_get_cache
struct nl_cache * nl_object_get_cache(struct nl_object *)
Return cache the object is associated with.
Definition: object.c:505
nl_object_identical
int nl_object_identical(struct nl_object *, struct nl_object *)
Check if the identifiers of two objects are identical.
Definition: object.c:312
nl_object_attr_list
char * nl_object_attr_list(struct nl_object *, char *, size_t)
Return list of attributes present in an object.
Definition: object.c:452
nl_object_get
void nl_object_get(struct nl_object *)
Acquire a reference on a object.
Definition: object.c:203
nl_object_free
void nl_object_free(struct nl_object *)
Free a cacheable object.
Definition: object.c:169
nl_object_match_filter
int nl_object_match_filter(struct nl_object *, struct nl_object *)
Match a filter against an object.
Definition: object.c:408
nl_object_is_marked
int nl_object_is_marked(struct nl_object *)
Return true if object is marked.
Definition: object.c:270
nl_object_mark
void nl_object_mark(struct nl_object *)
Add mark to object.
Definition: object.c:251
nl_object_alloc
struct nl_object * nl_object_alloc(struct nl_object_ops *)
Allocate a new object of kind specified by the operations handle.
Definition: object.c:48
nl_object_keygen
void nl_object_keygen(struct nl_object *, uint32_t *, uint32_t)
Generate object hash key.
Definition: object.c:465
nl_dump_params
Dumping parameters.
Definition: types.h:28