auth: Avoid cellconfig.c stdio renaming

Since commit 35777145 (solaris-fopen-sucks-20060916), cellconfig.c has
redirected fopen, fclose, and fgets to local functions on
non-64bit-sparc Solaris, in order to work around that platform's stdio
limitations.

Commit 7c431f7571 (auth: retire writeconfig.c) moved the contents of
writeconfig.c into cellconfig.c. The previous writeconfig.c contained
some calls to stdio, including calling fprintf() on a pointer returned
by fopen() in that file.

Because fopen() was redirected to our local version, this means that
afsconf_SetExtendedCellInfo() calls fopen() to get an
afsconf_iobuffer*, and passes that pointer to the real system
fprintf() later on (instead of a native FILE*). The compiler does warn
about this, but this only happens on Solaris, where --enable-checking
is not implemented, so the build never fails.

To avoid this, remove the #defines for fopen, fgets, and fclose.
Instead, change all of the old cellconfig.c callers to explicitly call
afsconf_fopen, afsconf_fgets, and afsconf_fclose. On the affected
Solaris platforms, we keep our local definitions, and for other
platforms, we just make those functions call their system stdio
equivalents. For the code that was pulled in from writeconfig.c,
callers will just call the system fopen, fprintf, and fclose.

We still keep our local afsconf_FILE* definition on all platforms, so
the compiler will still do typechecking for our local afsconf_f*
functions on all platforms. So now if we make a mistake, it should be
a mistake on all platforms, so platforms with --enable-checking should
flag the error.

Change-Id: I4064d7f5ee82d5acab04a33b01c0603564a391e8
Reviewed-on: https://gerrit.openafs.org/14214
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: Mark Vitale <mvitale@sinenomine.net>
Tested-by: Mark Vitale <mvitale@sinenomine.net>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>

diff --git a/src/auth/cellconfig.c b/src/auth/cellconfig.c
index 1fc1592..d41d4d2 100644 (file)
--- a/src/auth/cellconfig.c
+++ b/src/auth/cellconfig.c
@@ -195,12 +195,39 @@ afsconf_fgets(char *s, int n, afsconf_FILE *iop)
        }
     }
 }
-#define fopen afsconf_fopen
-#define fclose afsconf_fclose
-#define fgets afsconf_fgets
-#else
-#define afsconf_FILE FILE
-#endif /* AFS_SUN5_ENV && ! __sparcv9 */
+
+#else /* AFS_SUN5_ENV && !__sparcv9 */
+
+/*
+ * On all other platforms, we use the native stdio functions. We still go
+ * through our afsconf_f* wrappers here, to still do compile-time checks to
+ * make sure we don't mix afsconf_fopen with real stdio calls.
+ */
+struct afsconf_iobuffer;
+
+typedef struct afsconf_iobuffer afsconf_FILE;
+
+static afsconf_FILE *
+afsconf_fopen(const char *fname, const char *fmode)
+{
+    return (afsconf_FILE*)fopen(fname, fmode);
+}
+
+static int
+afsconf_fclose(afsconf_FILE *iop)
+{
+    FILE *fh = (FILE *)iop;
+    return fclose(fh);
+}
+
+static char *
+afsconf_fgets(char *s, int n, afsconf_FILE *iop)
+{
+    FILE *fh = (FILE *)iop;
+    return fgets(s, n, fh);
+}
+
+#endif /* AFS_SUN5_ENV && !__sparcv9 */
 
 /* return port number in network byte order in the low 16 bits of a long; return -1 if not found */
 afs_int32
@@ -446,12 +473,12 @@ ReadFirstLine(const char *pathname, char **aline)
     afsconf_FILE *fp;
     size_t len = 0;
 
-    fp = fopen(pathname, "r");
+    fp = afsconf_fopen(pathname, "r");
     if (!fp)
        return ENOENT;
-    if (fgets(buffer, sizeof(buffer), fp) != NULL)
+    if (afsconf_fgets(buffer, sizeof(buffer), fp) != NULL)
        len = strlen(buffer);
-    fclose(fp);
+    afsconf_fclose(fp);
     if (len == 0)
        return EIO;
     /* Trim the trailing newline, if one. */
@@ -578,12 +605,12 @@ GetCellUnix(struct afsconf_dir *adir)
 
     strcompose(tbuffer, 256, adir->name, "/", AFSDIR_THISCELL_FILE,
        (char *)NULL);
-    fp = fopen(tbuffer, "r");
+    fp = afsconf_fopen(tbuffer, "r");
     if (fp == 0) {
        return -1;
     }
-    rc = fgets(tbuffer, 256, fp);
-    fclose(fp);
+    rc = afsconf_fgets(tbuffer, 256, fp);
+    afsconf_fclose(fp);
     if (rc == NULL)
         return -1;
 
@@ -745,7 +772,7 @@ LoadConfig(struct afsconf_dir *adir)
        adir->timeRead = 0;
     }
 
-    tf = fopen(adir->cellservDB, "r");
+    tf = afsconf_fopen(adir->cellservDB, "r");
     if (!tf) {
        return -1;
     }
@@ -763,7 +790,7 @@ LoadConfig(struct afsconf_dir *adir)
      */
 
     while (1) {
-       tp = fgets(tbuffer, sizeof(tbuffer), tf);
+       tp = afsconf_fgets(tbuffer, sizeof(tbuffer), tf);
        if (!tp)
            break;
        TrimLine(tbuffer, sizeof tbuffer);      /* remove white space */
@@ -783,7 +810,7 @@ LoadConfig(struct afsconf_dir *adir)
                ParseCellLine(tbuffer, curEntry->cellInfo.name, linkedcell);
            if (code) {
                UnloadConfig(adir);
-               fclose(tf);
+               afsconf_fclose(tf);
                free(curEntry);
                return -1;
            }
@@ -793,7 +820,7 @@ LoadConfig(struct afsconf_dir *adir)
            /* new host in the current cell */
            if (!curEntry) {
                UnloadConfig(adir);
-               fclose(tf);
+               afsconf_fclose(tf);
                return -1;
            }
            i = curEntry->cellInfo.numServers;
@@ -814,7 +841,7 @@ LoadConfig(struct afsconf_dir *adir)
                                tbuffer, adir->cellservDB);
                    }
                    free(curEntry);
-                   fclose(tf);
+                   afsconf_fclose(tf);
                    UnloadConfig(adir);
                    return -1;
                }
@@ -826,7 +853,7 @@ LoadConfig(struct afsconf_dir *adir)
            }
        }
     }
-    fclose(tf);                        /* close the file now */
+    afsconf_fclose(tf);                        /* close the file now */
 
     /* end the last partially-completed cell */
     if (curEntry) {
@@ -850,11 +877,11 @@ LoadConfig(struct afsconf_dir *adir)
     strcompose(tbuffer, 256, adir->name, "/", AFSDIR_CELLALIAS_FILE,
        (char *)NULL);
 
-    tf = fopen(tbuffer, "r");
+    tf = afsconf_fopen(tbuffer, "r");
     while (tf) {
        char *aliasPtr;
 
-       tp = fgets(tbuffer, sizeof(tbuffer), tf);
+       tp = afsconf_fgets(tbuffer, sizeof(tbuffer), tf);
        if (!tp)
            break;
        TrimLine(tbuffer, sizeof tbuffer);      /* remove white space */
@@ -889,7 +916,7 @@ LoadConfig(struct afsconf_dir *adir)
     }
 
     if (tf != NULL)
-       fclose(tf);
+       afsconf_fclose(tf);
 
     /* now read the fs keys, if possible */
     code = _afsconf_LoadKeys(adir);