URL: https://github.com/SSSD/sssd/pull/333
Author: amitkumar50
 Title: #333: Move header files consumed by both server and client to special 
folder
Action: synchronized

To pull the PR as Git branch:
git remote add ghsssd https://github.com/SSSD/sssd
git fetch ghsssd pull/333/head:pr333
git checkout pr333
From 3036853685f615df794970209d01c05cd735edca Mon Sep 17 00:00:00 2001
From: AmitKumar <amitk...@redhat.com>
Date: Sun, 23 Jul 2017 05:19:27 +0530
Subject: [PATCH] Moving headers used by both server and client to special
 folder

These are the header files which are used by both client and server:
src/util/io.h
src/util/murmurhash3.h
src/util/util_safealign.h

This PR is about moving these header files to special forlder
(src/shared). It will be easier to identify these headers when looking
 for them in the src tree.

Resolves:
https://pagure.io/SSSD/sssd/issue/1898
---
 Makefile.am                           | 6 +++---
 src/lib/idmap/sss_idmap.c             | 2 +-
 src/providers/ldap/sdap_idmap.c       | 4 ++--
 src/python/pysss_murmur.c             | 2 +-
 src/{util => shared}/io.h             | 5 -----
 src/{util => shared}/murmurhash3.h    | 4 ----
 src/{util => shared}/util_safealign.h | 6 ------
 src/sss_client/nss_mc_common.c        | 2 +-
 src/sss_client/nss_mc_group.c         | 2 +-
 src/sss_client/nss_mc_initgr.c        | 2 +-
 src/sss_client/sss_cli.h              | 2 +-
 src/tests/cmocka/test_inotify.c       | 2 +-
 src/tests/cmocka/test_io.c            | 2 +-
 src/tests/util-tests.c                | 2 +-
 src/util/io.c                         | 2 +-
 src/util/mmap_cache.h                 | 2 +-
 src/util/murmurhash3.c                | 2 +-
 src/util/util.h                       | 4 ++--
 18 files changed, 19 insertions(+), 34 deletions(-)
 rename src/{util => shared}/io.h (85%)
 rename src/{util => shared}/murmurhash3.h (77%)
 rename src/{util => shared}/util_safealign.h (97%)

diff --git a/Makefile.am b/Makefile.am
index e7d69d2f0..240a57c6d 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -652,7 +652,6 @@ dist_noinst_HEADERS = \
     src/util/dlinklist.h \
     src/util/debug.h \
     src/util/util.h \
-    src/util/io.h \
     src/util/util_errors.h \
     src/util/safe-format-string.h \
     src/util/session_recording.h \
@@ -673,13 +672,11 @@ dist_noinst_HEADERS = \
     src/util/refcount.h \
     src/util/find_uid.h \
     src/util/user_info_msg.h \
-    src/util/murmurhash3.h \
     src/util/mmap_cache.h \
     src/util/atomic_io.h \
     src/util/auth_utils.h \
     src/util/authtok.h \
     src/util/authtok-utils.h \
-    src/util/util_safealign.h \
     src/util/util_sss_idmap.h \
     src/util/util_creds.h \
     src/util/inotify.h \
@@ -849,6 +846,9 @@ dist_noinst_HEADERS = \
     src/tools/common/sss_colondb.h \
     src/tools/sssctl/sssctl.h \
     src/util/probes.h \
+    src/shared/io.h \
+    src/shared/murmurhash3.h \
+    src/shared/util_safealign.h \
     $(NULL)
 
 
diff --git a/src/lib/idmap/sss_idmap.c b/src/lib/idmap/sss_idmap.c
index 51338c587..56ba904bc 100644
--- a/src/lib/idmap/sss_idmap.c
+++ b/src/lib/idmap/sss_idmap.c
@@ -29,7 +29,7 @@
 
 #include "lib/idmap/sss_idmap.h"
 #include "lib/idmap/sss_idmap_private.h"
-#include "util/murmurhash3.h"
+#include "shared/murmurhash3.h"
 
 #define SID_FMT "%s-%d"
 #define SID_STR_MAX_LEN 1024
diff --git a/src/providers/ldap/sdap_idmap.c b/src/providers/ldap/sdap_idmap.c
index 0fda81522..9656b876e 100644
--- a/src/providers/ldap/sdap_idmap.c
+++ b/src/providers/ldap/sdap_idmap.c
@@ -20,10 +20,10 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+#include "providers/ldap/sdap_idmap.h"
+#include "shared/murmurhash3.h"
 #include "util/util.h"
 #include "util/dlinklist.h"
