1 /* -*- mode: c; c-file-style: "openbsd" -*- */
3 * Copyright (c) 2012 Vincent Bernat <bernat@luffy.cx>
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 * @defgroup liblldpctl liblldpctl: library to interface with lldpd
24 * `liblldpctl` allows any program to convenienty query and modify the behaviour
25 * of a running lldpd daemon.
27 * To use this library, use `pkg-config` to get the appropriate options:
28 * * `pkg-config --libs lldpctl` for `LIBS` or `LDFLAGS`
29 * * `pkg-config --cflags lldpctl` for `CFLAGS`
31 * @warning This library is tightly coupled with lldpd. The library to use
32 * should be the one shipped with lldpd. Clients of the library are then tied
33 * by the classic API/ABI rules and may be compiled separatly.
35 * There are two important structures in this library: @c lldpctl_conn_t which
36 * represents a connection and @c lldpctl_atom_t which represents a piece of
37 * information. Those types are opaque. No direct access to them should be done.
39 * The library is expected to be reentrant and therefore thread-safe. It is
40 * however not expected that a connection to be used in several thread
41 * simultaneously. This also applies to the different pieces of information
42 * gathered through this connection. Several connection to lldpd can be used
45 * The first step is to establish a connection. See @ref lldpctl_connection for
46 * more information about this. The next step is to query the lldpd daemon. See
47 * @ref lldpctl_atoms on how to do this.
49 * `liblldpctl` tries to handle errors in a coherent way. Any function returning
50 * a pointer will return @c NULL on error and the last error can be retrieved
51 * through @ref lldpctl_last_error() function. Most functions returning integers
52 * will return a negative integer representing the error if something goes
53 * wrong. The use of @ref lldpctl_last_error() allows one to check if this is a
54 * real error if there is a doubt. See @ref lldpctl_errors_logs for more about
67 #include <sys/types.h>
70 * @defgroup lldpctl_connection Managing connection to lldpd
72 * Connection with lldpd.
74 * This library does not handle IO. They are delegated to a set of functions to
75 * allow a user to specify exactly how IO should be done. A user is expected to
76 * provide two functions: the first one is called when the library requests
77 * incoming data, the other one when it requests outgoing data. Moreover, the
78 * user is also expected to call the appropriate functions when data comes back
79 * (@ref lldpctl_recv()) or needs to be sent (@ref lldpctl_send()).
81 * Because the most common case is synchronous IO, `liblldpctl` will use classic
82 * synchronous IO with the Unix socket if no IO functions are provided by the
83 * user. For all other cases, the user must provide the appropriate functions.
85 * A connection should be allocated by using @ref lldpctl_new(). It needs to be
86 * released with @ref lldpctl_release().
92 * Get default transport name.
94 * Currently, this is the default location of the Unix socket.
96 const char* lldpctl_get_default_transport(void);
99 * Structure referencing a connection with lldpd.
101 * This structure should be handled as opaque. It can be allocated
102 * with @c lldpctl_new() and the associated resources will be freed
103 * with @c lldpctl_release().
105 typedef struct lldpctl_conn_t lldpctl_conn_t
;
108 * Callback function invoked to send data to lldpd.
110 * @param lldpctl Handle to the connection to lldpd.
111 * @param data Bytes to be sent.
112 * @param length Length of provided data.
113 * @param user_data Provided user data.
114 * @return The number of bytes really sent or either @c LLDPCTL_ERR_WOULDBLOCK
115 * if no bytes can be sent without blocking or @c
116 * LLDPCTL_ERR_CALLBACK_FAILURE for other errors.
118 typedef ssize_t (*lldpctl_send_callback
)(lldpctl_conn_t
*conn
,
119 const uint8_t *data
, size_t length
, void *user_data
);
122 * Callback function invoked to receive data from lldpd.
124 * @param lldpctl Handle to the connection to lldpd.
125 * @param data Buffer for receiving data
126 * @param length Maximum bytes we can receive
127 * @param user_data Provided user data.
128 * @return The number of bytes really received or either @c
129 * LLDPCTL_ERR_WOULDBLOCK if no bytes can be received without blocking,
130 * @c LLDPCTL_ERR_CALLBACK_FAILURE for other errors or @c
131 * LLDPCTL_ERR_EOF if end of file was reached.
133 typedef ssize_t (*lldpctl_recv_callback
)(lldpctl_conn_t
*conn
,
134 const uint8_t *data
, size_t length
, void *user_data
);
137 * Function invoked when additional data is available from lldpd.
139 * This function should be invoked in case of asynchronous IO when new data is
140 * available from lldpd (expected or unexpected).
142 * @param conn Handle to the connection to lldpd.
143 * @param data Data received from lldpd.
144 * @param length Length of data received.
145 * @return The number of bytes available or a negative integer if an error has
146 * occurred. 0 is not an error. It usually means that a notification has
149 ssize_t
lldpctl_recv(lldpctl_conn_t
*conn
, const uint8_t *data
, size_t length
);
152 * Function invoked when there is an opportunity to send data to lldpd.
154 * This function should be invoked in case of asynchronous IO when new data can
155 * be written to lldpd.
157 * @param conn Handle to the connection to lldpd.
158 * @return The number of bytes processed or a negative integer if an error has
161 ssize_t
lldpctl_send(lldpctl_conn_t
*conn
);
164 * Allocate a new handler for connecting to lldpd.
166 * @param send Callback to be used when sending new data is requested.
167 * @param recv Callback to be used when receiving new data is requested.
168 * @param user_data Data to pass to callbacks.
169 * @return An handler to be used to connect to lldpd or @c NULL in
170 * case of error. In the later case, the error is probable an
171 * out of memory condition.
173 * The allocated handler can be released with @c lldpctl_release(). If the
174 * provided parameters are both @c NULL, default synchronous callbacks will be
177 lldpctl_conn_t
*lldpctl_new(lldpctl_send_callback send
,
178 lldpctl_recv_callback recv
, void *user_data
);
181 * Release resources associated with a connection to lldpd.
183 * @param conn Previously allocated handler to a connection to lldpd.
184 * @return 0 on success or a negative integer
188 int lldpctl_release(lldpctl_conn_t
*conn
);
192 * @defgroup lldpctl_errors_logs Errors and logs handling
194 * Error codes and logs handling.
196 * When a function returns a pointer, it may return @c NULL to indicate an error
197 * condition. In this case, it is possible to use @ref lldpctl_last_error() to
198 * get the related error code which is one of the values in @ref lldpctl_error_t
199 * enumeration. For display purpose @ref lldpctl_strerror() may be used to
200 * translate this error code.
202 * When a function returns an integer, it may return a negative value. It
203 * usually means this is an error but some functions may return a legetimate
204 * negative value (for example @ref lldpctl_atom_get_int()). When there is a
205 * doubt, @ref lldpctl_last_error() should be checked.
207 * An error is attached to a connection. If there is no connection, no error
208 * handling is available. Most functions use a connection or an atom as first
209 * argument and therefore are attached to a connection. To get the connection
210 * related to an atom, use @ref lldpctl_atom_get_connection().
212 * Also have a look at @ref lldpctl_log_callback() function if you want a custom
219 * Setup log handlers.
221 * By default, liblldpctl will log to stderr. The following function will
222 * register another callback for this purpose. Messages logged through this
223 * callback may be cryptic. They are targeted for the developer. Message for end
224 * users should rely on return codes.
226 void lldpctl_log_callback(void (*cb
)(int severity
, const char *msg
));
229 * Possible error codes for functions that return negative integers on
230 * this purpose or for @c lldpctl_last_error().
234 * No error has happened (yet).
236 LLDPCTL_NO_ERROR
= 0,
238 * A IO related operation would block if performed.
240 LLDPCTL_ERR_WOULDBLOCK
= -501,
242 * A IO related operation has reached a end of file condition.
244 LLDPCTL_ERR_EOF
= -502,
246 * The requested information does not exist. For example, when
247 * requesting an inexistant information from an atom.
249 LLDPCTL_ERR_NOT_EXIST
= -503,
251 * Cannot connect to the lldpd daemon. This error only happens with
252 * default synchronous handlers.
254 LLDPCTL_ERR_CANNOT_CONNECT
= -504,
256 * Atom is of incorrect type for the requested operation.
258 LLDPCTL_ERR_INCORRECT_ATOM_TYPE
= -505,
260 * An error occurred during serialization of message.
262 LLDPCTL_ERR_SERIALIZATION
= -506,
264 * The requested operation cannot be performed because we have another
265 * operation already running.
267 LLDPCTL_ERR_INVALID_STATE
= -507,
269 * The provided atom cannot be iterated.
271 LLDPCTL_ERR_CANNOT_ITERATE
= -508,
273 * The provided value is invalid.
275 LLDPCTL_ERR_BAD_VALUE
= -509,
277 * No new element can be created for this element.
279 LLDPCTL_ERR_CANNOT_CREATE
= -510,
281 * The library is under unexpected conditions and cannot process
282 * any further data reliably.
284 LLDPCTL_ERR_FATAL
= -900,
286 * Out of memory condition. Things may get havoc here but we
287 * should be able to recover.
289 LLDPCTL_ERR_NOMEM
= -901,
291 * An error occurred in a user provided callback.
293 LLDPCTL_ERR_CALLBACK_FAILURE
= -902
297 * Describe a provided error code.
299 * @param error Error code to be described.
300 * @return Statically allocated string describing the error.
302 const char *lldpctl_strerror(lldpctl_error_t error
);
305 * Get the last error associated to a connection to lldpd.
307 * @param conn Previously allocated handler to a connection to lldpd.
308 * @return 0 if no error is currently registered. A negative integer
311 * For functions returning int, this function will return the same
312 * error number. For functions returning something else, you can use
313 * this function to get the appropriate error number.
315 lldpctl_error_t
lldpctl_last_error(lldpctl_conn_t
*conn
);
318 * Describe the last error associate to a connection.
320 * @param conn Previously allocated handler to a connection to lldpd.
321 * @return Statically allocated string describing the error
323 #define lldpctl_last_strerror(conn) lldpctl_strerror(lldpctl_last_error(conn))
327 * @defgroup lldpctl_atoms Extracting information: atoms
329 * Information retrieved from lldpd is represented as an atom.
331 * This is an opaque structure that can be passed along some functions to
332 * transmit chassis, ports, VLAN and other information related to LLDP. Most
333 * information are extracted using @c lldpctl_atom_get(), @c
334 * lldpctl_atom_get_str(), @c lldpctl_atom_get_buffer() or @c
335 * lldpctl_atom_get_int(), unless some IO with lldpd is needed to retrieve the
336 * requested information. In this case, there exists an appropriate function to
337 * convert the "deferred" atom into a normal one (like @c lldpctl_get_port()).
339 * For some information, setters are also available: @c lldpctl_atom_set(), @c
340 * lldpctl_atom_set_str(), @c lldpctl_atom_set_buffer() or @c
341 * lldpctl_atom_set_int(). Unlike getters, some of those may require IO to
342 * achieve their goal.
344 * An atom is reference counted. Unless documented otherwise, a function
345 * returning an atom will return a new reference that should be decremented if
346 * not used anymore. It is quite important to use the reference counting
347 * functions correctly. Segfaults or memory leaks may occur otherwise.
353 * Structure representing an element (chassis, port, VLAN, ...)
355 * @see lldpctl_atom_inc_ref(), lldpctl_atom_dec_ref().
357 typedef struct lldpctl_atom_t lldpctl_atom_t
;
360 * Structure representing a map from an integer to a character string.
362 * @see lldpctl_key_get_map().
364 typedef const struct {
370 * Return the reference to connection with lldpd.
372 * @param atom The atom we want reference from.
373 * @return The reference to the connection to lldpd.
375 * Each atom contains an internal reference to the corresponding connection to
376 * lldpd. Use this function to get it.
378 lldpctl_conn_t
*lldpctl_atom_get_connection(lldpctl_atom_t
*atom
);
381 * Increment reference count for an atom.
383 * @param atom Atom we which to increase reference count.
385 void lldpctl_atom_inc_ref(lldpctl_atom_t
*atom
);
388 * Decrement reference count for an atom.
390 * @param atom Atom we want to decrease reference count. Can be @c NULL. In this
391 * case, nothing happens.
393 * When the reference count becomes 0, the atom is freed.
395 void lldpctl_atom_dec_ref(lldpctl_atom_t
*atom
);
398 * Possible events for a change (notification).
400 * @see lldpctl_watch_callback
403 lldpctl_c_deleted
, /**< The neighbor has been deleted */
404 lldpctl_c_updated
, /**< The neighbor has been updated */
405 lldpctl_c_added
, /**< This is a new neighbor */
409 * Callback function invoked when a change is detected.
411 * @param conn Connection with lldpd.
412 * @param type Type of change detected.
413 * @param interface Physical interface on which the change has happened.
414 * @param neighbor Changed neighbor.
415 * @param data Data provided when registering the callback.
417 * The provided interface and neighbor atoms will have their reference count
418 * decremented when the callback ends. If you want to keep a reference to it, be
419 * sure to increment the reference count in the callback.
421 * @see lldpctl_watch_callback
423 typedef void (*lldpctl_change_callback
)(lldpctl_conn_t
*conn
,
424 lldpctl_change_t type
,
425 lldpctl_atom_t
*interface
,
426 lldpctl_atom_t
*neighbor
,
430 * Register a callback to be called on changes.
432 * @param conn Connection with lldpd.
433 * @param cb Replace the current callback with the provided one.
434 * @param data Data that will be passed to the callback.
435 * @return 0 in case of success or -1 in case of errors.
437 * This function will register the necessity to push neighbor changes to lldpd
438 * and therefore will issue IO operations. The error code could then be @c
439 * LLDPCTL_ERR_WOULDBLOCK.
441 int lldpctl_watch_callback(lldpctl_conn_t
*conn
,
442 lldpctl_change_callback cb
,
446 * Wait for the next change.
448 * @param conn Connection with lldpd.
449 * @return 0 on success or a negative integer in case of error.
451 * This function will return once a change has been detected. It is only useful
452 * as a main loop when using the builtin blocking IO mechanism.
454 int lldpctl_watch(lldpctl_conn_t
*conn
);
457 * @defgroup liblldpctl_atom_get_special Retrieving atoms from lldpd
459 * Special access functions.
461 * Most information can be retrieved through @ref lldpctl_atom_get(), @ref
462 * lldpctl_atom_get_int(), @ref lldpctl_atom_get_str() or @ref
463 * lldpctl_atom_get_buffer() but some information can only be retrieved through
464 * special functions because IO operation is needed (and also, for some of them,
465 * because we don't have an atom yet).
471 * Retrieve global configuration of lldpd daemon.
473 * @param conn Connection with lldpd.
474 * @return The global configuration or @c NULL if an error happened.
476 * This function will make IO with the daemon to get the
477 * configuration. Depending on the IO model, information may not be available
478 * right now and the function should be called again later. If @c NULL is
479 * returned, check the last error. If it is @c LLDPCTL_ERR_WOULDBLOCK, try again
482 lldpctl_atom_t
*lldpctl_get_configuration(lldpctl_conn_t
*conn
);
485 * Retrieve the list of available interfaces.
487 * @param conn Previously allocated handler to a connection to lldpd.
488 * @return The list of available ports or @c NULL if an error happened.
490 * This function will make IO with the daemon to get the list of
491 * ports. Depending on the IO model, information may not be available right now
492 * and the function should be called again later. If @c NULL is returned, check
493 * what the last error is. If it is @c LLDPCTL_ERR_WOULDBLOCK, try again later
494 * (when more data is available).
496 * The list of available ports can be iterated with @ref lldpctl_atom_foreach().
498 lldpctl_atom_t
*lldpctl_get_interfaces(lldpctl_conn_t
*conn
);
501 * Retrieve the information related to a given interface.
503 * @param port The port we want to retrieve information from. This port is an
504 * atom retrieved from an interation on @c lldpctl_get_interfaces().
505 * @return Atom related to this port which may be used in subsequent functions.
507 * This functions may have to do IO to get the information related to the given
508 * port. Depending on the IO mode, information may not be available tight now
509 * and the function should be called again later. If @c NULL is returned, check
510 * what the last error is. If it is @c LLDPCTL_ERR_WOULDBLOCK, try again later
511 * (when more data is available).
513 lldpctl_atom_t
*lldpctl_get_port(lldpctl_atom_t
*port
);
518 * Piece of information that can be retrieved from/written to an atom.
520 * Each piece of information can potentially be retrieved as an atom (A), a
521 * string (S), a buffer (B) or an integer (I). Additionaly, when an information
522 * can be retrieved as an atom, it is usually iterable (L). When an atom can be
523 * retrieved as a string and as an additional type, the string is expected to be
524 * formatted. For example, the MAC address of a local port can be retrieved as a
525 * buffer and a string. As a string, you'll get something like
526 * "00:11:22:33:44:55". Also, all values that can be get as an integer or a
527 * buffer can be get as a string too. There is no special formatting in this
528 * case. "(BS)" means that the string get a special appropriate format.
530 * The name of a key is an indication on the type of atom that information can
531 * be extracted from. For example, @c lldpctl_k_med_policy_type can be extracted
532 * from an atom you got by iterating on @c lldpctl_k_port_med_policies. On the
533 * other hand, @c lldpctl_k_port_descr and @c lldpctl_k_chassis can be retrieved
534 * from an atom retrieved either by iterating @c lldpctl_k_port_neighbors or
535 * with @c lldpctl_get_port().
537 * Some values may be written. They are marked with (W). Such a change may or
538 * may not be transmitted immediatly. If they are not transmitted immediatly,
539 * this means that the resulting atom should be written to another atom. For
540 * example, when writting @c lldpctl_k_med_policy_tagged, you need to write the
541 * resulting atom to @c lldpctl_k_port_med_policies. If the change is
542 * transmitted immediatly, you need to check the error status of the connection
543 * to know if it has been transmitted correctly. Notably, if you get @c
544 * LLDPCTL_ERR_WOULDBLOCK, you need to try again later. Usually, changes are
545 * transmitted immediatly. The exception are changes that need to be grouped to
546 * be consistent, like a LLDP MED location. When a change is transmitted
547 * immediatly, it is marked with (O).
549 * Some values may also be created. They are flagged with (C). This only applies
550 * to elements that can be iterated (L) and written (W). The element created
551 * still needs to be appended to the list by being written to it. The creation
552 * is done with @c lldpctl_atom_create().
554 * An atom marked with (S) can be retrieved as a string only. It cannot be
555 * written. An atom marked with (IS) can be retrieved as an integer and features
556 * an appropriate representation as a string (usually, the name of a constant)
557 * which is more meaningful than just the integer. An atom marked as (I) can be
558 * retrieved and as a string. In the later case, this is just a string
559 * representation of the integer. An atom marked with (AL) can be retrieved as
560 * an atom only and can be iterated over. This is usually a list of things. An
561 * atom marked (I,W) can be read as an integer or a string and can be written as
562 * an integer. The change would not be commited until the atom is written to the
563 * nearest atom supporting (A,WO) operation (eventually with an indirection, i.e
564 * first write to a (A,W), then to a (A,WO)).
567 lldpctl_k_config_tx_interval
, /**< `(I,WO)` Transmit interval. When set to -1, it is meant to transmit now. */
568 lldpctl_k_config_receiveonly
, /**< `(I)` Receive only mode */
569 lldpctl_k_config_mgmt_pattern
, /**< `(S)` Pattern to choose the management address */
570 lldpctl_k_config_iface_pattern
, /**< `(S)` Pattern of enabled interfaces */
571 lldpctl_k_config_cid_pattern
, /**< `(S)` Interface pattern to choose the chassis ID */
572 lldpctl_k_config_description
, /**< `(S)` Chassis description overriden */
573 lldpctl_k_config_platform
, /**< `(S)` Platform description overriden (CDP) */
574 lldpctl_k_config_advertise_version
, /**< `(I)` Advertise version */
575 lldpctl_k_config_lldpmed_noinventory
, /**< `(I)` Disable LLDP-MED inventory */
577 lldpctl_k_interface_name
, /**< `(S)` The interface name. */
579 lldpctl_k_port_name
, /**< `(S)` The port name. Only works for a local port. */
580 lldpctl_k_port_index
, /**< `(I)` The port index. Only works for a local port. */
582 * `(AL)` The list of known neighbors for this port.
584 * A neighbor is in fact a remote port.
586 lldpctl_k_port_neighbors
,
587 lldpctl_k_port_protocol
, /**< `(IS)` The protocol that was used to retrieve this information. */
588 lldpctl_k_port_age
, /**< `(I)` Age of information, seconds from epoch. */
589 lldpctl_k_port_id_subtype
, /**< `(IS)` The subtype ID of this port. */
590 lldpctl_k_port_id
, /**< `(BS)` The ID of this port. */
591 lldpctl_k_port_descr
, /**< `(S)` The description of this port. */
592 lldpctl_k_port_hidden
, /**< `(I)` Is this port hidden (or should it be displayed?)? */
594 lldpctl_k_port_dot3_mfs
, /**< `(I)` MFS */
595 lldpctl_k_port_dot3_aggregid
, /**< `(I)` Port aggregation ID */
596 lldpctl_k_port_dot3_autoneg_support
, /**< `(I)` Autonegotiation support. */
597 lldpctl_k_port_dot3_autoneg_enabled
, /**< `(I)` Autonegotiation enabled. */
598 lldpctl_k_port_dot3_autoneg_advertised
, /**< `(I)` Advertised protocols. See `LLDP_DOT3_LINK_AUTONEG_*` */
599 lldpctl_k_port_dot3_mautype
, /**< `(IS)` Current MAU type. See `LLDP_DOT3_MAU_*` */
601 lldpctl_k_port_dot3_power
, /**< `(A,WO)` Dot3 power related stuff. */
602 lldpctl_k_dot3_power_devicetype
, /**< `(IS,W)` Device type. See `LLDP_DOT3_POWER_PSE/PD` */
603 lldpctl_k_dot3_power_supported
, /**< `(I,W)` Is MDI power supported. */
604 lldpctl_k_dot3_power_enabled
, /**< `(I,W)` Is MDI power enabled. */
605 lldpctl_k_dot3_power_paircontrol
, /**< `(I,W)` Pair-control enabled? */
606 lldpctl_k_dot3_power_pairs
, /**< `(IS,W)` See `LLDP_DOT3_POWERPAIRS_*` */
607 lldpctl_k_dot3_power_class
, /**< `(IS,W)` Power class. */
608 lldpctl_k_dot3_power_type
, /**< `(I,W)` 802.3AT power type */
609 lldpctl_k_dot3_power_source
, /**< `(IS,W)` 802.3AT power source */
610 lldpctl_k_dot3_power_priority
, /**< `(IS,W)` 802.3AT power priority */
611 lldpctl_k_dot3_power_allocated
, /**< `(I,W)` 802.3AT power allocated */
612 lldpctl_k_dot3_power_requested
, /**< `(I,W)` 802.3AT power requested */
614 lldpctl_k_port_vlan_pvid
, /**< `(I)` Primary VLAN ID */
615 lldpctl_k_port_vlans
, /**< `(AL)` List of VLAN */
616 lldpctl_k_vlan_id
, /**< `(I)` VLAN ID */
617 lldpctl_k_vlan_name
, /**< `(S)` VLAN name */
619 lldpctl_k_port_ppvids
, /**< `(AL)` List of PPVIDs */
620 lldpctl_k_ppvid_status
, /**< `(I)` Status of PPVID (see `LLDP_PPVID_CAP_*`) */
621 lldpctl_k_ppvid_id
, /**< `(I)` ID of PPVID */
623 lldpctl_k_port_pis
, /**< `(AL)` List of PIDs */
624 lldpctl_k_pi_id
, /**< `(B)` PID value */
626 lldpctl_k_chassis_index
, /**< `(I)` The chassis index. */
627 lldpctl_k_chassis_id_subtype
, /**< `(IS)` The subtype ID of this chassis. */
628 lldpctl_k_chassis_id
, /**< `(BS)` The ID of this chassis. */
629 lldpctl_k_chassis_name
, /**< `(S)` The name of this chassis. */
630 lldpctl_k_chassis_descr
, /**< `(S)` The description of this chassis. */
631 lldpctl_k_chassis_cap_available
, /**< `(I)` Available capabalities (see `LLDP_CAP_*`) */
632 lldpctl_k_chassis_cap_enabled
, /**< `(I)` Enabled capabilities (see `LLDP_CAP_*`) */
633 lldpctl_k_chassis_mgmt
, /**< `(AL)` List of management addresses */
635 lldpctl_k_chassis_med_type
, /**< `(IS)` Chassis MED type. See `LLDP_MED_CLASS_*` */
636 lldpctl_k_chassis_med_cap
, /**< `(I)` Available MED capabilitied. See `LLDP_MED_CAP_*` */
637 lldpctl_k_chassis_med_inventory_hw
, /**< `(S)` LLDP MED inventory "Hardware Revision" */
638 lldpctl_k_chassis_med_inventory_sw
, /**< `(S)` LLDP MED inventory "Software Revision" */
639 lldpctl_k_chassis_med_inventory_fw
, /**< `(S)` LLDP MED inventory "Firmware Revision" */
640 lldpctl_k_chassis_med_inventory_sn
, /**< `(S)` LLDP MED inventory "Serial Number" */
641 lldpctl_k_chassis_med_inventory_manuf
, /**< `(S)` LLDP MED inventory "Manufacturer" */
642 lldpctl_k_chassis_med_inventory_model
, /**< `(S)` LLDP MED inventory "Model" */
643 lldpctl_k_chassis_med_inventory_asset
, /**< `(S)` LLDP MED inventory "Asset ID" */
645 lldpctl_k_port_med_policies
, /**< `(AL,WO)` MED policies attached to a port. */
646 lldpctl_k_med_policy_type
, /**< `(IS,W)` MED policy app type. See `LLDP_MED_APPTYPE_*`. 0 if a policy is not defined. */
647 lldpctl_k_med_policy_unknown
, /**< `(I,W)` Is MED policy defined? */
648 lldpctl_k_med_policy_tagged
, /**< `(I,W)` MED policy tagging */
649 lldpctl_k_med_policy_vid
, /**< `(I,W)` MED policy VID */
650 lldpctl_k_med_policy_priority
, /**< `(I,W)` MED policy priority */
651 lldpctl_k_med_policy_dscp
, /**< `(I,W)` MED policy DSCP */
653 lldpctl_k_port_med_locations
, /**< `(AL,WO)` MED locations attached to a port. */
654 lldpctl_k_med_location_format
, /**< `(IS,W)` MED location format. See
655 * `LLDP_MED_LOCFORMAT_*`. 0 if this
656 * location is not defined. When written,
657 * the following fields will be zeroed
659 lldpctl_k_med_location_geoid
, /**< `(IS,W)` MED geoid. See `LLDP_MED_LOCATION_GEOID_*`. Only if format is COORD. */
660 lldpctl_k_med_location_latitude
, /**< `(S,W)` MED latitude. Only if format is COORD. */
661 lldpctl_k_med_location_longitude
, /**< `(S,W)` MED longitude. Only if format is COORD. */
662 lldpctl_k_med_location_altitude
, /**< `(S,W)` MED altitude. Only if format is COORD. */
663 lldpctl_k_med_location_altitude_unit
, /**< `(S,W)` MED altitude unit. See `LLDP_MED_LOCATION_ALTITUDE_UNIT_*`.
664 * Only if format is COORD. */
666 lldpctl_k_med_location_country
, /**< `(S,W)` MED country. Only if format is CIVIC. */
667 lldpctl_k_med_location_elin
, /**< `(S,W)` MED ELIN. Only if format is ELIN. */
669 lldpctl_k_med_location_ca_elements
, /**< `(AL,WC)` MED civic address elements. Only if format is CIVIC */
670 lldpctl_k_med_civicaddress_type
, /**< `(IS,W)` MED civic address type. */
671 lldpctl_k_med_civicaddress_value
, /**< `(S,W)` MED civic address value. */
673 lldpctl_k_port_med_power
, /**< `(A,WO)` LLDP-MED power related stuff. */
674 lldpctl_k_med_power_type
, /**< `(IS,W)` LLDP MED power device type. See `LLDP_MED_POW_TYPE_*` */
675 lldpctl_k_med_power_source
, /**< `(IS,W)` LLDP MED power source. See `LLDP_MED_POW_SOURCE_*` */
676 lldpctl_k_med_power_priority
, /**< `(IS,W)` LLDP MED power priority. See `LLDP_MED_POW_PRIO_*` */
677 lldpctl_k_med_power_val
, /**< `(I,W)` LLDP MED power value */
679 lldpctl_k_mgmt_ip
, /**< `(S)` IP address */
683 * Get a map related to a key.
685 * Many keys expect to be written with a discrete number of values. Take for
686 * example @c lldpctl_k_med_civicaddress_type, it can take any integer between 1
687 * and 128. However, each integer can be named. It can be useful for an
688 * application to get a translation between the integer that can be provided and
689 * a more human-readable name. This function allows to retrieve the
692 * @param key The piece of information we want a map from.
693 * @return The map or @c NULL if no map is available.
695 * The returned map has its last element set to 0. It is also expected that the
696 * string value can be used with a set operation. It will be translated to the
699 lldpctl_map_t
*lldpctl_key_get_map(lldpctl_key_t key
);
702 * Retrieve a bit of information as an atom.
704 * @param atom The atom we want to query.
705 * @param key The information we want from the atom.
706 * @return The atom representing the requested information or @c NULL if the
707 * information is not available.
709 * Not every value of @c info will be available as an atom. See the
710 * documentation of @c lldpctl_key_t for values accepting to be extracted as an
711 * atom. Usually, this is only iterable values or values representing a complex
714 * The provided atom is not a _borrowed_ reference. You need to decrement the
715 * reference count when you don't need it anymore.
717 * As a convenience, this function will return @c NULL if the first parameter is
718 * @c NULL and no error will be raised.
720 lldpctl_atom_t
*lldpctl_atom_get(lldpctl_atom_t
*atom
, lldpctl_key_t key
);
723 * Set a bit of information with an atom.
725 * @param atom The atom we want to write to.
726 * @param key The key information we want to write.
727 * @param value The value of the information we want to write.
728 * @return The updated atom with the appropriate information.
730 * This function will return @c NULL in case of error. If the last error is @c
731 * LLDPCTL_ERR_WOULDBLOCK, the write should be retried later with the exact same
732 * parameters. LLDPCTL_ERR_BAD_VALUE is raised when the provided atom is not
735 lldpctl_atom_t
*lldpctl_atom_set(lldpctl_atom_t
*atom
, lldpctl_key_t key
,
736 lldpctl_atom_t
*value
);
739 * Retrieve a bit of information as a null-terminated string.
741 * @param atom The atom we want to query.
742 * @param key The information we want from the atom.
743 * @return The requested string or @c NULL if the information is not available.
745 * Not every value of @c info will be available as a string. See the
746 * documentation of @c lldpctl_key_t for values accepting to be extracted as a
747 * string. Usually, only piece of information stored as string are available in
748 * this form but sometimes, you can get a nice formatted string instead of an
749 * integer with this function.
751 * As a convenience, this function will return @c NULL if the first parameter is
752 * @c NULL and no error will be raised.
754 * The provided string may live inside the atom providing it. If you need it
755 * longer, duplicate it.
757 const char *lldpctl_atom_get_str(lldpctl_atom_t
*atom
, lldpctl_key_t key
);
760 * Set a bit of information using a null-terminated string.
762 * @param atom The atom we want to write to.
763 * @param key The key information we want to write.
764 * @param value The value of the information we want to write.
765 * @return The updated atom with the appropriate information.
767 * This function will return @c NULL in case of error. If the last error is @c
768 * LLDPCTL_ERR_WOULDBLOCK, the write should be retried later with the exact same
769 * parameters. LLDPCTL_ERR_BAD_VALUE is raised when the provided atom is not
772 lldpctl_atom_t
*lldpctl_atom_set_str(lldpctl_atom_t
*atom
, lldpctl_key_t key
,
776 * Retrieve a bit of information as a buffer.
778 * @param atom The atom we want to query.
779 * @param key The information we want from the atom.
780 * @param[out] length The size of the returned buffer.
781 * @return The requested buffer or @c NULL if the information is not available.
783 * Not every value of @c info will be available as a buffer. See the
784 * documentation of @c lldpctl_key_t for values accepting to be extracted as a
785 * string. Usually, only piece of information stored as buffer are available in
788 * As a convenience, this function will return @c NULL if the first parameter is
789 * @c NULL and no error will be raised. If this function returns @c NULL, the
790 * third parameter is set to 0.
792 * The provided buffer may live inside the atom providing it. If you need it
793 * longer, duplicate it.
795 const u_int8_t
*lldpctl_atom_get_buffer(lldpctl_atom_t
*atom
, lldpctl_key_t key
,
799 * Set a bit of information using a buffer
801 * @param atom The atom we want to write to.
802 * @param key The key information we want to write.
803 * @param value The value of the information we want to write.
804 * @param length The length of the provided buffer.
805 * @return The updated atom with the appropriate information.
807 * This function will return @c NULL in case of error. If the last error is @c
808 * LLDPCTL_ERR_WOULDBLOCK, the write should be retried later with the exact same
809 * parameters. LLDPCTL_ERR_BAD_VALUE is raised when the provided atom is not
812 lldpctl_atom_t
*lldpctl_atom_set_buffer(lldpctl_atom_t
*atom
, lldpctl_key_t key
,
813 const u_int8_t
*value
, size_t length
);
816 * Retrieve a bit of information as an integer.
818 * @param atom The atom we want to query.
819 * @param key The information we want from the atom.
820 * @return The requested integer or -1 if the information is not available
822 * Not every value of @c info will be available as an integer. See the
823 * documentation of @c lldpctl_key_t for values accepting to be extracted as a
824 * string. Usually, only piece of information stored as an integer are available
827 * Only @c lldpctl_last_error() can tell if the returned value is an error or
828 * not. However, most values extracted from lldpd cannot be negative.
830 long int lldpctl_atom_get_int(lldpctl_atom_t
*atom
, lldpctl_key_t key
);
833 * Set a bit of information using an integer
835 * @param atom The atom we want to write to.
836 * @param key The key information we want to write.
837 * @param value The value of the information we want to write.
838 * @return The updated atom with the appropriate information.
840 * This function will return @c NULL in case of error. If the last error is @c
841 * LLDPCTL_ERR_WOULDBLOCK, the write should be retried later with the exact same
842 * parameters. LLDPCTL_ERR_BAD_VALUE is raised when the provided atom is not
845 lldpctl_atom_t
*lldpctl_atom_set_int(lldpctl_atom_t
*atom
, lldpctl_key_t key
,
849 * @defgroup liblldpctl_atom_iter Iterating over atoms
851 * Iterate over atoms (lists).
856 * Iterator over an iterable atom (a list of ports, a list of VLAN, ...). When
857 * an atom is a list, it can be iterated over to extract the appropriate values.
859 * @see lldpctl_atom_iter(), lldpctl_atom_iter_next(), lldpctl_atom_iter_value()
861 typedef struct lldpctl_atom_iter_t lldpctl_atom_iter_t
;
864 * Return an iterator over a given atom.
866 * If an atom is iterable (if it is a list, like a list of ports, a list of
867 * VLAN, a list of neighbors), it is possible to iterate over it. First use this
868 * function to get an iterator then use @c lldpctl_atom_iter_next() to get the
869 * next item and @c lldpctl_atom_iter_value() to the actuel item.
871 * @param atom The atom we want to create an iterator from.
872 * @return The iterator or @c NULL if an error happened or if the atom is empty
873 * (check with @c lldpctl_last_error()).
875 * As a convenience, if the provided atom is @c NULL, this function will return
876 * @c NULL and no error will be raised.
878 lldpctl_atom_iter_t
*lldpctl_atom_iter(lldpctl_atom_t
*atom
);
881 * Return the next element of an iterator.
883 * @param atom The atom we are currently iterating.
884 * @param iter The iterator we want the next element from.
885 * @return An iterator starting on the next element or @c NULL if we have no
888 * @see lldpctl_atom_iter(), lldpctl_atom_iter_value().
890 * As a convenience, if the provided atom is @c NULL, this function will return
891 * @c NULL and no error will be raised.
893 lldpctl_atom_iter_t
*lldpctl_atom_iter_next(lldpctl_atom_t
*atom
, lldpctl_atom_iter_t
*iter
);
896 * Return the value of an iterator.
898 * @param atom The atom we are currently iterating.
899 * @param iter The iterator we want the next element from.
900 * @return The atom currently associated with the iterator.
902 * @see lldpctl_atom_iter(), lldpctl_atom_iter_next().
904 lldpctl_atom_t
*lldpctl_atom_iter_value(lldpctl_atom_t
*atom
, lldpctl_atom_iter_t
*iter
);
907 * Convenience macro to iter over every value of an iterable object.
909 * @param atom The atom you want to iterate on.
910 * @param value Atom that will be used to contain each value.
912 * This macro behaves as a for loop. Moreover, at the end of each iteration,
913 * value is deallocated. Don't use it outside of the loop!
915 #define lldpctl_atom_foreach(atom, value) \
916 for (lldpctl_atom_iter_t *iter = lldpctl_atom_iter(atom); \
917 iter && (value = lldpctl_atom_iter_value(atom, iter)); \
918 iter = lldpctl_atom_iter_next(atom, iter), \
919 lldpctl_atom_dec_ref(value))
922 * Create a new value for an iterable element.
924 * The value is meant to be appended using @c lldpctl_atom_set(). Currently,
925 * there is no way to delete an element from a list. It is also not advisable to
926 * use getters on a newly created object until it is fully initialized. If its
927 * internal representation is using a buffer, it may not be initialized until
930 * @param atom The atom we want to create a new element for.
931 * @return The new element.
933 lldpctl_atom_t
*lldpctl_atom_create(lldpctl_atom_t
*atom
);