/**************************************************************************** * net/usrsock/usrsock_getsockopt.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 #if defined(CONFIG_NET) && defined(CONFIG_NET_USRSOCK) && \ defined(CONFIG_NET_SOCKOPTS) #include #include #include #include #include #include #include #include #include #include "usrsock/usrsock.h" /**************************************************************************** * Private Functions ****************************************************************************/ static uint16_t getsockopt_event(FAR struct net_driver_s *dev, FAR void *pvpriv, uint16_t flags) { FAR struct usrsock_data_reqstate_s *pstate = pvpriv; FAR struct usrsock_conn_s *conn = pstate->reqstate.conn; if (flags & USRSOCK_EVENT_ABORT) { ninfo("socket aborted.\n"); pstate->reqstate.result = -ECONNABORTED; pstate->valuelen = 0; /* Stop further callbacks */ pstate->reqstate.cb->flags = 0; pstate->reqstate.cb->priv = NULL; pstate->reqstate.cb->event = NULL; /* Wake up the waiting thread */ nxsem_post(&pstate->reqstate.recvsem); } else if (flags & USRSOCK_EVENT_REQ_COMPLETE) { ninfo("request completed.\n"); pstate->reqstate.result = conn->resp.result; if (pstate->reqstate.result < 0) { pstate->valuelen = 0; } else { pstate->valuelen = conn->resp.valuelen; } /* Stop further callbacks */ pstate->reqstate.cb->flags = 0; pstate->reqstate.cb->priv = NULL; pstate->reqstate.cb->event = NULL; /* Wake up the waiting thread */ nxsem_post(&pstate->reqstate.recvsem); } return flags; } /**************************************************************************** * Name: do_getsockopt_request ****************************************************************************/ static int do_getsockopt_request(FAR struct usrsock_conn_s *conn, int level, int option, socklen_t value_len) { struct usrsock_request_getsockopt_s req = { }; struct iovec bufs[1]; if (level < INT16_MIN || level > INT16_MAX) { return -EINVAL; } if (option < INT16_MIN || option > INT16_MAX) { return -EINVAL; } if (value_len > UINT16_MAX) { value_len = UINT16_MAX; } /* Prepare request for daemon to read. */ req.head.reqid = USRSOCK_REQUEST_GETSOCKOPT; req.usockid = conn->usockid; req.level = level; req.option = option; req.max_valuelen = value_len; bufs[0].iov_base = (FAR void *)&req; bufs[0].iov_len = sizeof(req); return usrsock_do_request(conn, bufs, nitems(bufs)); } /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: usrsock_getsockopt * * Description: * getsockopt() retrieve the value for the option specified by the * 'option' argument at the protocol level specified by the 'level' * argument. If the size of the option value is greater than 'value_len', * the value stored in the object pointed to by the 'value' argument will * be silently truncated. Otherwise, the length pointed to by the * 'value_len' argument will be modified to indicate the actual length * of the 'value'. * * The 'level' argument specifies the protocol level of the option. To * retrieve options at the socket level, specify the level argument as * SOL_SOCKET. * * See a complete list of values for the 'option' argument. * * Input Parameters: * psock Socket structure of the socket to query * level Protocol level to set the option * option identifies the option to get * value Points to the argument value * value_len The length of the argument value * ****************************************************************************/ int usrsock_getsockopt(FAR struct socket *psock, int level, int option, FAR void *value, FAR socklen_t *value_len) { FAR struct usrsock_conn_s *conn = psock->s_conn; struct usrsock_data_reqstate_s state = { }; struct iovec inbufs[1]; int ret; /* SO_[RCV|SND]TIMEO have to be handled locally to break the block i/o */ if (level == SOL_SOCKET && (option == SO_TYPE || option == SO_RCVTIMEO || option == SO_SNDTIMEO)) { return -ENOPROTOOPT; } net_lock(); if (conn->state == USRSOCK_CONN_STATE_UNINITIALIZED || conn->state == USRSOCK_CONN_STATE_ABORTED) { /* Invalid state or closed by daemon. */ ninfo("usockid=%d; getsockopt() with uninitialized usrsock.\n", conn->usockid); ret = (conn->state == USRSOCK_CONN_STATE_ABORTED) ? -EPIPE : -ECONNRESET; goto errout_unlock; } /* Set up event callback for usrsock. */ ret = usrsock_setup_data_request_callback( conn, &state, getsockopt_event, USRSOCK_EVENT_ABORT | USRSOCK_EVENT_REQ_COMPLETE); if (ret < 0) { nwarn("usrsock_setup_request_callback failed: %d\n", ret); goto errout_unlock; } inbufs[0].iov_base = (FAR void *)value; inbufs[0].iov_len = *value_len; usrsock_setup_datain(conn, inbufs, nitems(inbufs)); /* Request user-space daemon to handle request. */ ret = do_getsockopt_request(conn, level, option, *value_len); if (ret >= 0) { /* Wait for completion of request. */ net_sem_wait_uninterruptible(&state.reqstate.recvsem); ret = state.reqstate.result; DEBUGASSERT(state.valuelen <= *value_len); if (ret >= 0) { /* Store length of data that was written to 'value' buffer. */ *value_len = state.valuelen; } } usrsock_teardown_datain(conn); usrsock_teardown_data_request_callback(&state); /* Skip the default socket option handler */ if (ret == -ENOPROTOOPT) { ret = -ENOTTY; } errout_unlock: net_unlock(); return ret; } #endif /* CONFIG_NET && CONFIG_NET_USRSOCK && CONFIG_NET_SOCKOPTS */