blob: 2d94767739de5b62c86031b043a782e232991ddf [file] [log] [blame]
Radek Krejcid0d19522015-09-02 13:49:25 +02001/**
2 * \file config.h
3 * \author Radek Krejci <rkrejci@cesnet.cz>
4 * \brief libnetconf2 various configuration settings.
5 *
Michal Vaskof471fa02017-02-15 10:48:12 +01006 * Copyright (c) 2015 - 2017 CESNET, z.s.p.o.
Radek Krejcid0d19522015-09-02 13:49:25 +02007 *
Radek Krejci9b81f5b2016-02-24 13:14:49 +01008 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
Michal Vaskoafd416b2016-02-25 14:51:46 +010011 *
Radek Krejci9b81f5b2016-02-24 13:14:49 +010012 * https://opensource.org/licenses/BSD-3-Clause
Radek Krejcid0d19522015-09-02 13:49:25 +020013 */
14
15#ifndef NC_CONFIG_H_
16#define NC_CONFIG_H_
17
18/*
David Sedlákaae4df32018-10-08 22:27:22 +020019 * Mark all objects as hidden and export only objects explicitly marked to be part of the public API or
20 * those marked as mock objects for testing purpose
Radek Krejcid0d19522015-09-02 13:49:25 +020021 */
22#define API __attribute__((visibility("default")))
David Sedlákddde4492018-09-30 21:34:38 +020023#define MOCK __attribute__((visibility("default")))
24
Michal Vasko05ba9df2016-01-13 14:40:27 +010025#ifdef __GNUC__
26# define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
27#else
28# define UNUSED(x) UNUSED_ ## x
29#endif
30
Radek Krejci14b14032015-10-21 15:19:43 +020031/*
Michal Vasko7ae909a2018-11-09 09:51:42 +010032 * Support for atomic variables
Radek Krejci32898d52016-07-14 17:37:02 +020033 */
Michal Vasko7ae909a2018-11-09 09:51:42 +010034#cmakedefine HAVE_STDATOMIC
35#ifdef HAVE_STDATOMIC
36# include <stdatomic.h>
Michal Vaskoe2010152020-09-09 08:29:12 +020037# include <stdint.h>
Michal Vasko7ae909a2018-11-09 09:51:42 +010038
39# define ATOMIC_UINT32_T atomic_uint_fast32_t
Michal Vasko7f1fa3c2020-09-08 16:30:41 +020040# define ATOMIC_PTR atomic_uintptr_t
Michal Vaskob639e9c2020-09-09 09:51:48 +020041# define ATOMIC_STORE(x, val) atomic_store(&(x), (val))
42# define ATOMIC_LOAD(x) atomic_load((atomic_uintptr_t *)&(x))
Michal Vasko7f1fa3c2020-09-08 16:30:41 +020043# define ATOMIC_INC(x) atomic_fetch_add(&(x), 1)
Michal Vasko7ae909a2018-11-09 09:51:42 +010044#else
45# define ATOMIC_UINT32_T uint32_t
Michal Vasko7f1fa3c2020-09-08 16:30:41 +020046# define ATOMIC_PTR void *
Michal Vaskob639e9c2020-09-09 09:51:48 +020047# define ATOMIC_STORE(x, val) (x) = (val)
48# define ATOMIC_LOAD(x) (x)
Michal Vasko7f1fa3c2020-09-08 16:30:41 +020049# define ATOMIC_INC(x) __sync_add_and_fetch(&(x), 1)
Radek Krejci32898d52016-07-14 17:37:02 +020050#endif
51
52/*
Radek Krejci28472922016-07-15 11:51:16 +020053 * support for pthread_mutex_timedlock
54 */
55#cmakedefine HAVE_PTHREAD_MUTEX_TIMEDLOCK
56
57/*
apropp-molex4e903c32020-04-20 03:06:58 -040058 * Support for getpeereid
59 */
60#cmakedefine HAVE_GETPEEREID
61
62/*
63 * Support for shadow file manipulation
64 */
65#cmakedefine HAVE_SHADOW
66
67/*
68 * Support for crypt.h
69 */
70#cmakedefine HAVE_CRYPT
71
72/*
Michal Vasko5a446472020-05-06 12:43:42 +020073 * Location of installed basic YANG modules on the system
Radek Krejci14b14032015-10-21 15:19:43 +020074 */
Michal Vasko5a446472020-05-06 12:43:42 +020075#define NC_YANG_DIR "@YANG_MODULE_DIR@"
Radek Krejci14b14032015-10-21 15:19:43 +020076
Michal Vasko6b7c42e2016-03-02 15:46:41 +010077/*
Michal Vaskof471fa02017-02-15 10:48:12 +010078 * Inactive read timeout
Michal Vasko6b7c42e2016-03-02 15:46:41 +010079 */
Michal Vaskof471fa02017-02-15 10:48:12 +010080#define NC_READ_INACT_TIMEOUT @READ_INACTIVE_TIMEOUT@
81
82/*
83 * Active read timeout in seconds
84 * (also used for internal <get-schema> RPC reply timeout)
85 */
86#define NC_READ_ACT_TIMEOUT @READ_ACTIVE_TIMEOUT@
Michal Vasko6b7c42e2016-03-02 15:46:41 +010087
Michal Vaskoafdb8ec2017-02-15 11:25:36 +010088/*
89 * pspoll structure queue size (also found in nc_server.h)
90 */
91#define NC_PS_QUEUE_SIZE @MAX_PSPOLL_THREAD_COUNT@
92
Michal Vasko5a9bd9c2019-08-16 15:50:09 +020093/* Microseconds after which tasks are repeated until the full timeout elapses.
94 * A millisecond (1000) should be divisible by this number without remain.
95 */
96#define NC_TIMEOUT_STEP @TIMEOUT_STEP@
97
Rosen Penevef2f3ac2019-07-15 18:15:28 -070098/* Portability feature-check macros. */
99#cmakedefine HAVE_PTHREAD_RWLOCKATTR_SETKIND_NP
100
Radek Krejcid0d19522015-09-02 13:49:25 +0200101#endif /* NC_CONFIG_H_ */