drm/nouveau: sgdma: add comment around suspiscious error handler
authorAlexandre Courbot <acourbot@nvidia.com>
Wed, 10 Dec 2014 19:07:20 +0000 (04:07 +0900)
committerBen Skeggs <bskeggs@redhat.com>
Thu, 22 Jan 2015 02:14:56 +0000 (12:14 +1000)
Common programming sense dictates that resources allocated by a function
are freed by this function should it fails, but this is not the case for
the allocated structure of nouveau_sgdma_create_ttm(). It seems that
n00b contributors attempt to fix this one like bugs flying towards a bug
zapper, so add a comment to hopefully prevent this from happening
anymore.

Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
Signed-off-by: Ben Skeggs <bskeggs@redhat.com>
drivers/gpu/drm/nouveau/nouveau_sgdma.c

index ec76c0b4e452302e72a970a689462fd2e215b92c..23c377a6c761c15dbb2e75e68485d6885e939db4 100644 (file)
@@ -106,6 +106,11 @@ nouveau_sgdma_create_ttm(struct ttm_bo_device *bdev,
                nvbe->ttm.ttm.func = &nv50_sgdma_backend;
 
        if (ttm_dma_tt_init(&nvbe->ttm, bdev, size, page_flags, dummy_read_page))
+               /*
+                * A failing ttm_dma_tt_init() will call ttm_tt_destroy()
+                * and thus our nouveau_sgdma_destroy() hook, so we don't need
+                * to free nvbe here.
+                */
                return NULL;
        return &nvbe->ttm.ttm;
 }