-#include "util/murmurhash3.h"
-#include "providers/ldap/sdap_idmap.h"
 #include "util/util_sss_idmap.h"
 
 static errno_t
diff --git a/src/python/pysss_murmur.c b/src/python/pysss_murmur.c
index a7519e856..060d29df3 100644
--- a/src/python/pysss_murmur.c
+++ b/src/python/pysss_murmur.c
@@ -23,7 +23,7 @@
 #include <Python.h>
 
 #include "util/sss_python.h"
-#include "util/murmurhash3.h"
+#include "shared/murmurhash3.h"
 
 PyDoc_STRVAR(murmurhash3_doc,
 "murmurhash3(key, key_len, seed) -> 32bit integer hash\n\
diff --git a/src/util/io.h b/src/shared/io.h
similarity index 85%
rename from src/util/io.h
rename to src/shared/io.h
index 8d10ed9c2..5a545b608 100644
--- a/src/util/io.h
+++ b/src/shared/io.h
@@ -22,11 +22,6 @@
 #ifndef _UTIL_IO_H_
 #define _UTIL_IO_H_
 
-/* CAUTION:
- * This file is also used in sss_client (pam, nss). Therefore it have to be
- * minimalist and cannot include DEBUG macros or header file util.h.
- */
-
 int sss_open_cloexec(const char *pathname, int flags, int *ret);
 int sss_openat_cloexec(int dir_fd, const char *pathname, int flags, int *ret);
 
diff --git a/src/util/murmurhash3.h b/src/shared/murmurhash3.h
similarity index 77%
rename from src/util/murmurhash3.h
rename to src/shared/murmurhash3.h
index 6910e596b..3cea68ed3 100644
--- a/src/util/murmurhash3.h
+++ b/src/shared/murmurhash3.h
@@ -11,10 +11,6 @@
 
 #include <stdint.h>
 
-/* CAUTION:
- * This file is also used in sss_client (pam, nss). Therefore it have to be
- * minimalist and cannot include DEBUG macros or header file util.h.
- */
 uint32_t murmurhash3(const char *key, int len, uint32_t seed);
 
 #endif /* _UTIL_MURMURHASH3_H_ */
diff --git a/src/util/util_safealign.h b/src/shared/util_safealign.h
similarity index 97%
rename from src/util/util_safealign.h
rename to src/shared/util_safealign.h
index 57f04a17d..51f6de030 100644
--- a/src/util/util_safealign.h
+++ b/src/shared/util_safealign.h
@@ -20,12 +20,6 @@
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-/* CAUTION:
- * This file is also used in sss_client (pam, nss). Therefore it has to be
- * minimalist and cannot include DEBUG macros or header file util.h.
- */
-
-
 #ifndef _UTIL_SAFEALIGN_H
 #define _UTIL_SAFEALIGN_H
 
diff --git a/src/sss_client/nss_mc_common.c b/src/sss_client/nss_mc_common.c
index 6cff2e1b9..696d67246 100644
--- a/src/sss_client/nss_mc_common.c
+++ b/src/sss_client/nss_mc_common.c
@@ -32,7 +32,7 @@
 #include <stdlib.h>
 #include "nss_mc.h"
 #include "sss_cli.h"
-#include "util/io.h"
+#include "shared/io.h"
 
 /* FIXME: hook up to library destructor to avoid leaks */
 /* FIXME: temporarily open passwd file on our own, later we will probably
diff --git a/src/sss_client/nss_mc_group.c b/src/sss_client/nss_mc_group.c
index aacf59d9f..d6303e873 100644
--- a/src/sss_client/nss_mc_group.c
+++ b/src/sss_client/nss_mc_group.c
@@ -27,7 +27,7 @@
 #include <sys/mman.h>
 #include <time.h>
 #include "nss_mc.h"
-#include "util/util_safealign.h"
+#include "shared/util_safealign.h"
 
 struct sss_cli_mc_ctx gr_mc_ctx = { UNINITIALIZED, -1, 0, NULL, 0, NULL, 0,
                                     NULL, 0, 0 };
diff --git a/src/sss_client/nss_mc_initgr.c b/src/sss_client/nss_mc_initgr.c
index 74143d9fb..f06d25a51 100644
--- a/src/sss_client/nss_mc_initgr.c
+++ b/src/sss_client/nss_mc_initgr.c
@@ -30,7 +30,7 @@
 #include <sys/mman.h>
 #include <time.h>
 #include "nss_mc.h"
-#include "util/util_safealign.h"
+#include "shared/util_safealign.h"
 
 struct sss_cli_mc_ctx initgr_mc_ctx = { UNINITIALIZED, -1, 0, NULL, 0, NULL, 0,
                                         NULL, 0, 0 };
diff --git a/src/sss_client/sss_cli.h b/src/sss_client/sss_cli.h
index d4198407f..2c4d179ae 100644
--- a/src/sss_client/sss_cli.h
+++ b/src/sss_client/sss_cli.h
@@ -32,7 +32,7 @@
 #include <stdint.h>
 #include <limits.h>
 
-#include "util/util_safealign.h"
+#include "shared/util_safealign.h"
 
 #ifndef HAVE_ERRNO_T
 #define HAVE_ERRNO_T
diff --git a/src/tests/cmocka/test_inotify.c b/src/tests/cmocka/test_inotify.c
index 1f8561df1..43e36e8ce 100644
--- a/src/tests/cmocka/test_inotify.c
+++ b/src/tests/cmocka/test_inotify.c
@@ -26,7 +26,7 @@
 #include <popt.h>
 
 #include "limits.h"
-#include "util/io.h"
+#include "shared/io.h"
 #include "util/inotify.h"
 #include "util/util.h"
 #include "tests/common.h"
diff --git a/src/tests/cmocka/test_io.c b/src/tests/cmocka/test_io.c
index 8d29a05cd..20475a01e 100644
--- a/src/tests/cmocka/test_io.c
+++ b/src/tests/cmocka/test_io.c
@@ -36,7 +36,7 @@
 #include <libgen.h>
 
 #include "limits.h"
-#include "util/io.h"
+#include "shared/io.h"
 #include "util/util.h"
 #include "tests/common.h"
 
diff --git a/src/tests/util-tests.c b/src/tests/util-tests.c
index a1b3fddce..d9f2b91c6 100644
--- a/src/tests/util-tests.c
+++ b/src/tests/util-tests.c
@@ -34,7 +34,7 @@
 
 #include "util/util.h"
 #include "util/sss_utf8.h"
-#include "util/murmurhash3.h"
+#include "shared/murmurhash3.h"
 #include "tests/common_check.h"
 
 #define FILENAME_TEMPLATE "tests-atomicio-XXXXXX"
diff --git a/src/util/io.c b/src/util/io.c
index 42e7563c9..4d442b47a 100644
--- a/src/util/io.c
+++ b/src/util/io.c
@@ -28,7 +28,7 @@
 #include <fcntl.h>
 #include <errno.h>
 
-#include "util/io.h"
+#include "shared/io.h"
 
 /* CAUTION:
  * This file have to be minimalist and cannot include DEBUG macros
diff --git a/src/util/mmap_cache.h b/src/util/mmap_cache.h
index 22c1ae62d..63e096027 100644
--- a/src/util/mmap_cache.h
+++ b/src/util/mmap_cache.h
@@ -22,7 +22,7 @@
 #ifndef _MMAP_CACHE_H_
 #define _MMAP_CACHE_H_
 
-#include "util/murmurhash3.h"
+#include "shared/murmurhash3.h"
 
 
 /* NOTE: all the code here assumes that writing a uint32_t nto mmapped
diff --git a/src/util/murmurhash3.c b/src/util/murmurhash3.c
index 061e64e99..f8db9d2ee 100644
--- a/src/util/murmurhash3.c
+++ b/src/util/murmurhash3.c
@@ -11,7 +11,7 @@
 #include <string.h>
 
 #include "config.h"
-#include "util/murmurhash3.h"
+#include "shared/murmurhash3.h"
 #include "util/sss_endian.h"
 
 static uint32_t rotl(uint32_t x, int8_t r)
diff --git a/src/util/util.h b/src/util/util.h
index 934fae37d..2a770f9d2 100644
--- a/src/util/util.h
+++ b/src/util/util.h
@@ -39,9 +39,10 @@
 #include <dhash.h>
 
 #include "confdb/confdb.h"
+#include "shared/io.h"
+#include "shared/util_safealign.h"
 #include "util/atomic_io.h"
 #include "util/util_errors.h"
-#include "util/util_safealign.h"
 #include "util/sss_format.h"
 #include "util/debug.h"
 
@@ -591,7 +592,6 @@ errno_t get_dom_names(TALLOC_CTX *mem_ctx,
 /* from util_lock.c */
 errno_t sss_br_lock_file(int fd, size_t start, size_t len,
                          int num_tries, useconds_t wait);
-#include "io.h"
 
 #ifdef HAVE_PAC_RESPONDER
 #define BUILD_WITH_PAC_RESPONDER true
_______________________________________________
sssd-devel mailing list -- sssd-devel@lists.fedorahosted.org
To unsubscribe send an email to sssd-devel-le...@lists.fedorahosted.org

Reply via email to