123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509 |
- /****************************************************************************
- * fs/nfs/nfs_util.c
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership. The
- * ASF licenses this file to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance with the
- * License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations
- * under the License.
- *
- ****************************************************************************/
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <sys/types.h>
- #include <sys/time.h>
- #include <stdint.h>
- #include <stdbool.h>
- #include <stdlib.h>
- #include <time.h>
- #include <string.h>
- #include <assert.h>
- #include <errno.h>
- #include <debug.h>
- #include "rpc.h"
- #include "nfs.h"
- #include "nfs_proto.h"
- #include "nfs_mount.h"
- #include "nfs_node.h"
- #include "xdr_subs.h"
- /****************************************************************************
- * Private Functions
- ****************************************************************************/
- static inline int nfs_pathsegment(FAR const char **path, FAR char *buffer,
- FAR char *terminator)
- {
- FAR const char *src = *path;
- FAR char *dest = buffer;
- int nbytes = 0;
- char ch;
- /* Loop until the name is successfully parsed or an error occurs */
- for (; ; )
- {
- /* Get the next byte from the path */
- ch = *src++;
- /* Check if this the last byte in this segment name */
- if (ch == '\0' || ch == '/')
- {
- /* This logic just supports "//" sequences in the path name */
- if (ch == '\0' || nbytes > 0)
- {
- /* NULL terminate the parsed path segment */
- *dest = '\0';
- /* Return next path and the terminating character */
- *terminator = ch;
- *path = src;
- return OK;
- }
- /* Just skip over any leading '/' characters */
- }
- else if (nbytes >= NAME_MAX)
- {
- ferr("ERROR: File name segment is too long: %d\n", *path);
- return -EFBIG;
- }
- else
- {
- /* Save next character in the accumulated name */
- *dest++ = ch;
- nbytes++;
- }
- }
- }
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: nfs_request
- *
- * Description:
- * Perform the NFS request. On successful receipt, it verifies the NFS
- * level of the returned values.
- *
- * Returned Value:
- * Zero on success; a negative errno value on failure.
- *
- ****************************************************************************/
- int nfs_request(FAR struct nfsmount *nmp, int procnum,
- FAR void *request, size_t reqlen,
- FAR void *response, size_t resplen)
- {
- FAR struct rpcclnt *clnt = nmp->nm_rpcclnt;
- struct nfs_reply_header replyh;
- int error;
- error = rpcclnt_request(clnt, procnum, NFS_PROG, NFS_VER3,
- request, reqlen, response, resplen);
- if (error != 0)
- {
- ferr("ERROR: rpcclnt_request failed: %d\n", error);
- return error;
- }
- memcpy(&replyh, response, sizeof(struct nfs_reply_header));
- if (replyh.nfs_status != 0)
- {
- /* NFS_ERRORS are the same as NuttX errno values */
- return -fxdr_unsigned(uint32_t, replyh.nfs_status);
- }
- if (replyh.rh.rpc_verfi.authtype != 0)
- {
- error = -EOPNOTSUPP;
- ferr("ERROR: NFS authtype %d from server\n",
- fxdr_unsigned(int, replyh.rh.rpc_verfi.authtype));
- return error;
- }
- finfo("NFS_SUCCESS\n");
- return OK;
- }
- /****************************************************************************
- * Name: nfs_lookup
- *
- * Description:
- * Given a directory file handle, and the path to file in the directory,
- * return the file handle of the path and attributes of both the file and
- * the directory containing the file.
- *
- * NOTE: The LOOKUP call differs from other RPC messages in that the
- * call message is variable length, depending upon the size of the path
- * name.
- *
- ****************************************************************************/
- int nfs_lookup(FAR struct nfsmount *nmp, FAR const char *filename,
- FAR struct file_handle *fhandle,
- FAR struct nfs_fattr *obj_attributes,
- FAR struct nfs_fattr *dir_attributes)
- {
- FAR uint32_t *ptr;
- uint32_t value;
- int reqlen;
- int namelen;
- int error = 0;
- DEBUGASSERT(nmp && filename && fhandle);
- /* Get the length of the string to be sent */
- namelen = strlen(filename);
- if (namelen > NAME_MAX)
- {
- ferr("ERROR: Length of the string is too long: %d\n", namelen);
- return -E2BIG;
- }
- /* Initialize the request */
- ptr = (FAR uint32_t *)&nmp->nm_msgbuffer.lookup.lookup;
- reqlen = 0;
- /* Copy the variable length, directory file handle */
- *ptr++ = txdr_unsigned(fhandle->length);
- reqlen += sizeof(uint32_t);
- memcpy(ptr, &fhandle->handle, fhandle->length);
- reqlen += uint32_alignup(fhandle->length);
- ptr += uint32_increment(fhandle->length);
- /* Copy the variable-length file name */
- *ptr++ = txdr_unsigned(namelen);
- reqlen += sizeof(uint32_t);
- memcpy(ptr, filename, namelen);
- reqlen += uint32_alignup(namelen);
- /* Request LOOKUP from the server */
- nfs_statistics(NFSPROC_LOOKUP);
- error = nfs_request(nmp, NFSPROC_LOOKUP,
- (FAR void *)&nmp->nm_msgbuffer.lookup, reqlen,
- (FAR void *)nmp->nm_iobuffer, nmp->nm_buflen);
- if (error)
- {
- ferr("ERROR: nfs_request failed: %d\n", error);
- return error;
- }
- /* Return the data to the caller's buffers. NOTE: Here we ignore the
- * the exact layout of the rpc_reply_lookup structure. File handles
- * may differ in size whereas struct rpc_reply_lookup uses a fixed size.
- */
- ptr = (FAR uint32_t *)
- &((FAR struct rpc_reply_lookup *)nmp->nm_iobuffer)->lookup;
- /* Get the length of the file handle */
- value = *ptr++;
- value = fxdr_unsigned(uint32_t, value);
- if (value > NFSX_V3FHMAX)
- {
- ferr("ERROR: Bad file handle length: %d\n", value);
- return -EIO;
- }
- /* Return the file handle */
- fhandle->length = value;
- memcpy(&fhandle->handle, ptr, value);
- ptr += uint32_increment(value);
- /* Check if there are object attributes and, if so, copy them to the user
- * buffer
- */
- value = *ptr++;
- if (value)
- {
- if (obj_attributes)
- {
- memcpy(obj_attributes, ptr, sizeof(struct nfs_fattr));
- }
- ptr += uint32_increment(sizeof(struct nfs_fattr));
- }
- /* Check if there are directory attributes and, if so, copy them to the
- * user buffer
- */
- value = *ptr++;
- if (value && dir_attributes)
- {
- memcpy(dir_attributes, ptr, sizeof(struct nfs_fattr));
- }
- return OK;
- }
- /****************************************************************************
- * Name: nfs_findnode
- *
- * Description:
- * Given a path to something that may or may not be in the file system,
- * return the handle of the directory entry of the requested object.
- *
- * Returned Value:
- * Zero on success; a negative errno value on failure.
- *
- ****************************************************************************/
- int nfs_findnode(FAR struct nfsmount *nmp, FAR const char *relpath,
- FAR struct file_handle *fhandle,
- FAR struct nfs_fattr *obj_attributes,
- FAR struct nfs_fattr *dir_attributes)
- {
- FAR const char *path = relpath;
- char buffer[NAME_MAX + 1];
- char terminator;
- uint32_t tmp;
- int error;
- /* Start with the file handle of the root directory. */
- fhandle->length = nmp->nm_fhsize;
- memcpy(&fhandle->handle, nmp->nm_fh, nmp->nm_fhsize);
- /* If no path was provided, then the root directory must be exactly what
- * the caller is looking for.
- */
- if (*path == '\0')
- {
- /* Return the root directory attributes */
- if (obj_attributes)
- {
- memcpy(obj_attributes, &nmp->nm_fattr, sizeof(struct nfs_fattr));
- }
- if (dir_attributes)
- {
- memcpy(dir_attributes, &nmp->nm_fattr, sizeof(struct nfs_fattr));
- }
- return OK;
- }
- /* This is not the root directory. Loop until the directory entry
- * corresponding to the path is found.
- */
- for (; ; )
- {
- /* Extract the next path segment name. */
- error = nfs_pathsegment(&path, buffer, &terminator);
- if (error != OK)
- {
- /* The filename segment contains is too long. */
- ferr("ERROR: nfs_pathsegment of \"%s\" failed after \"%s\": %d\n",
- relpath, buffer, error);
- return error;
- }
- /* Look-up this path segment */
- error = nfs_lookup(nmp, buffer, fhandle, obj_attributes,
- dir_attributes);
- if (error != OK)
- {
- ferr("ERROR: nfs_lookup of \"%s\" failed at \"%s\": %d\n",
- relpath, buffer, error);
- return error;
- }
- /* If the terminator character in the path was the end of the string
- * then we have successfully found the directory entry that describes
- * the path.
- */
- if (!terminator)
- {
- /* Return success meaning that the description the matching
- * directory entry is in fhandle, obj_attributes, and
- * dir_attributes.
- */
- return OK;
- }
- /* No.. then we have found one of the intermediate directories on
- * the way to the final path target. In this case, make sure
- * the thing that we found is, indeed, a directory.
- */
- tmp = fxdr_unsigned(uint32_t, obj_attributes->fa_type);
- if (tmp != NFDIR)
- {
- /* Ooops.. we found something else */
- ferr("ERROR: Intermediate segment \"%s\" of \'%s\" is not a "
- "directory\n",
- buffer, relpath);
- return -ENOTDIR;
- }
- }
- }
- /****************************************************************************
- * Name: nfs_finddir
- *
- * Description:
- * Given a path to something that may or may not be in the file system,
- * return the handle of the entry of the directory containing the requested
- * object.
- *
- * Returned Value:
- * Zero on success; a negative errno value on failure.
- *
- ****************************************************************************/
- int nfs_finddir(FAR struct nfsmount *nmp, FAR const char *relpath,
- FAR struct file_handle *fhandle,
- FAR struct nfs_fattr *attributes, FAR char *filename)
- {
- FAR const char *path = relpath;
- uint32_t tmp;
- char terminator;
- int error;
- /* Verify that a path was provided */
- if (*path == '\0')
- {
- return -ENOENT;
- }
- /* Start with the file handle of the root directory. */
- fhandle->length = nmp->nm_fhsize;
- memcpy(&fhandle->handle, nmp->nm_fh, nmp->nm_fhsize);
- memcpy(attributes, &nmp->nm_fattr, sizeof(struct nfs_fattr));
- /* Loop until the directory entry containing the path is found. */
- for (; ; )
- {
- /* Extract the next path segment name. */
- error = nfs_pathsegment(&path, filename, &terminator);
- if (error != OK)
- {
- /* The filename segment contains is too long. */
- ferr("ERROR: nfs_pathsegment of \"%s\" failed after \"%s\": %d\n",
- relpath, filename, error);
- return error;
- }
- /* If the terminator character in the path was the end of the string
- * then we have successfully found the directory that contains the name
- * of interest.
- */
- if (!terminator)
- {
- /* Return success meaning that the description of the directory
- * containing the object is in fhandle and attributes.
- */
- return OK;
- }
- /* Look-up the next path segment */
- error = nfs_lookup(nmp, filename, fhandle, attributes, NULL);
- if (error != OK)
- {
- ferr("ERROR: fs_lookup of \"%s\" failed at \"%s\": %d\n",
- relpath, filename, error);
- return error;
- }
- /* Make sure the thing that we found is, indeed, a directory. */
- tmp = fxdr_unsigned(uint32_t, attributes->fa_type);
- if (tmp != NFDIR)
- {
- /* Ooops.. we found something else */
- ferr("ERROR: Intermediate segment \"%s\" of \'%s\" is not a "
- "directory\n",
- filename, relpath);
- return -ENOTDIR;
- }
- }
- }
- /****************************************************************************
- * Name: nfs_attrupdate
- *
- * Description:
- * Update file attributes on write or after the file is modified.
- *
- * Returned Value:
- * None.
- *
- ****************************************************************************/
- void nfs_attrupdate(FAR struct nfsnode *np, FAR struct nfs_fattr *attributes)
- {
- struct timespec ts;
- /* Save a few of the files attribute values in file structure (host
- * order).
- */
- np->n_type = fxdr_unsigned(uint8_t, attributes->fa_type);
- np->n_mode = fxdr_unsigned(uint16_t, attributes->fa_mode);
- np->n_size = fxdr_hyper(&attributes->fa_size);
- fxdr_nfsv3time(&attributes->fa_atime, &ts);
- np->n_atime = ts.tv_sec;
- fxdr_nfsv3time(&attributes->fa_mtime, &ts);
- np->n_mtime = ts.tv_sec;
- fxdr_nfsv3time(&attributes->fa_ctime, &ts);
- np->n_ctime = ts.tv_sec;
- }
|