[{"id":4396,"web_url":"https://patchwork.libcamera.org/comment/4396/","msgid":"<20200407202844.GL1716317@oden.dyn.berto.se>","date":"2020-04-07T20:28:44","subject":"Re: [libcamera-devel] [PATCH 06/11] libcamera: ipa_module: Use Span\n\tclass to tie data and size","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Laurent,\n\nThanks for your work.\n\nOn 2020-04-04 04:56:19 +0300, Laurent Pinchart wrote:\n> The IPAModule class passes pointers to data and the corresponding size\n> as thwo different variables to several functions. Tie them together in a\n> Span.\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\nReviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n\n> ---\n>  src/libcamera/ipa_module.cpp | 87 +++++++++++++++++-------------------\n>  1 file changed, 40 insertions(+), 47 deletions(-)\n> \n> diff --git a/src/libcamera/ipa_module.cpp b/src/libcamera/ipa_module.cpp\n> index d1c411e14ba9..5b6af15f2593 100644\n> --- a/src/libcamera/ipa_module.cpp\n> +++ b/src/libcamera/ipa_module.cpp\n> @@ -18,9 +18,10 @@\n>  #include <sys/mman.h>\n>  #include <sys/stat.h>\n>  #include <sys/types.h>\n> -#include <tuple>\n>  #include <unistd.h>\n>  \n> +#include <libcamera/span.h>\n> +\n>  #include \"file.h\"\n>  #include \"log.h\"\n>  #include \"pipeline_handler.h\"\n> @@ -43,27 +44,26 @@ LOG_DEFINE_CATEGORY(IPAModule)\n>  namespace {\n>  \n>  template<typename T>\n> -typename std::remove_extent_t<T> *elfPointer(void *map, off_t offset,\n> -\t\t\t\t\t     size_t fileSize, size_t objSize)\n> +typename std::remove_extent_t<T> *elfPointer(Span<uint8_t> elf, off_t offset,\n> +\t\t\t\t\t     size_t objSize)\n>  {\n>  \tsize_t size = offset + objSize;\n> -\tif (size > fileSize || size < objSize)\n> +\tif (size > elf.size() || size < objSize)\n>  \t\treturn nullptr;\n>  \n>  \treturn reinterpret_cast<typename std::remove_extent_t<T> *>\n> -\t\t(static_cast<char *>(map) + offset);\n> +\t\t(reinterpret_cast<char *>(elf.data()) + offset);\n>  }\n>  \n>  template<typename T>\n> -typename std::remove_extent_t<T> *elfPointer(void *map, off_t offset,\n> -\t\t\t\t\t     size_t fileSize)\n> +typename std::remove_extent_t<T> *elfPointer(Span<uint8_t> elf, off_t offset)\n>  {\n> -\treturn elfPointer<T>(map, offset, fileSize, sizeof(T));\n> +\treturn elfPointer<T>(elf, offset, sizeof(T));\n>  }\n>  \n> -int elfVerifyIdent(void *map, size_t soSize)\n> +int elfVerifyIdent(Span<uint8_t> elf)\n>  {\n> -\tchar *e_ident = elfPointer<char[EI_NIDENT]>(map, 0, soSize);\n> +\tchar *e_ident = elfPointer<char[EI_NIDENT]>(elf, 0);\n>  \tif (!e_ident)\n>  \t\treturn -ENOEXEC;\n>  \n> @@ -89,38 +89,36 @@ int elfVerifyIdent(void *map, size_t soSize)\n>  \n>  /**\n>   * \\brief Retrieve address and size of a symbol from an mmap'ed ELF file\n> - * \\param[in] map Address of mmap'ed ELF file\n> - * \\param[in] soSize Size of mmap'ed ELF file (in bytes)\n> + * \\param[in] elf Address and size of mmap'ed ELF file\n>   * \\param[in] symbol Symbol name\n>   *\n> - * \\return zero or error code, address or nullptr, size of symbol or zero,\n> - * respectively\n> + * \\return The memory region storing the symbol on success, or an empty span\n> + * otherwise\n>   */\n> -std::tuple<void *, size_t>\n> -elfLoadSymbol(void *map, size_t soSize, const char *symbol)\n> +Span<uint8_t> elfLoadSymbol(Span<uint8_t> elf, const char *symbol)\n>  {\n> -\tElfW(Ehdr) *eHdr = elfPointer<ElfW(Ehdr)>(map, 0, soSize);\n> +\tElfW(Ehdr) *eHdr = elfPointer<ElfW(Ehdr)>(elf, 0);\n>  \tif (!eHdr)\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \n>  \toff_t offset = eHdr->e_shoff + eHdr->e_shentsize * eHdr->e_shstrndx;\n> -\tElfW(Shdr) *sHdr = elfPointer<ElfW(Shdr)>(map, offset, soSize);\n> +\tElfW(Shdr) *sHdr = elfPointer<ElfW(Shdr)>(elf, offset);\n>  \tif (!sHdr)\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \toff_t shnameoff = sHdr->sh_offset;\n>  \n>  \t/* Locate .dynsym section header. */\n>  \tElfW(Shdr) *dynsym = nullptr;\n>  \tfor (unsigned int i = 0; i < eHdr->e_shnum; i++) {\n>  \t\toffset = eHdr->e_shoff + eHdr->e_shentsize * i;\n> -\t\tsHdr = elfPointer<ElfW(Shdr)>(map, offset, soSize);\n> +\t\tsHdr = elfPointer<ElfW(Shdr)>(elf, offset);\n>  \t\tif (!sHdr)\n> -\t\t\treturn std::make_tuple(nullptr, 0);\n> +\t\t\treturn {};\n>  \n>  \t\toffset = shnameoff + sHdr->sh_name;\n> -\t\tchar *name = elfPointer<char[8]>(map, offset, soSize);\n> +\t\tchar *name = elfPointer<char[8]>(elf, offset);\n>  \t\tif (!name)\n> -\t\t\treturn std::make_tuple(nullptr, 0);\n> +\t\t\treturn {};\n>  \n>  \t\tif (sHdr->sh_type == SHT_DYNSYM && !strcmp(name, \".dynsym\")) {\n>  \t\t\tdynsym = sHdr;\n> @@ -130,13 +128,13 @@ elfLoadSymbol(void *map, size_t soSize, const char *symbol)\n>  \n>  \tif (dynsym == nullptr) {\n>  \t\tLOG(IPAModule, Error) << \"ELF has no .dynsym section\";\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \t}\n>  \n>  \toffset = eHdr->e_shoff + eHdr->e_shentsize * dynsym->sh_link;\n> -\tsHdr = elfPointer<ElfW(Shdr)>(map, offset, soSize);\n> +\tsHdr = elfPointer<ElfW(Shdr)>(elf, offset);\n>  \tif (!sHdr)\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \toff_t dynsym_nameoff = sHdr->sh_offset;\n>  \n>  \t/* Locate symbol in the .dynsym section. */\n> @@ -144,15 +142,14 @@ elfLoadSymbol(void *map, size_t soSize, const char *symbol)\n>  \tunsigned int dynsym_num = dynsym->sh_size / dynsym->sh_entsize;\n>  \tfor (unsigned int i = 0; i < dynsym_num; i++) {\n>  \t\toffset = dynsym->sh_offset + dynsym->sh_entsize * i;\n> -\t\tElfW(Sym) *sym = elfPointer<ElfW(Sym)>(map, offset, soSize);\n> +\t\tElfW(Sym) *sym = elfPointer<ElfW(Sym)>(elf, offset);\n>  \t\tif (!sym)\n> -\t\t\treturn std::make_tuple(nullptr, 0);\n> +\t\t\treturn {};\n>  \n>  \t\toffset = dynsym_nameoff + sym->st_name;\n> -\t\tchar *name = elfPointer<char>(map, offset, soSize,\n> -\t\t\t\t\t      strlen(symbol) + 1);\n> +\t\tchar *name = elfPointer<char>(elf, offset, strlen(symbol) + 1);\n>  \t\tif (!name)\n> -\t\t\treturn std::make_tuple(nullptr, 0);\n> +\t\t\treturn {};\n>  \n>  \t\tif (!strcmp(name, symbol) &&\n>  \t\t    sym->st_info & STB_GLOBAL) {\n> @@ -163,22 +160,22 @@ elfLoadSymbol(void *map, size_t soSize, const char *symbol)\n>  \n>  \tif (targetSymbol == nullptr) {\n>  \t\tLOG(IPAModule, Error) << \"Symbol \" << symbol << \" not found\";\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \t}\n>  \n>  \t/* Locate and return data of symbol. */\n>  \tif (targetSymbol->st_shndx >= eHdr->e_shnum)\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \toffset = eHdr->e_shoff + targetSymbol->st_shndx * eHdr->e_shentsize;\n> -\tsHdr = elfPointer<ElfW(Shdr)>(map, offset, soSize);\n> +\tsHdr = elfPointer<ElfW(Shdr)>(elf, offset);\n>  \tif (!sHdr)\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \toffset = sHdr->sh_offset + (targetSymbol->st_value - sHdr->sh_addr);\n> -\tchar *data = elfPointer<char>(map, offset, soSize, targetSymbol->st_size);\n> +\tuint8_t *data = elfPointer<uint8_t>(elf, offset, targetSymbol->st_size);\n>  \tif (!data)\n> -\t\treturn std::make_tuple(nullptr, 0);\n> +\t\treturn {};\n>  \n> -\treturn std::make_tuple(data, targetSymbol->st_size);\n> +\treturn { data, targetSymbol->st_size };\n>  }\n>  \n>  } /* namespace */\n> @@ -292,23 +289,19 @@ int IPAModule::loadIPAModuleInfo()\n>  \t}\n>  \n>  \tSpan<uint8_t> data = file.map(0, -1, File::MapPrivate);\n> -\tint ret = elfVerifyIdent(data.data(), data.size());\n> +\tint ret = elfVerifyIdent(data);\n>  \tif (ret) {\n>  \t\tLOG(IPAModule, Error) << \"IPA module is not an ELF file\";\n>  \t\treturn ret;\n>  \t}\n>  \n> -\tvoid *info = nullptr;\n> -\tsize_t infoSize;\n> -\n> -\tstd::tie(info, infoSize) = elfLoadSymbol(data.data(), data.size(),\n> -\t\t\t\t\t\t \"ipaModuleInfo\");\n> -\tif (!info || infoSize != sizeof(info_)) {\n> +\tSpan<uint8_t> info = elfLoadSymbol(data, \"ipaModuleInfo\");\n> +\tif (info.size() != sizeof(info_)) {\n>  \t\tLOG(IPAModule, Error) << \"IPA module has no valid info\";\n>  \t\treturn -EINVAL;\n>  \t}\n>  \n> -\tmemcpy(&info_, info, infoSize);\n> +\tmemcpy(&info_, info.data(), info.size());\n>  \n>  \tif (info_.moduleAPIVersion != IPA_MODULE_API_VERSION) {\n>  \t\tLOG(IPAModule, Error) << \"IPA module API version mismatch\";\n> -- \n> Regards,\n> \n> Laurent Pinchart\n> \n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"<niklas.soderlund@ragnatech.se>","Received":["from mail-lj1-x243.google.com (mail-lj1-x243.google.com\n\t[IPv6:2a00:1450:4864:20::243])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 60ADC600F0\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue,  7 Apr 2020 22:28:47 +0200 (CEST)","by mail-lj1-x243.google.com with SMTP id q19so5199012ljp.9\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 07 Apr 2020 13:28:47 -0700 (PDT)","from localhost (h-200-138.A463.priv.bahnhof.se. [176.10.200.138])\n\tby smtp.gmail.com with ESMTPSA id\n\th14sm11954447lfm.60.2020.04.07.13.28.44\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tTue, 07 Apr 2020 13:28:44 -0700 (PDT)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (2048-bit key; \n\tunprotected)\n\theader.d=ragnatech-se.20150623.gappssmtp.com\n\theader.i=@ragnatech-se.20150623.gappssmtp.com header.b=\"WPBWQgAm\"; \n\tdkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=ragnatech-se.20150623.gappssmtp.com; s=20150623;\n\th=date:from:to:cc:subject:message-id:references:mime-version\n\t:content-disposition:content-transfer-encoding:in-reply-to;\n\tbh=QPH5bU7iYldRXb+nxIo2HSoISO6Ht4wg1JB9hM7p7io=;\n\tb=WPBWQgAmg+dBbtR4FU3U+yH8LEVgPAflY9ssnRiBbhNsWLn9FraBoDrd+Sl9e/Y7sU\n\tUvKMBinv1lcAWrM8BvLI0uRrdavU5BX0opadbRgXmCGSxVwff2wvLHmVjote6PNRp55/\n\tCUZ2l6WfgdTQviuoHI3K9XDAQ82ebhr7lligO5bXLQuYXZkUTUDp7hjfMlbWGjq99fxi\n\tceJ0F5evMXwcF4P5qNgqv+IyrW1xfd8WYw/wsh9lpdPxm6rpqrFcBkqBP1M1u9f23lHL\n\tWTnYRYeE/vK3eSAHePD+cBrpqLDjCeMxjYvVHefOM7PYIJfPXrh7cbrptbgS2h+w97A9\n\tKi6Q==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:date:from:to:cc:subject:message-id:references\n\t:mime-version:content-disposition:content-transfer-encoding\n\t:in-reply-to;\n\tbh=QPH5bU7iYldRXb+nxIo2HSoISO6Ht4wg1JB9hM7p7io=;\n\tb=kwghWknx8xdTqIDH/FcZob6+8k8S+wmUVDklav4UT5RrImUzNRcx7hmeXqdhNiF2dc\n\tFDz2rN9+c5nJZ39HUiBHSppQsic9u/GlxjoQRhAryYUwVusrTemubuN3IflqU8wngIoF\n\tuyA35iaIsjkqIluQ/54ZFbYBbk5N5DFMXhP5z51bNi0eR9oFg6PBXJLJ0xVAZUVOFLAT\n\t4SMDMLsTnhvlWGZSAvHlmWNPOsnrXBKKMC0pyXIg1zmhHZsrSxUFyyaWsKOCudYpp4Ty\n\tA+fD/erj04LFhhCNolqsH5OjdgHol5DKjlikirSNwbIjZ4aD1FnrGoBRr6OSEHyhsZkO\n\tApQA==","X-Gm-Message-State":"AGi0PuYcG0bpU8fQlN6hboE3AIjBXJSeEKlfs14H0fM2uuxZPrNaV+tf\n\t5A63nPw8+knrn2C/eEYMMQ/pgHXgWIA=","X-Google-Smtp-Source":"APiQypJ7x2skU4SjfaGGgC2bgsh0ld26JsB9+U3Tp85eSQh37KI44dsOM8W8Ffw+Ey+Nx89Qd2R8rQ==","X-Received":"by 2002:a2e:9b41:: with SMTP id o1mr2881717ljj.145.1586291326509;\n\tTue, 07 Apr 2020 13:28:46 -0700 (PDT)","Date":"Tue, 7 Apr 2020 22:28:44 +0200","From":"Niklas =?iso-8859-1?q?S=F6derlund?= <niklas.soderlund@ragnatech.se>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20200407202844.GL1716317@oden.dyn.berto.se>","References":"<20200404015624.30440-1-laurent.pinchart@ideasonboard.com>\n\t<20200404015624.30440-7-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20200404015624.30440-7-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH 06/11] libcamera: ipa_module: Use Span\n\tclass to tie data and size","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Tue, 07 Apr 2020 20:28:47 -0000"}}]