From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3EE15431E0 for ; Mon, 23 Oct 2023 11:08:07 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 26A6540EF1; Mon, 23 Oct 2023 11:08:07 +0200 (CEST) Received: from NAM04-MW2-obe.outbound.protection.outlook.com (mail-mw2nam04on2080.outbound.protection.outlook.com [40.107.101.80]) by mails.dpdk.org (Postfix) with ESMTP id 992FC40A8A; Mon, 23 Oct 2023 11:08:04 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=XFWl8LA3o/GiCb4bE5C3WuM+wxA1n2qAf5Fs94YtRn62DWGLqjk4C4l7j1h+TV1wfYYLwOxbJ6rGoJ7R8dOQfe7PTcus9ThxC6cW3cTbUQhFyI/CL3h0ZftpfBbeMSTVM//BGKoRSNmVfU+Nd5p3cv5AWWr/m4sc8dqnQE/3HkKkIP6SCQ99/CK99ykVoDQ+GesyukQlBlmk1Tx+2Jpq8WXig3iMb9c9WZtZFc0PWg3vk27Sn3JNV13dYc1es2Y+eMtpuM3va2FV0L7ARdNWuIeehDlsqwgZuy/w/JJF5DQQBuK9EdxCNGtod9n9vMmDbLUDvLTamWx3/dAUEdKR3A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=ijwFFOPNPMa9oY0ToSHGBi5wEFvG+om2aK3rMrz/yr0=; b=jwOO1d3KweYynWL+vRmhIl+73q1I5w9DAIrREL1O46eK4rjMnTroMbjU06NtkR5wAJwO2cqCRZ2ajGA0rDRvuPrtIh4oDEVVUcu2b3DhMtekzsuu2xNwu1LPOJ/iNWl+pzPjGpcrivByL8aQ4joPKavV2iKcE2SrWkSDBE+1dGL9yy9l9InTPcKJCr1Ewk4vXIg3jbPDzyv2c9/ybrTTkBx4xBGRz+5RW3JEr9af9QylhouOspSMeFGXkigsTbGi+f/dolPDMcgKXmOg/3QsQmUvfmvjDFrAszW/SYL9rJNi1Z8BEAZr5S/Ad2CyRXWtcrokzreIDFr/gWyFPEV9sA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=ijwFFOPNPMa9oY0ToSHGBi5wEFvG+om2aK3rMrz/yr0=; b=VU8Aka5vFk9j930U6heHMoo7YvFbpint/VXxo8LAnaQ28GzJ44OUSb74z0HCKSjxaRG1A9rCB+d+rOCZm1e0e5b0+8sVhw7lrWdruQMvcOinMZatKZJV5krATbkgX1A3sMLpK8eT9NEqnQjnQt2G36AtXH5Kipb5ymEvmfCcmaw= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) by MN2PR12MB4254.namprd12.prod.outlook.com (2603:10b6:208:1d0::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6907.26; Mon, 23 Oct 2023 09:08:00 +0000 Received: from CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::2c52:75a:cb49:2545]) by CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::2c52:75a:cb49:2545%6]) with mapi id 15.20.6907.025; Mon, 23 Oct 2023 09:08:00 +0000 Message-ID: Date: Mon, 23 Oct 2023 10:07:54 +0100 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH] mempool: fix internal function documentation To: =?UTF-8?Q?Morten_Br=C3=B8rup?= , Thomas Monjalon , Andrew Rybchenko Cc: dev@dpdk.org, stable@dpdk.org, Mahesh Adulla References: <20231020144647.1682698-1-ferruh.yigit@amd.com> <98CBD80474FA8B44BF855DF32C47DC35E9EF64@smartserver.smartshare.dk> Content-Language: en-US From: Ferruh Yigit Autocrypt: addr=ferruh.yigit@amd.com; keydata= xsFNBGJDD3EBEAC/M7Tk/DfQSmP1K96vyzdhfSBzlCaGtcxNXorq4fALruqVsD3oi0yfyEz9 4YN8x7py0o9EL8ZdpOX0skc0AMCDAaw033uWhCn0GLMeGRKUbfOAPvL6ecSDvGD7CJIO9j0J eZUvasBgPdM/435PEr9DmC6Ggzdzt8IuG4PoLi5jpFSfcqxZFCCxLUDEo/w0nuguk2FTuYJg B2zEZ4JTBZrw7hIHiFh8D8hr6YA6a5uTofq1tr+l048lbtdFUl8TR0aIExVzE4Z8qKZlcE+9 RQaewjK5Al1jLE4sHdmd3GN+IvgDF3D/fLsi25SKJDeGSdeHkOmaX0qGeM4WKIfU6iARRCiQ N3AmBIxZ/A7UXBKLaOyZ+/i3sE6Wb53nrO4i8+0K2Qwyh6LjTeiJAIjYKN43ppxz3DaI+QwQ vI+uyHr4Gg0Da9EPPz/YyKauSeOZCfCB5gIfICO0j6x0SCl8uQ2nLpjxcZkf0gjcwUzP3h+S 3x6NfDji9YEij0zczW/dcSpGgZ6vsFpPrtnP9ZXy6J53yp0kJtOJoOlkEFFdU2yCZnCDseum CoudmGLZVvS0/DzHDJejq+3kK3FDGktZBOxZIIpal+nFqS7lVgOZc4+huVv3jyhzoAUOEyXA XK5j6o7g8STUY+z33QNnHpdLvecMwuzmvqy0jR54yAbZ64mB9QARAQABzSNGZXJydWggWWln aXQgPGZlcnJ1aC55aWdpdEBhbWQuY29tPsLBlwQTAQgAQQIbAwULCQgHAgYVCgkICwIEFgID AQIeAQIXgAIZARYhBEm7aYjps5XGsPHCElRTPtCKKm/6BQJjb9DJBQkC+3/YAAoJEFRTPtCK Km/6d94P/irGq3mPa7LamXMIioQ8i6ppMSjpr8g+SxH9RnzbmoUjUY6hVzCpXYxEejiJHubg 7lwD+bOocYpiU8Pe0UncVBhIPNk/dIWQAyH0IWK1nd+hOnjxHv3AQpP80Be2o1mUn3oq/b+B QYiyvvre2gIugYq0hzLcG7z4zREeT+Nl0DMDfnLx+Tj2FAOHrOfudUqjdr/VjF5PoTK0bxnb Brqulp0I0ft7hNsufhzf+TlqaB5l0eQO4gDo5xGTP97TT1cGYsXVMsyDhHqW6P3cuj8kkLkO Ch4oq8OLL8GElgRy5y5svU6CJu3f8hT9aiqIoaRpfNv6N8iEk6g4/HNN+uydb9YCA+1pbwBx skmDhtxQrmXpI+Fmfq0aX2NmqHcy6JR8Ekm/nfwLAW/aDpwoMImVN5pPXtOBSjYi4pj7hiJk UA0ZFi8HCW+fic85p8MXn1GPDmbO82Mm3JVJ1uJNAzGsBbW5SP1ol6+XTeaSxcmzFlrDs8vL XQJMRTpcG6Pti7GbbsOtldvmxRQpq9PmCgQg9IrPXpMoaKE3WwtiSiCALs0kYj4F+hhgAfjI RsOuaAJTnKYW31pC/QdroMNAEqIpLveql03jj+xD9ntJIVAsXiCitsLIXzKP0L5tcHkoVLC3 NAjVYq6XkAEssPF4mMRLoEwpvxOytHe1BCJoRl0YA0aQzsFNBGJDD3EBEAC8fBFQHej8qgIG CBzoIEd1cZgPIARlIhRudODXoNDbwA+zJMKtOVwol3Hh1qJ2/yZP11nZsqrP4fyUvMxrwhDe WBWFVDbWHLnqXMnKuUU1vQMujbzgq/4Rb9wSMW5vBL6YxhZng+h71JgS/9nVtzyaTtsOTrJi 6nzFSDx6Wbza2jYvL9rlK0yxJcMEiKwZQ/if4KcOesD0rtxomU/iSEv6DATcJbGXP6T93nPl 90XksijRKAmOwvdu3A8IIlxiSSVRP0lxiHOeR35y6PjHY2usfEDZZOVOfDfhlCVAIBZUZALv VmFOVSTYXeKgYa6Ooaf72+cHM3SgJIbYnevJfFv8YQW0MEAJ/IXE7B1Lk+pHNxwU3VBCrKnA fd/PTvviesuYRkrRD6qqZnINeu3b2DouVGGt2fVcGA38BujCd3p8i7azoGc7A6cgF7z9ETnr ANrbg1/dJyDmkDxOxVrVquTBbxJbDy2HaIe9wyJTEK2Sznpy62DaHVY+gfDQzexBXM10geHC IIUhEnOUYVaq65X3ZDjyAQnNDBQ4uMqSHZk8DpJ22X+T+IMzWzWl+VyU4UZXjkLKPvlqPjJk 1RbKScek5L2GhxHQbPaD76Hx4Jiel0vm2G+4wei8Ay1+0YRFkhySxogU/uQVXHTv63KzQMak oIfnN/V2R0ucarsvMBW+gwARAQABwsF8BBgBCAAmAhsMFiEESbtpiOmzlcaw8cISVFM+0Ioq b/oFAmNv0PAFCQL7f/8ACgkQVFM+0Ioqb/oU9hAAisAJJ09j/kiEeA1HGKUg3DyFnYW22zRL z1IHYmcHQanMx4+FAwsb1bonVldQMIYNJ9z69UNIU16zIqLZt3D5QK7Je5F5q4NZgfP2jtjX rc3jyu0PuDerFZQyxNcYhhmlF9JO9NV976WYbBAM3AAr0TDohUk+YicYTKab+ZHYOABXbqHX qi+bzDCH1vKBDfpJviprthhK1tIABUK5lsp9aFwFU2jfu2J3XX3pwQhPMjtn2C4v37XUnOqM SJPr2HLU27IW5I3BBpJn7dZE/BkmDmnceHF8E4tRlXCQ/cf81+eErL832sfhVJo1MpubKh3B j89ZLmw0cDXZP2hqlC9vdXnoWWHI8PDPkiw9z11yLrT9Wd4cTJTjFV49Z9G96rgnOtWDcZ1J xHBAnXYQ7V2k9abY+ZqY1PtAPr/smqzQfPHXyTAhRVZp2f3yQmj7UqB07FJuLQjJ4CGk97Qx ///qeSg7D8x/sGEA8Yp2jgIj6u7tspuz+RgBYrWpfI0VIHhWED0jNXzqztrVX18CzA6r0ReY SG+CSyycKkco6UI9ZeUrXFwnoUJqIJY9wTJo5gD9EgGIbItv3qWTq29dihLYpzd6dqB708k7 4RBz9051oLaFVGkguFw/tXmA17nx+c2uR5jx8wb4j68umG2X++0dSta5eHAVhmtXvrqPW6Ku 3FQ= In-Reply-To: <98CBD80474FA8B44BF855DF32C47DC35E9EF64@smartserver.smartshare.dk> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-ClientProxiedBy: FR0P281CA0115.DEUP281.PROD.OUTLOOK.COM (2603:10a6:d10:a8::14) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|MN2PR12MB4254:EE_ X-MS-Office365-Filtering-Correlation-Id: 6f358dd7-9e7a-4360-bd48-08dbd3a78e5f X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: o267Z1ri800zAnakPxLZfTLQS/naN+wq+L1jOwfFdkqbVCjOTQNo/UMvdP0/FdGiA5y24hYvLOJnrkrl7t2kMIHMV6+0VJrTxAd5UjT5tUl6VkQZoaavYSxHUiVoj+BcItIJnA6XyXnTOU9GLrixwMfyECjtAo6XaIfOJ1B/T+lEVHSGitKGpwhDPAnlNtyfANVI0ol0MRAZpqrhnozaD7tEAYMk/jz3qsT1uvLTkx8LRe5xO9pp25H9snk9lJQSqf3GocuL3k+5bKSD4LcT0pPnmo/JbJCFC1jbSEpL9+7Vfmhf59CjmhjnK4vvluTRPXwgc9U7BSi1xDTHxAEyA/mnEP+1YfAIhpqs2qYYADXP21rmjHR6FRu9qdtvEppoV3Li9jUSCk+Vz69Q47A5zeHY8GonOwGRIc/na0OXImOPMNzO8Rt8Bk4s/wEJ80WQRYPOemQ9Zr/47/DWxsh115ac6SlW6JpWjlOtjEWl67x4Y4UVSWfJcR8hWWBsknDGVguPhCZ7t9UWWjPvgqpIhl+qoz716NJnBGfOu6zsjrOYlsXCPcQAY4t6vf+m9DBmFouSoWN7TfGFmzTiIymcy0+tIKIX0jE0BXYI65/qeZvXAY5EBxb0uMDaYQu1ZsFIRu7NZ3H6mI3qRLGDD1ABtw== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:CH2PR12MB4294.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(376002)(396003)(39860400002)(366004)(136003)(346002)(230922051799003)(186009)(1800799009)(451199024)(64100799003)(31686004)(2906002)(5660300002)(38100700002)(36756003)(4326008)(8676002)(8936002)(44832011)(41300700001)(66946007)(316002)(66476007)(66556008)(110136005)(478600001)(86362001)(6486002)(966005)(31696002)(6506007)(6666004)(6512007)(53546011)(2616005)(26005)(66574015)(83380400001)(45980500001)(43740500002); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?NjcraDdGMFZRMHhocUdJc2h2T1pERjFOTG1RY0FNWWNaM0JLRTByZmJVT2pW?= =?utf-8?B?TU9zQ05vUzJpRDNiMzVzVVJ0V3dNMEQ3U1k3dCtPanRTOHNaN2RTTmRKSXMw?= =?utf-8?B?dW5HNmxFekpoOENKTGNUUCtVdnFGRmRZQjNQNm9RcUtjaUxXbzd3OXdxWnJZ?= =?utf-8?B?eVYrN0RwaE9yODd3Z0M0V0FaZ2RVakp6WUcvbjFGS1phanJyNFp2NGdyQ3oz?= =?utf-8?B?Y1d4OXB4OFBTQ3U5MnkyUVd0bCtpMGtxZzFSUU8yZzluUmwrTDdPMk14Z0Ez?= =?utf-8?B?aitySy9BbE9wb2VKRXc1ZWVaZUpzajV0bmRWUWZ5Q1F2cG9GZVQ1dmdpbFQ1?= =?utf-8?B?ZGF6NU9ycmFvc0JyZ0U0aDU5d0toVTBhYVRBMzFIWEUvUi8vTzIybEMrNG5O?= =?utf-8?B?S3BQa1dOS0Z2akdodU53cU9LTHplWTRDTHRobUZsbW1SZms3YjdHOU9ETVFF?= =?utf-8?B?UEI5eW05ZThyRmJLa3F5RUZUWGtjblNPRkZ3SHdpdlRVdmpwTFMwblRHZnJt?= =?utf-8?B?WEMwRWlzVDA5N2wvVHFSc2JoNDBiOUVxa1o4N2Y1TzBJU05KZHNBLzNRRnZy?= =?utf-8?B?cFIxMnRTUFZvR21VU1V1TGUwRU1PTkVOUUduSURUZDA2Rlh4Ynd2aVF2Wk84?= =?utf-8?B?bjZ1N3BLVmF4OGQvUEdxcTJHUU45dW92N1psVGkyNTdmZjNua21ybUNpMlVQ?= =?utf-8?B?dm85a3VBZS9mZkNwQjF0QmJqaDR4bHNpNmdPeGxJczZJNHozZjhMTmNrSlRC?= =?utf-8?B?Z2ZielZHNU0rTTd5RSs2cFA5ZVNBSzA5L2pnMXBZbUF2VWVyeDc5R09zY1BG?= =?utf-8?B?NWJWOGRCcEQzNTlPQ1lUaVVyQ2VhK0hPbEtHV3pYWitlQjV5UVBCcXp4elpm?= =?utf-8?B?bS9CRVJoMjJKVkxoRmdDdVJTcWlKM0ppcXNib2NNY3hkbUY5YU9zNzZCSHUy?= =?utf-8?B?eVVDOTUycm9nTjJYTzV2cGI3UUV6Qmt3d2k4eUhZZWU1WE5IUUtzRk9DVnA2?= =?utf-8?B?dGNTdGg3dXNWSktha1N0UllEUkdHMGFXaFBMM3ByQUZyOUZvOFJYcHRRcm5X?= =?utf-8?B?Q1Ardm1pbzBHaEdtc3ZQTEgzU1hLeWlFYlVHOCtBa0ovcjdxU0wzbGhkZ3pk?= =?utf-8?B?SEVUNUZPakMwVVFEMEQrQVlQVjB5STB2UWRsM0pZZVZDTUxXa1RCWEhndXlj?= =?utf-8?B?cXR0ZHlsa1JSSmZDb1NycWhhNmVaeUM1dnZFTzJUREtSV3hhajdRZjNOZmF4?= =?utf-8?B?MmNRc2FTUlpzMzdwSUpTc3NRK0NWZWZJSXdiZDRyRjk5amZNeXBUbmFUOVcw?= =?utf-8?B?U2hySHJLWmFyMUZvR1UvWDFSWnlFaC9FRFNPUk5sM3ZhNlNLZFA2S0pqNEtC?= =?utf-8?B?UjRtTEJzRDhpS2QzcmNjVXlmc245bmpsc1VqeEhpMy95MHkrNWVFVFNJekZV?= =?utf-8?B?SUliVXFnZms3S2VzeEZHUE9ndHJ2SGVQSmtiQktGVktwVmlTd2h2N0l1L2ZE?= =?utf-8?B?TGgvRVozTXpaS29laFJhU0dEbnNXb0t6ajFBMGZIeFFWM1BkQ3ZXNkdSdFpz?= =?utf-8?B?QWNuUDhLZmNjS2lDVXd6Si92d2VIRUpiRFNFUVJhN21BamRHRExZendaMFlo?= =?utf-8?B?VGRYbGN1VlcvUWk1TVR0bHdaMjVGYVF6M2JBMHpRVzJwelN2OWJJdldKcDhz?= =?utf-8?B?Ung4V3FObUxUcHFtK3B1Z1BDbVNlOGM0aTI5NDIrM0RXVS9WeHVtUnRpUWFC?= =?utf-8?B?OXdwREcwNXRjU1pZVTZFeVNKcVZQNTU5Mko0U0pORUNOSHRhM1JPTXl3WUNB?= =?utf-8?B?OEFRQkUySTVDc0dJdW9KZjZtZ0d6aCtBUzlEdFFOZ1pkQTUwcWJXSk1CVGhm?= =?utf-8?B?RTgxWWxhQXdkRXRPYkVmcUJsS3VjM0ZQVkpzV0VScHhWWGx2RC8zUVF1Wkhl?= =?utf-8?B?Y2ZZb0c3Q1BqL29IRkNobTdoWDNtOGlvWi9INDhjWm9QdWw1SWNVclJDZTZ0?= =?utf-8?B?K1BXYzR2Y0JvcFJaSC9USHp3T0ZOWVNCNWZwVHcvK1RYd3JaS2p6WlJQbXM3?= =?utf-8?B?ZzRhTXQxTG85TDdkNkUrNVBqNzlwTWhTZGxuV2N1RFRiQUp4UHRmb1hOYTdq?= =?utf-8?Q?8xtc=3D?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: 6f358dd7-9e7a-4360-bd48-08dbd3a78e5f X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Oct 2023 09:08:00.6982 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: 3d3jmkrNssWLYtOlHlp4QFw6bGQVmrBmhXOUExWx6Lxi56LRFpgajZKG6c1QqfTx X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR12MB4254 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org On 10/20/2023 5:08 PM, Morten Brørup wrote: >> From: Ferruh Yigit [mailto:ferruh.yigit@amd.com] >> Sent: Friday, 20 October 2023 16.47 >> >> static function `rte_mempool_do_generic_get()` returns zero on success, >> not >=0 as its function comment documents. >> >> Since this function called by public API, the comment causes confusion >> on the public API return value. >> >> Fixing the internal function documentation for return value. >> >> Fixes: af75078fece3 ("first public release") >> Cc: stable@dpdk.org >> >> Reported-by: Mahesh Adulla >> Signed-off-by: Ferruh Yigit >> --- > > I agree that this is the current situation, and is relied upon elsewhere in DPDK. > > Reviewed-by: Morten Brørup > > However, the documentation for the mempool driver dequeue function type, rte_mempool_dequeue_t [1], does not specify allowed return values, so some future mempool driver might return a positive value. Please consider updating this too. (Also, the mempool driver enqueue/dequeue functions work on a bulk of objects, not "an object", as their documentation says.) > Hi Morten, Yes, mempool_ops are missing API parameter documentation, although this is not directly related with this patch, I can update 'rte_mempool_dequeue_t' while I am around. > [1]: https://elixir.bootlin.com/dpdk/latest/source/lib/mempool/rte_mempool.h#L476 >